CfnStack
- class aws_cdk.aws_appstream.CfnStack(scope, id, *, 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:
CfnResourceA CloudFormation
AWS::AppStream::Stack.The
AWS::AppStream::Stackresource 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.- CloudformationResource:
AWS::AppStream::Stack
- 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 = appstream.CfnStack(self, "MyCfnStack", 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" )] )
Create a new
AWS::AppStream::Stack.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
access_endpoints (
Union[IResolvable,Sequence[Union[IResolvable,AccessEndpointProperty,Dict[str,Any]]],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,Dict[str,Any],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,Dict[str,Any]]],None]) – The storage connectors to enable.streaming_experience_settings (
Union[IResolvable,StreamingExperienceSettingsProperty,Dict[str,Any],None]) – 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.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – An array of key-value pairs.user_settings (
Union[IResolvable,Sequence[Union[IResolvable,UserSettingProperty,Dict[str,Any]]],None]) – The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str) –value (
Any) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).- Parameters:
policy (
Optional[RemovalPolicy]) –apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::AppStream::Stack'
- 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.
- 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.
- attributes_to_delete
The stack attributes to delete.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- delete_storage_connectors
This parameter has been deprecated..
Deletes the storage connectors currently enabled for the stack.
- description
The description to display.
- display_name
The stack name to display.
- 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.
- 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.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of the stack.
- node
The construct tree node associated with this construct.
- redirect_url
The URL that users are redirected to after their streaming session ends.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- storage_connectors
The storage connectors to enable.
- streaming_experience_settings
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.
- tags
An array of key-value pairs.
- user_settings
The actions that are enabled or disabled for users during their streaming sessions.
By default, these actions are enabled.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any) –- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any) –- Return type:
bool
AccessEndpointProperty
- class CfnStack.AccessEndpointProperty(*, endpoint_type, vpce_id)
Bases:
objectDescribes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 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 (
str) – The type of interface endpoint.vpce_id (
str) – The identifier (ID) of the VPC in which the interface endpoint is used.
- Link:
- 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 access_endpoint_property = appstream.CfnStack.AccessEndpointProperty( endpoint_type="endpointType", vpce_id="vpceId" )
Attributes
- endpoint_type
The type of interface endpoint.
- vpce_id
The identifier (ID) of the VPC in which the interface endpoint is used.
ApplicationSettingsProperty
- class CfnStack.ApplicationSettingsProperty(*, enabled, settings_group=None)
Bases:
objectThe persistent application settings for users of a stack.
- Parameters:
enabled (
Union[bool,IResolvable]) – 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.
- Link:
- 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 application_settings_property = appstream.CfnStack.ApplicationSettingsProperty( enabled=False, # the properties below are optional settings_group="settingsGroup" )
Attributes
- enabled
Enables or disables persistent application settings for users during their streaming sessions.
- 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.
StorageConnectorProperty
- class CfnStack.StorageConnectorProperty(*, connector_type, domains=None, resource_identifier=None)
Bases:
objectA connector that enables persistent storage for users.
- Parameters:
connector_type (
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.
- Link:
- 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 storage_connector_property = appstream.CfnStack.StorageConnectorProperty( connector_type="connectorType", # the properties below are optional domains=["domains"], resource_identifier="resourceIdentifier" )
Attributes
- connector_type
The type of storage connector.
- domains
The names of the domains for the account.
- resource_identifier
The ARN of the storage connector.
StreamingExperienceSettingsProperty
- class CfnStack.StreamingExperienceSettingsProperty(*, preferred_protocol=None)
Bases:
objectThe 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.- Link:
- 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 streaming_experience_settings_property = appstream.CfnStack.StreamingExperienceSettingsProperty( preferred_protocol="preferredProtocol" )
Attributes
- preferred_protocol
The preferred protocol that you want to use while streaming your application.
UserSettingProperty
- class CfnStack.UserSettingProperty(*, action, permission)
Bases:
objectSpecifies an action and whether the action is enabled or disabled for users during their streaming sessions.
- Parameters:
action (
str) – The action that is enabled or disabled.permission (
str) – Indicates whether the action is enabled or disabled.
- Link:
- 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 user_setting_property = appstream.CfnStack.UserSettingProperty( action="action", permission="permission" )
Attributes
- action
The action that is enabled or disabled.
- permission
Indicates whether the action is enabled or disabled.