AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::AppStream::ImageBuilder

CfnImageBuilder

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` .

Import

import { CfnImageBuilder } from 'aws-cdk-lib/aws-appstream';

Or use the module namespace:

import * as appstream from 'aws-cdk-lib/aws-appstream';
// appstream.CfnImageBuilder

Properties

Configuration passed to the constructor as CfnImageBuilderProps.

instanceTypeRequired
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.g4dn.xlarge - stream.graphics.g4dn.2xlarge - stream.graphics.g4dn.4xlarge - stream.graphics.g4dn.8xlarge - stream.graphics.g4dn.12xlarge - stream.graphics.g4dn.16xlarge - stream.graphics.g5.xlarge - stream.graphics.g5.2xlarge - stream.graphics.g5.4xlarge - stream.graphics.g5.8xlarge - stream.graphics.g5.16xlarge - stream.graphics.g5.12xlarge - stream.graphics.g5.24xlarge - stream.graphics.g6.xlarge - stream.graphics.g6.2xlarge - stream.graphics.g6.4xlarge - stream.graphics.g6.8xlarge - stream.graphics.g6.16xlarge - stream.graphics.g6.12xlarge - stream.graphics.g6.24xlarge - stream.graphics.gr6.4xlarge - stream.graphics.gr6.8xlarge - stream.graphics.g6f.large - stream.graphics.g6f.xlarge - stream.graphics.g6f.2xlarge - stream.graphics.g6f.4xlarge - stream.graphics.gr6f.4xlarge

nameRequired
string

A unique name for the image builder.

accessEndpointsOptional
IResolvable | IResolvable | AccessEndpointProperty[]

The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.

appstreamAgentVersionOptional
string

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

descriptionOptional
string

The description to display.

displayNameOptional
string

The image builder name to display.

domainJoinInfoOptional
IResolvable | DomainJoinInfoProperty

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

enableDefaultInternetAccessOptional
boolean | IResolvable

Enables or disables default internet access for the image builder.

iamRoleArnOptional
string

The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the 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](https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) in the *Amazon AppStream 2.0 Administration Guide* .

imageArnOptional
string

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

imageNameOptional
string

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

rootVolumeConfigOptional
IResolvable | VolumeConfigProperty
softwaresToInstallOptional
string[]
softwaresToUninstallOptional
string[]
tagsOptional
CfnTag[]

An array of key-value pairs.

vpcConfigOptional
IResolvable | VpcConfigProperty

The VPC configuration for the image builder. You can specify only one subnet.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::AppStream::ImageBuilderView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-appstream
CFN TypeAWS::AppStream::ImageBuilder
Properties16

Related Constructs

Explore This Service

External Links