interface CfnImageBuilderProps

Language	Type name
.NET	`Amazon.CDK.AWS.AppStream.CfnImageBuilderProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsappstream#CfnImageBuilderProps`
Java	`software.amazon.awscdk.services.appstream.CfnImageBuilderProps`
Python	`aws_cdk.aws_appstream.CfnImageBuilderProps`
TypeScript	`aws-cdk-lib` » `aws_appstream` » `CfnImageBuilderProps`

Properties for defining a CfnImageBuilder.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appstream as appstream } from 'aws-cdk-lib';
const cfnImageBuilderProps: appstream.CfnImageBuilderProps = {
  instanceType: 'instanceType',
  name: 'name',

  // the properties below are optional
  accessEndpoints: [{
    endpointType: 'endpointType',
    vpceId: 'vpceId',
  }],
  appstreamAgentVersion: 'appstreamAgentVersion',
  description: 'description',
  displayName: 'displayName',
  domainJoinInfo: {
    directoryName: 'directoryName',
    organizationalUnitDistinguishedName: 'organizationalUnitDistinguishedName',
  },
  enableDefaultInternetAccess: false,
  iamRoleArn: 'iamRoleArn',
  imageArn: 'imageArn',
  imageName: 'imageName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcConfig: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },
};

Properties

Name	Type	Description
instanceType	`string`	The instance type to use when launching the image builder. The following instance types are available:.
name	`string`	A unique name for the image builder.
accessEndpoints?	`IResolvable` `\|` `IResolvable` `\|` `AccessEndpointProperty[]`	The list of virtual private cloud (VPC) interface endpoint objects.
appstreamAgentVersion?	`string`	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?	`string`	The description to display.
displayName?	`string`	The image builder name to display.
domainJoinInfo?	`IResolvable` `\|` `DomainJoinInfoProperty`	The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
enableDefaultInternetAccess?	`boolean \|` `IResolvable`	Enables or disables default internet access for the image builder.
iamRoleArn?	`string`	The ARN of the IAM role that is applied to the image builder.
imageArn?	`string`	The ARN of the public, private, or shared image to use.
imageName?	`string`	The name of the image used to create the image builder.
tags?	`CfnTag[]`	An array of key-value pairs.
vpcConfig?	`IResolvable` `\|` `VpcConfigProperty`	The VPC configuration for the image builder.

instanceType

Type: string

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

Type: string

A unique name for the image builder.

accessEndpoints?

Type: IResolvable | IResolvable | AccessEndpointProperty[] (optional)

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

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

appstreamAgentVersion?

Type: string (optional)

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?

Type: string (optional)

The description to display.

displayName?

Type: string (optional)

The image builder name to display.

domainJoinInfo?

Type: IResolvable | DomainJoinInfoProperty (optional)

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

enableDefaultInternetAccess?

Type: boolean | IResolvable (optional)

Enables or disables default internet access for the image builder.

iamRoleArn?

Type: string (optional)

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 .

imageArn?

Type: string (optional)

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

imageName?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

An array of key-value pairs.

vpcConfig?

Type: IResolvable | VpcConfigProperty (optional)

The VPC configuration for the image builder.

You can specify only one subnet.