Skip to content

CreateStackRequest

Source code in docs_src/capo_appstream/types/create_stack_request.py
class CreateStackRequest(TypedDict, closed=True):
    name: NotRequired["capo_appstream.types.name.Name"]
    """<p>The name of the stack.</p>"""
    description: NotRequired["capo_appstream.types.description.Description"]
    """<p>The description to display.</p>"""
    display_name: NotRequired["capo_appstream.types.display_name.DisplayName"]
    """<p>The stack name to display.</p>"""
    storage_connectors: NotRequired[
        "capo_appstream.types.storage_connector_list.StorageConnectorList"
    ]
    """<p>The storage connectors to enable.</p>"""
    redirect_url: NotRequired["capo_appstream.types.redirect_url.RedirectURL"]
    """<p>The URL that users are redirected to after their streaming session ends.</p>"""
    feedback_url: NotRequired["capo_appstream.types.feedback_url.FeedbackURL"]
    """<p>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>"""
    user_settings: NotRequired["capo_appstream.types.user_setting_list.UserSettingList"]
    """<p>The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled. </p>"""
    application_settings: NotRequired[
        "capo_appstream.types.application_settings.ApplicationSettings"
    ]
    """<p>The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.</p>"""
    tags: NotRequired["capo_appstream.types.tags.Tags"]
    r"""<p>The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \ - @</p> <p>For more information about tags, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>"""
    access_endpoints: NotRequired[
        "capo_appstream.types.access_endpoint_list.AccessEndpointList"
    ]
    """<p>The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to WorkSpaces Applications only through the specified endpoints.</p>"""
    embed_host_domains: NotRequired[
        "capo_appstream.types.embed_host_domains.EmbedHostDomains"
    ]
    """<p>The domains where WorkSpaces Applications streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded WorkSpaces Applications streaming sessions. </p>"""
    streaming_experience_settings: NotRequired[
        "capo_appstream.types.streaming_experience_settings.StreamingExperienceSettings"
    ]
    """<p>The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.</p>"""
    content_redirection: NotRequired[
        "capo_appstream.types.content_redirection.ContentRedirection"
    ]
    agent_access_config: NotRequired[
        "capo_appstream.types.agent_access_config.AgentAccessConfig"
    ]
    """<p>The configuration for agent access on the stack. If specified, agent access is enabled for the stack.</p>"""
    storage_connector_authentication: NotRequired[
        "capo_appstream.types.storage_connector_authentication.StorageConnectorAuthentication"
    ]
    """<p>Specifies whether users' cloud storage authentication persists across streaming sessions. When you specify FORCE_REAUTHENTICATION, WorkSpaces Applications removes the stored authentication for the stack's OneDrive and Google Drive connectors when a user's session ends. The user links their cloud storage again on their next session. The default is REUSE_CREDENTIALS.</p>"""

access_endpoints instance-attribute

access_endpoints: NotRequired[AccessEndpointList]

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to WorkSpaces Applications only through the specified endpoints.

agent_access_config instance-attribute

agent_access_config: NotRequired[AgentAccessConfig]

The configuration for agent access on the stack. If specified, agent access is enabled for the stack.

application_settings instance-attribute

application_settings: NotRequired[ApplicationSettings]

The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

content_redirection instance-attribute

content_redirection: NotRequired[ContentRedirection]

description instance-attribute

description: NotRequired[Description]

The description to display.

display_name instance-attribute

display_name: NotRequired[DisplayName]

The stack name to display.

embed_host_domains instance-attribute

embed_host_domains: NotRequired[EmbedHostDomains]

The domains where WorkSpaces Applications streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded WorkSpaces Applications streaming sessions.

feedback_url instance-attribute

feedback_url: NotRequired[FeedbackURL]

The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

name instance-attribute

name: NotRequired[Name]

The name of the stack.

redirect_url instance-attribute

redirect_url: NotRequired[RedirectURL]

The URL that users are redirected to after their streaming session ends.

storage_connector_authentication instance-attribute

storage_connector_authentication: NotRequired[StorageConnectorAuthentication]

Specifies whether users' cloud storage authentication persists across streaming sessions. When you specify FORCE_REAUTHENTICATION, WorkSpaces Applications removes the stored authentication for the stack's OneDrive and Google Drive connectors when a user's session ends. The user links their cloud storage again on their next session. The default is REUSE_CREDENTIALS.

storage_connectors instance-attribute

storage_connectors: NotRequired[StorageConnectorList]

The storage connectors to enable.

streaming_experience_settings instance-attribute

streaming_experience_settings: NotRequired[StreamingExperienceSettings]

The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

tags instance-attribute

tags: NotRequired[Tags]

The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information about tags, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.

user_settings instance-attribute

user_settings: NotRequired[UserSettingList]

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.