CfnStackPropsMixin

class aws_cdk.cfn_property_mixins.aws_appstream.CfnStackPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::AppStream::Stack resource creates a stack to start streaming applications to Amazon AppStream 2.0 users. A stack consists of an associated fleet, user access policies, and storage configurations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html
CloudformationResource:: AWS::AppStream::Stack
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_appstream as appstream
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_stack_props_mixin = appstream.CfnStackPropsMixin(appstream.CfnStackMixinProps(
    access_endpoints=[appstream.CfnStackPropsMixin.AccessEndpointProperty(
        endpoint_type="endpointType",
        vpce_id="vpceId"
    )],
    agent_access_config=appstream.CfnStackPropsMixin.AgentAccessConfigProperty(
        s3_bucket_arn="s3BucketArn",
        screen_image_format="screenImageFormat",
        screen_resolution="screenResolution",
        screenshots_upload_enabled=False,
        settings=[appstream.CfnStackPropsMixin.AgentAccessSettingProperty(
            agent_action="agentAction",
            permission="permission"
        )],
        user_control_mode="userControlMode"
    ),
    application_settings=appstream.CfnStackPropsMixin.ApplicationSettingsProperty(
        enabled=False,
        settings_group="settingsGroup"
    ),
    attributes_to_delete=["attributesToDelete"],
    content_redirection=appstream.CfnStackPropsMixin.ContentRedirectionProperty(
        host_to_client=appstream.CfnStackPropsMixin.UrlRedirectionConfigProperty(
            allowed_urls=["allowedUrls"],
            denied_urls=["deniedUrls"],
            enabled=False
        )
    ),
    delete_storage_connectors=False,
    description="description",
    display_name="displayName",
    embed_host_domains=["embedHostDomains"],
    feedback_url="feedbackUrl",
    name="name",
    redirect_url="redirectUrl",
    storage_connectors=[appstream.CfnStackPropsMixin.StorageConnectorProperty(
        connector_type="connectorType",
        domains=["domains"],
        resource_identifier="resourceIdentifier"
    )],
    streaming_experience_settings=appstream.CfnStackPropsMixin.StreamingExperienceSettingsProperty(
        preferred_protocol="preferredProtocol"
    ),
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    user_settings=[appstream.CfnStackPropsMixin.UserSettingProperty(
        action="action",
        maximum_length=123,
        permission="permission"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::AppStream::Stack.

Parameters:

props (Union[CfnStackMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['accessEndpoints', 'agentAccessConfig', 'applicationSettings', 'attributesToDelete', 'contentRedirection', 'deleteStorageConnectors', 'description', 'displayName', 'embedHostDomains', 'feedbackUrl', 'name', 'redirectUrl', 'storageConnectors', 'streamingExperienceSettings', 'tags', 'userSettings']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

AccessEndpointProperty

class CfnStackPropsMixin.AccessEndpointProperty(*, endpoint_type=None, vpce_id=None)

Bases: object

Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and WorkSpaces Applications.

When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.

Parameters:

endpoint_type (Optional[str]) – The type of interface endpoint.
vpce_id (Optional[str]) – The identifier (ID) of the VPC in which the interface endpoint is used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-accessendpoint.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_appstream as appstream

access_endpoint_property = appstream.CfnStackPropsMixin.AccessEndpointProperty(
    endpoint_type="endpointType",
    vpce_id="vpceId"
)

Attributes

endpoint_type

The type of interface endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-accessendpoint.html#cfn-appstream-stack-accessendpoint-endpointtype

vpce_id

The identifier (ID) of the VPC in which the interface endpoint is used.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-accessendpoint.html#cfn-appstream-stack-accessendpoint-vpceid

AgentAccessConfigProperty

class CfnStackPropsMixin.AgentAccessConfigProperty(*, s3_bucket_arn=None, screen_image_format=None, screen_resolution=None, screenshots_upload_enabled=None, settings=None, user_control_mode=None)

Bases: object

The configuration for agent access on a stack.

Agent access enables AI agents to interact with desktop applications during streaming sessions.

Parameters:

s3_bucket_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored. Required when ScreenshotsUploadEnabled is true.
screen_image_format (Optional[str]) – The image format for agent screen captures.
screen_resolution (Optional[str]) – The screen resolution for the agent streaming environment.
screenshots_upload_enabled (Union[bool, IResolvable, None]) – Indicates whether screenshot uploads to Amazon S3 are enabled for agent sessions.
settings (Union[IResolvable, Sequence[Union[IResolvable, AgentAccessSettingProperty, Dict[str, Any]]], None]) – The list of agent access settings that define permissions for each agent action. You must specify at least one setting.
user_control_mode (Optional[str]) – The user control mode for agent sessions. This setting determines how users can interact with agent sessions. Valid values are VIEW_ONLY, VIEW_STOP, and DISABLED.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccessconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_appstream as appstream

agent_access_config_property = appstream.CfnStackPropsMixin.AgentAccessConfigProperty(
    s3_bucket_arn="s3BucketArn",
    screen_image_format="screenImageFormat",
    screen_resolution="screenResolution",
    screenshots_upload_enabled=False,
    settings=[appstream.CfnStackPropsMixin.AgentAccessSettingProperty(
        agent_action="agentAction",
        permission="permission"
    )],
    user_control_mode="userControlMode"
)

Attributes

s3_bucket_arn

The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored.

Required when ScreenshotsUploadEnabled is true.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccessconfig.html#cfn-appstream-stack-agentaccessconfig-s3bucketarn

screen_image_format

The image format for agent screen captures.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccessconfig.html#cfn-appstream-stack-agentaccessconfig-screenimageformat

screen_resolution

The screen resolution for the agent streaming environment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccessconfig.html#cfn-appstream-stack-agentaccessconfig-screenresolution

screenshots_upload_enabled

Indicates whether screenshot uploads to Amazon S3 are enabled for agent sessions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccessconfig.html#cfn-appstream-stack-agentaccessconfig-screenshotsuploadenabled

settings

The list of agent access settings that define permissions for each agent action.

You must specify at least one setting.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccessconfig.html#cfn-appstream-stack-agentaccessconfig-settings

user_control_mode

The user control mode for agent sessions.

This setting determines how users can interact with agent sessions. Valid values are VIEW_ONLY, VIEW_STOP, and DISABLED.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccessconfig.html#cfn-appstream-stack-agentaccessconfig-usercontrolmode

AgentAccessSettingProperty

class CfnStackPropsMixin.AgentAccessSettingProperty(*, agent_action=None, permission=None)

Bases: object

A permission setting for an agent action.

Each setting specifies an agent action and whether it is enabled or disabled.

Parameters:

agent_action (Optional[str]) – The agent action to configure. Valid values are COMPUTER_VISION, COMPUTER_INPUT, and FORWARD_MCP_TOOLS. COMPUTER_VISION allows agents to take screenshots of the desktop. COMPUTER_INPUT allows agents to click, type, and scroll on the desktop and requires COMPUTER_VISION to also be enabled. FORWARD_MCP_TOOLS allows agents to interact with applications and the desktop operating system through direct MCP calls rather than using computer use tools. Forwards MCP tools configured on the WorkSpaces application session to the agent.
permission (Optional[str]) – Whether the agent action is enabled or disabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccesssetting.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_appstream as appstream

agent_access_setting_property = appstream.CfnStackPropsMixin.AgentAccessSettingProperty(
    agent_action="agentAction",
    permission="permission"
)

Attributes

agent_action

The agent action to configure.

Valid values are COMPUTER_VISION, COMPUTER_INPUT, and FORWARD_MCP_TOOLS. COMPUTER_VISION allows agents to take screenshots of the desktop. COMPUTER_INPUT allows agents to click, type, and scroll on the desktop and requires COMPUTER_VISION to also be enabled. FORWARD_MCP_TOOLS allows agents to interact with applications and the desktop operating system through direct MCP calls rather than using computer use tools. Forwards MCP tools configured on the WorkSpaces application session to the agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccesssetting.html#cfn-appstream-stack-agentaccesssetting-agentaction

permission

Whether the agent action is enabled or disabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-agentaccesssetting.html#cfn-appstream-stack-agentaccesssetting-permission

ApplicationSettingsProperty

class CfnStackPropsMixin.ApplicationSettingsProperty(*, enabled=None, settings_group=None)

Bases: object

The persistent application settings for users of a stack.

Parameters:

enabled (Union[bool, IResolvable, None]) – Enables or disables persistent application settings for users during their streaming sessions.
settings_group (Optional[str]) – The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-applicationsettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_appstream as appstream

application_settings_property = appstream.CfnStackPropsMixin.ApplicationSettingsProperty(
    enabled=False,
    settings_group="settingsGroup"
)

Attributes

enabled

Enables or disables persistent application settings for users during their streaming sessions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-applicationsettings.html#cfn-appstream-stack-applicationsettings-enabled

settings_group

The path prefix for the S3 bucket where users’ persistent application settings are stored.

You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-applicationsettings.html#cfn-appstream-stack-applicationsettings-settingsgroup

ContentRedirectionProperty

class CfnStackPropsMixin.ContentRedirectionProperty(*, host_to_client=None)

Bases: object

The content redirection settings for the stack.

Parameters:: host_to_client (Union[IResolvable, UrlRedirectionConfigProperty, Dict[str, Any], None]) – The configuration for URL redirection.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-contentredirection.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_appstream as appstream

content_redirection_property = appstream.CfnStackPropsMixin.ContentRedirectionProperty(
    host_to_client=appstream.CfnStackPropsMixin.UrlRedirectionConfigProperty(
        allowed_urls=["allowedUrls"],
        denied_urls=["deniedUrls"],
        enabled=False
    )
)

Attributes

host_to_client

The configuration for URL redirection.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-contentredirection.html#cfn-appstream-stack-contentredirection-hosttoclient

StorageConnectorProperty

class CfnStackPropsMixin.StorageConnectorProperty(*, connector_type=None, domains=None, resource_identifier=None)

Bases: object

A connector that enables persistent storage for users.

Parameters:

connector_type (Optional[str]) – The type of storage connector.
domains (Optional[Sequence[str]]) – The names of the domains for the account.
resource_identifier (Optional[str]) – The ARN of the storage connector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-storageconnector.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_appstream as appstream

storage_connector_property = appstream.CfnStackPropsMixin.StorageConnectorProperty(
    connector_type="connectorType",
    domains=["domains"],
    resource_identifier="resourceIdentifier"
)

Attributes

connector_type

The type of storage connector.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-storageconnector.html#cfn-appstream-stack-storageconnector-connectortype

domains

The names of the domains for the account.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-storageconnector.html#cfn-appstream-stack-storageconnector-domains

resource_identifier

The ARN of the storage connector.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-storageconnector.html#cfn-appstream-stack-storageconnector-resourceidentifier

StreamingExperienceSettingsProperty

class CfnStackPropsMixin.StreamingExperienceSettingsProperty(*, preferred_protocol=None)

Bases: object

The streaming protocol that you want your stack to prefer.

This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

Parameters:: preferred_protocol (Optional[str]) – The preferred protocol that you want to use while streaming your application.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-streamingexperiencesettings.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_appstream as appstream

streaming_experience_settings_property = appstream.CfnStackPropsMixin.StreamingExperienceSettingsProperty(
    preferred_protocol="preferredProtocol"
)

Attributes

preferred_protocol

The preferred protocol that you want to use while streaming your application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-streamingexperiencesettings.html#cfn-appstream-stack-streamingexperiencesettings-preferredprotocol

UrlRedirectionConfigProperty

class CfnStackPropsMixin.UrlRedirectionConfigProperty(*, allowed_urls=None, denied_urls=None, enabled=None)

Bases: object

The configuration for URL redirection.

Parameters:

allowed_urls (Optional[Sequence[str]]) – The URLs that are allowed for redirection.
denied_urls (Optional[Sequence[str]]) – The URLs that are denied for redirection.
enabled (Union[bool, IResolvable, None]) – Specifies whether URL redirection is enabled or disabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-urlredirectionconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_appstream as appstream

url_redirection_config_property = appstream.CfnStackPropsMixin.UrlRedirectionConfigProperty(
    allowed_urls=["allowedUrls"],
    denied_urls=["deniedUrls"],
    enabled=False
)

Attributes

allowed_urls

The URLs that are allowed for redirection.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-urlredirectionconfig.html#cfn-appstream-stack-urlredirectionconfig-allowedurls

denied_urls

The URLs that are denied for redirection.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-urlredirectionconfig.html#cfn-appstream-stack-urlredirectionconfig-deniedurls

enabled

Specifies whether URL redirection is enabled or disabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-urlredirectionconfig.html#cfn-appstream-stack-urlredirectionconfig-enabled

UserSettingProperty

class CfnStackPropsMixin.UserSettingProperty(*, action=None, maximum_length=None, permission=None)

Bases: object

Specifies an action and whether the action is enabled or disabled for users during their streaming sessions.

Parameters:

action (Optional[str]) – The action that is enabled or disabled.
maximum_length (Union[int, float, None]) – Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session. This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions. This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED . This can’t be specified when the permission is DISABLED . The value can be between 1 and 20,971,520 (20 MB).
permission (Optional[str]) – Indicates whether the action is enabled or disabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-usersetting.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_appstream as appstream

user_setting_property = appstream.CfnStackPropsMixin.UserSettingProperty(
    action="action",
    maximum_length=123,
    permission="permission"
)

Attributes

action

The action that is enabled or disabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-usersetting.html#cfn-appstream-stack-usersetting-action

maximum_length

Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.

This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.

This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED . This can’t be specified when the permission is DISABLED .

The value can be between 1 and 20,971,520 (20 MB).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-usersetting.html#cfn-appstream-stack-usersetting-maximumlength

permission

Indicates whether the action is enabled or disabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-stack-usersetting.html#cfn-appstream-stack-usersetting-permission