CfnAppBlockProps

class aws_cdk.aws_appstream.CfnAppBlockProps(*, name, setup_script_details, source_s3_location, description=None, display_name=None, tags=None)

Bases: object

Properties for defining a CfnAppBlock.

Parameters
  • name (str) – The name of the app block. Pattern : ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

  • setup_script_details (Union[ScriptDetailsProperty, IResolvable]) – The setup script details of the app block.

  • source_s3_location (Union[IResolvable, S3LocationProperty]) – The source S3 location of the app block.

  • description (Optional[str]) – The description of the app block.

  • display_name (Optional[str]) – The display name of the app block.

  • tags (Optional[Sequence[CfnTag]]) – The tags of the app block.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.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_app_block_props = appstream.CfnAppBlockProps(
    name="name",
    setup_script_details=appstream.CfnAppBlock.ScriptDetailsProperty(
        executable_path="executablePath",
        script_s3_location=appstream.CfnAppBlock.S3LocationProperty(
            s3_bucket="s3Bucket",
            s3_key="s3Key"
        ),
        timeout_in_seconds=123,

        # the properties below are optional
        executable_parameters="executableParameters"
    ),
    source_s3_location=appstream.CfnAppBlock.S3LocationProperty(
        s3_bucket="s3Bucket",
        s3_key="s3Key"
    ),

    # the properties below are optional
    description="description",
    display_name="displayName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

The description of the app block.

Link

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

Return type

Optional[str]

display_name

The display name of the app block.

Link

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

Return type

Optional[str]

name

The name of the app block.

Pattern : ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Link

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

Return type

str

setup_script_details

The setup script details of the app block.

Link

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

Return type

Union[ScriptDetailsProperty, IResolvable]

source_s3_location

The source S3 location of the app block.

Link

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

Return type

Union[IResolvable, S3LocationProperty]

tags

The tags of the app block.

Link

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

Return type

Optional[List[CfnTag]]