AWS::AppStream::ImageBuilder

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::AppStream::ImageBuilder",
  "Properties" : {
      "AccessEndpoints" : [ AccessEndpoint, ... ],
      "AppstreamAgentVersion" : String,
      "Description" : String,
      "DisplayName" : String,
      "DomainJoinInfo" : DomainJoinInfo,
      "EnableDefaultInternetAccess" : Boolean,
      "IamRoleArn" : String,
      "ImageArn" : String,
      "ImageName" : String,
      "InstanceType" : String,
      "Name" : String,
      "Tags" : [ Tag, ... ],
      "VpcConfig" : VpcConfig
    }
}

YAML

Type: AWS::AppStream::ImageBuilder
Properties:
  AccessEndpoints: 
    - AccessEndpoint
  AppstreamAgentVersion: String
  Description: String
  DisplayName: String
  DomainJoinInfo: 
    DomainJoinInfo
  EnableDefaultInternetAccess: Boolean
  IamRoleArn: String
  ImageArn: String
  ImageName: String
  InstanceType: String
  Name: String
  Tags: 
    - Tag
  VpcConfig: 
    VpcConfig

Properties

AccessEndpoints

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

Required: No

Type: Array of AccessEndpoint

Minimum: 1

Maximum: 4

Update requires: No interruption

AppstreamAgentVersion

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

Required: No

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption

Description

The description to display.

Required: No

Type: String

Maximum: 256

Update requires: No interruption

DisplayName

The image builder name to display.

Required: No

Type: String

Maximum: 100

Update requires: No interruption

DomainJoinInfo

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

Required: No

Type: DomainJoinInfo

Update requires: No interruption

EnableDefaultInternetAccess

Enables or disables default internet access for the image builder.

Required: No

Type: Boolean

Update requires: No interruption

IamRoleArn

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.

Required: No

Type: String

Pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$

Update requires: No interruption

ImageArn

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

Required: No

Type: String

Pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$

Update requires: No interruption

ImageName

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

Required: No

Type: String

Minimum: 1

Update requires: No interruption

InstanceType

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

Required: Yes

Type: String

Minimum: 1

Update requires: No interruption

Name

A unique name for the image builder.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Update requires: No interruption

Tags

An array of key-value pairs.

Required: No

Type: Array of Tag

Update requires: No interruption

VpcConfig

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

Required: No

Type: VpcConfig

Update requires: No interruption

Return values

Ref

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

StreamingUrl

The URL to start an image builder streaming session, returned as a string.

See also

• CreateImageBuilder in the Amazon AppStream 2.0 API Reference