CfnImageBuilderPropsMixin

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

Bases: Mixin

The AWS::AppStream::ImageBuilder resource creates an image builder for Amazon AppStream 2.0. An image builder is a virtual machine that is used to create an image.

The initial state of the image builder is PENDING . When it is ready, the state is RUNNING .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html
CloudformationResource:: AWS::AppStream::ImageBuilder
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_image_builder_props_mixin = appstream_mixins.CfnImageBuilderPropsMixin(appstream_mixins.CfnImageBuilderMixinProps(
    access_endpoints=[appstream_mixins.CfnImageBuilderPropsMixin.AccessEndpointProperty(
        endpoint_type="endpointType",
        vpce_id="vpceId"
    )],
    appstream_agent_version="appstreamAgentVersion",
    description="description",
    display_name="displayName",
    domain_join_info=appstream_mixins.CfnImageBuilderPropsMixin.DomainJoinInfoProperty(
        directory_name="directoryName",
        organizational_unit_distinguished_name="organizationalUnitDistinguishedName"
    ),
    enable_default_internet_access=False,
    iam_role_arn="iamRoleArn",
    image_arn="imageArn",
    image_name="imageName",
    instance_type="instanceType",
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_config=appstream_mixins.CfnImageBuilderPropsMixin.VpcConfigProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnImageBuilderMixinProps, 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 = ['accessEndpoints', 'appstreamAgentVersion', 'description', 'displayName', 'domainJoinInfo', 'enableDefaultInternetAccess', 'iamRoleArn', 'imageArn', 'imageName', 'instanceType', 'name', 'tags', 'vpcConfig']

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

AccessEndpointProperty

class CfnImageBuilderPropsMixin.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-imagebuilder-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.mixins_preview.aws_appstream import mixins as appstream_mixins

access_endpoint_property = appstream_mixins.CfnImageBuilderPropsMixin.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-imagebuilder-accessendpoint.html#cfn-appstream-imagebuilder-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-imagebuilder-accessendpoint.html#cfn-appstream-imagebuilder-accessendpoint-vpceid

DomainJoinInfoProperty

class CfnImageBuilderPropsMixin.DomainJoinInfoProperty(*, directory_name=None, organizational_unit_distinguished_name=None)

Bases: object

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

Parameters:

directory_name (Optional[str]) – The fully qualified name of the directory (for example, corp.example.com).
organizational_unit_distinguished_name (Optional[str]) – The distinguished name of the organizational unit for computer accounts.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-imagebuilder-domainjoininfo.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

domain_join_info_property = appstream_mixins.CfnImageBuilderPropsMixin.DomainJoinInfoProperty(
    directory_name="directoryName",
    organizational_unit_distinguished_name="organizationalUnitDistinguishedName"
)

Attributes

directory_name

The fully qualified name of the directory (for example, corp.example.com).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-imagebuilder-domainjoininfo.html#cfn-appstream-imagebuilder-domainjoininfo-directoryname

organizational_unit_distinguished_name

The distinguished name of the organizational unit for computer accounts.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-imagebuilder-domainjoininfo.html#cfn-appstream-imagebuilder-domainjoininfo-organizationalunitdistinguishedname

VpcConfigProperty

class CfnImageBuilderPropsMixin.VpcConfigProperty(*, security_group_ids=None, subnet_ids=None)

Bases: object

The VPC configuration for the image builder.

Parameters:

security_group_ids (Optional[Sequence[str]]) – The identifiers of the security groups for the image builder.
subnet_ids (Optional[Sequence[str]]) – The identifier of the subnet to which a network interface is attached from the image builder instance. An image builder instance can use one subnet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-imagebuilder-vpcconfig.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

vpc_config_property = appstream_mixins.CfnImageBuilderPropsMixin.VpcConfigProperty(
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"]
)

Attributes

security_group_ids

The identifiers of the security groups for the image builder.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-imagebuilder-vpcconfig.html#cfn-appstream-imagebuilder-vpcconfig-securitygroupids

subnet_ids

The identifier of the subnet to which a network interface is attached from the image builder instance.

An image builder instance can use one subnet.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-imagebuilder-vpcconfig.html#cfn-appstream-imagebuilder-vpcconfig-subnetids