CfnImageBuilderProps

class aws_cdk.aws_appstream.CfnImageBuilderProps(*, instance_type, name, access_endpoints=None, appstream_agent_version=None, description=None, display_name=None, domain_join_info=None, enable_default_internet_access=None, iam_role_arn=None, image_arn=None, image_name=None, tags=None, vpc_config=None)

Bases: object

Properties for defining a CfnImageBuilder.

Parameters
  • instance_type (str) – The instance type to use when launching the image builder. The following instance types are available:. - stream.standard.small - stream.standard.medium - stream.standard.large - stream.compute.large - stream.compute.xlarge - stream.compute.2xlarge - stream.compute.4xlarge - stream.compute.8xlarge - stream.memory.large - stream.memory.xlarge - stream.memory.2xlarge - stream.memory.4xlarge - stream.memory.8xlarge - stream.memory.z1d.large - stream.memory.z1d.xlarge - stream.memory.z1d.2xlarge - stream.memory.z1d.3xlarge - stream.memory.z1d.6xlarge - stream.memory.z1d.12xlarge - stream.graphics-design.large - stream.graphics-design.xlarge - stream.graphics-design.2xlarge - stream.graphics-design.4xlarge - stream.graphics-desktop.2xlarge - stream.graphics.g4dn.xlarge - stream.graphics.g4dn.2xlarge - stream.graphics.g4dn.4xlarge - stream.graphics.g4dn.8xlarge - stream.graphics.g4dn.12xlarge - stream.graphics.g4dn.16xlarge - stream.graphics-pro.4xlarge - stream.graphics-pro.8xlarge - stream.graphics-pro.16xlarge

  • name (str) – A unique name for the image builder.

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

  • appstream_agent_version (Optional[str]) – The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

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

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

  • domain_join_info (Union[IResolvable, DomainJoinInfoProperty, None]) – The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

  • enable_default_internet_access (Union[bool, IResolvable, None]) – Enables or disables default internet access for the image builder.

  • iam_role_arn (Optional[str]) – The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance. For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

  • image_arn (Optional[str]) – The ARN of the public, private, or shared image to use.

  • image_name (Optional[str]) – The name of the image used to create the image builder.

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

  • vpc_config (Union[IResolvable, VpcConfigProperty, None]) – The VPC configuration for the image builder. You can specify only one subnet.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.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_image_builder_props = appstream.CfnImageBuilderProps(
    instance_type="instanceType",
    name="name",

    # the properties below are optional
    access_endpoints=[appstream.CfnImageBuilder.AccessEndpointProperty(
        endpoint_type="endpointType",
        vpce_id="vpceId"
    )],
    appstream_agent_version="appstreamAgentVersion",
    description="description",
    display_name="displayName",
    domain_join_info=appstream.CfnImageBuilder.DomainJoinInfoProperty(
        directory_name="directoryName",
        organizational_unit_distinguished_name="organizationalUnitDistinguishedName"
    ),
    enable_default_internet_access=False,
    iam_role_arn="iamRoleArn",
    image_arn="imageArn",
    image_name="imageName",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_config=appstream.CfnImageBuilder.VpcConfigProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
)

Attributes

access_endpoints

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

Administrators can connect to the image builder only through the specified endpoints.

Link

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

Return type

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

appstream_agent_version

The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

Link

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

Return type

Optional[str]

description

The description to display.

Link

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

Return type

Optional[str]

display_name

The image builder name to display.

Link

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

Return type

Optional[str]

domain_join_info

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

Link

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

Return type

Union[IResolvable, DomainJoinInfoProperty, None]

enable_default_internet_access

Enables or disables default internet access for the image builder.

Link

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

Return type

Union[bool, IResolvable, None]

iam_role_arn

The ARN of the IAM role that is applied to the image builder.

To assume a role, the image builder calls the AWS Security Token Service AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

Link

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

Return type

Optional[str]

image_arn

The ARN of the public, private, or shared image to use.

Link

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

Return type

Optional[str]

image_name

The name of the image used to create the image builder.

Link

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

Return type

Optional[str]

instance_type

.

  • stream.standard.small

  • stream.standard.medium

  • stream.standard.large

  • stream.compute.large

  • stream.compute.xlarge

  • stream.compute.2xlarge

  • stream.compute.4xlarge

  • stream.compute.8xlarge

  • stream.memory.large

  • stream.memory.xlarge

  • stream.memory.2xlarge

  • stream.memory.4xlarge

  • stream.memory.8xlarge

  • stream.memory.z1d.large

  • stream.memory.z1d.xlarge

  • stream.memory.z1d.2xlarge

  • stream.memory.z1d.3xlarge

  • stream.memory.z1d.6xlarge

  • stream.memory.z1d.12xlarge

  • stream.graphics-design.large

  • stream.graphics-design.xlarge

  • stream.graphics-design.2xlarge

  • stream.graphics-design.4xlarge

  • stream.graphics-desktop.2xlarge

  • stream.graphics.g4dn.xlarge

  • stream.graphics.g4dn.2xlarge

  • stream.graphics.g4dn.4xlarge

  • stream.graphics.g4dn.8xlarge

  • stream.graphics.g4dn.12xlarge

  • stream.graphics.g4dn.16xlarge

  • stream.graphics-pro.4xlarge

  • stream.graphics-pro.8xlarge

  • stream.graphics-pro.16xlarge

Link

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

Type

The instance type to use when launching the image builder. The following instance types are available

Return type

str

name

A unique name for the image builder.

Link

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

Return type

str

tags

An array of key-value pairs.

Link

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

Return type

Optional[List[CfnTag]]

vpc_config

The VPC configuration for the image builder.

You can specify only one subnet.

Link

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

Return type

Union[IResolvable, VpcConfigProperty, None]