CfnStackProps

class aws_cdk.aws_appstream.CfnStackProps(*, access_endpoints=None, application_settings=None, attributes_to_delete=None, delete_storage_connectors=None, description=None, display_name=None, embed_host_domains=None, feedback_url=None, name=None, redirect_url=None, storage_connectors=None, streaming_experience_settings=None, tags=None, user_settings=None)

Bases: object

Properties for defining a CfnStack.

Parameters
  • access_endpoints (Union[IResolvable, Sequence[Union[IResolvable, AccessEndpointProperty]], None]) – The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

  • application_settings (Union[IResolvable, ApplicationSettingsProperty, None]) – The persistent application settings for users of the 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.

  • attributes_to_delete (Optional[Sequence[str]]) – The stack attributes to delete.

  • delete_storage_connectors (Union[bool, IResolvable, None]) – This parameter has been deprecated.. Deletes the storage connectors currently enabled for the stack.

  • description (Optional[str]) – The description to display.

  • display_name (Optional[str]) – The stack name to display.

  • embed_host_domains (Optional[Sequence[str]]) – The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

  • feedback_url (Optional[str]) – 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 (Optional[str]) – The name of the stack.

  • redirect_url (Optional[str]) – The URL that users are redirected to after their streaming session ends.

  • storage_connectors (Union[IResolvable, Sequence[Union[IResolvable, StorageConnectorProperty]], None]) – The storage connectors to enable.

  • streaming_experience_settings (Union[IResolvable, StreamingExperienceSettingsProperty, None]) – AWS::AppStream::Stack.StreamingExperienceSettings.

  • tags (Optional[Sequence[CfnTag]]) – An array of key-value pairs.

  • user_settings (Union[IResolvable, Sequence[Union[IResolvable, UserSettingProperty]], None]) – The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

Link

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

ExampleMetadata

fixture=_generated

Example:

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

cfn_stack_props = appstream.CfnStackProps(
    access_endpoints=[appstream.CfnStack.AccessEndpointProperty(
        endpoint_type="endpointType",
        vpce_id="vpceId"
    )],
    application_settings=appstream.CfnStack.ApplicationSettingsProperty(
        enabled=False,

        # the properties below are optional
        settings_group="settingsGroup"
    ),
    attributes_to_delete=["attributesToDelete"],
    delete_storage_connectors=False,
    description="description",
    display_name="displayName",
    embed_host_domains=["embedHostDomains"],
    feedback_url="feedbackUrl",
    name="name",
    redirect_url="redirectUrl",
    storage_connectors=[appstream.CfnStack.StorageConnectorProperty(
        connector_type="connectorType",

        # the properties below are optional
        domains=["domains"],
        resource_identifier="resourceIdentifier"
    )],
    streaming_experience_settings=appstream.CfnStack.StreamingExperienceSettingsProperty(
        preferred_protocol="preferredProtocol"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    user_settings=[appstream.CfnStack.UserSettingProperty(
        action="action",
        permission="permission"
    )]
)

Attributes

access_endpoints

The list of virtual private cloud (VPC) interface endpoint objects.

Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-accessendpoints

Return type

Union[IResolvable, List[Union[IResolvable, AccessEndpointProperty]], None]

application_settings

The persistent application settings for users of the 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.

Link

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

Return type

Union[IResolvable, ApplicationSettingsProperty, None]

attributes_to_delete

The stack attributes to delete.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-attributestodelete

Return type

Optional[List[str]]

delete_storage_connectors

This parameter has been deprecated..

Deletes the storage connectors currently enabled for the stack.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-deletestorageconnectors

Return type

Union[bool, IResolvable, None]

description

The description to display.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-description

Return type

Optional[str]

display_name

The stack name to display.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-displayname

Return type

Optional[str]

embed_host_domains

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-embedhostdomains

Return type

Optional[List[str]]

feedback_url

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-feedbackurl

Return type

Optional[str]

name

The name of the stack.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-name

Return type

Optional[str]

redirect_url

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-redirecturl

Return type

Optional[str]

storage_connectors

The storage connectors to enable.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-storageconnectors

Return type

Union[IResolvable, List[Union[IResolvable, StorageConnectorProperty]], None]

streaming_experience_settings

AWS::AppStream::Stack.StreamingExperienceSettings.

Link

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

Return type

Union[IResolvable, StreamingExperienceSettingsProperty, None]

tags

An array of key-value pairs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-tags

Return type

Optional[List[CfnTag]]

user_settings

The actions that are enabled or disabled for users during their streaming sessions.

By default, these actions are enabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-stack.html#cfn-appstream-stack-usersettings

Return type

Union[IResolvable, List[Union[IResolvable, UserSettingProperty]], None]