CfnAppBlockPropsMixin

class aws_cdk.mixins_preview.aws_appstream.mixins.CfnAppBlockPropsMixin(props, *, strategy=None)

Bases: Mixin

This resource creates an app block.

App blocks store details about the virtual hard disk that contains the files for the application in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. App blocks are only supported for Elastic fleets.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html
CloudformationResource:: AWS::AppStream::AppBlock
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_appstream import mixins as appstream_mixins

cfn_app_block_props_mixin = appstream_mixins.CfnAppBlockPropsMixin(appstream_mixins.CfnAppBlockMixinProps(
    description="description",
    display_name="displayName",
    name="name",
    packaging_type="packagingType",
    post_setup_script_details=appstream_mixins.CfnAppBlockPropsMixin.ScriptDetailsProperty(
        executable_parameters="executableParameters",
        executable_path="executablePath",
        script_s3_location=appstream_mixins.CfnAppBlockPropsMixin.S3LocationProperty(
            s3_bucket="s3Bucket",
            s3_key="s3Key"
        ),
        timeout_in_seconds=123
    ),
    setup_script_details=appstream_mixins.CfnAppBlockPropsMixin.ScriptDetailsProperty(
        executable_parameters="executableParameters",
        executable_path="executablePath",
        script_s3_location=appstream_mixins.CfnAppBlockPropsMixin.S3LocationProperty(
            s3_bucket="s3Bucket",
            s3_key="s3Key"
        ),
        timeout_in_seconds=123
    ),
    source_s3_location=appstream_mixins.CfnAppBlockPropsMixin.S3LocationProperty(
        s3_bucket="s3Bucket",
        s3_key="s3Key"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['description', 'displayName', 'name', 'packagingType', 'postSetupScriptDetails', 'setupScriptDetails', 'sourceS3Location', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) 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.
Stability:: experimental

S3LocationProperty

class CfnAppBlockPropsMixin.S3LocationProperty(*, s3_bucket=None, s3_key=None)

Bases: object

The S3 location of the app block.

Parameters:

s3_bucket (Optional[str]) – The S3 bucket of the app block.
s3_key (Optional[str]) – The S3 key of the S3 object of the virtual hard disk. This is required when it’s used by SetupScriptDetails and PostSetupScriptDetails .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-s3location.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.mixins_preview.aws_appstream import mixins as appstream_mixins

s3_location_property = appstream_mixins.CfnAppBlockPropsMixin.S3LocationProperty(
    s3_bucket="s3Bucket",
    s3_key="s3Key"
)

Attributes

s3_bucket

The S3 bucket of the app block.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-s3location.html#cfn-appstream-appblock-s3location-s3bucket

s3_key

The S3 key of the S3 object of the virtual hard disk.

This is required when it’s used by SetupScriptDetails and PostSetupScriptDetails .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-s3location.html#cfn-appstream-appblock-s3location-s3key

ScriptDetailsProperty

class CfnAppBlockPropsMixin.ScriptDetailsProperty(*, executable_parameters=None, executable_path=None, script_s3_location=None, timeout_in_seconds=None)

Bases: object

The details of the script.

Parameters:

executable_parameters (Optional[str]) – The parameters used in the run path for the script.
executable_path (Optional[str]) – The run path for the script.
script_s3_location (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – The S3 object location of the script.
timeout_in_seconds (Union[int, float, None]) – The run timeout, in seconds, for the script.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-scriptdetails.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.mixins_preview.aws_appstream import mixins as appstream_mixins

script_details_property = appstream_mixins.CfnAppBlockPropsMixin.ScriptDetailsProperty(
    executable_parameters="executableParameters",
    executable_path="executablePath",
    script_s3_location=appstream_mixins.CfnAppBlockPropsMixin.S3LocationProperty(
        s3_bucket="s3Bucket",
        s3_key="s3Key"
    ),
    timeout_in_seconds=123
)

Attributes

executable_parameters

The parameters used in the run path for the script.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-scriptdetails.html#cfn-appstream-appblock-scriptdetails-executableparameters

executable_path

The run path for the script.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-scriptdetails.html#cfn-appstream-appblock-scriptdetails-executablepath

script_s3_location

The S3 object location of the script.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-scriptdetails.html#cfn-appstream-appblock-scriptdetails-scripts3location

timeout_in_seconds

The run timeout, in seconds, for the script.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-scriptdetails.html#cfn-appstream-appblock-scriptdetails-timeoutinseconds