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. For more information, see CreateImageBuilder in the Amazon AppStream 2.0 API Reference.

Syntax

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

JSON


{
  "Type" : "AWS::AppStream::ImageBuilder",
  "Properties" : {
    "AppstreamAgentVersion" : String,    
    "Description" : String,
    "DisplayName" : String,
    "DomainJoinInfo" : DomainJoinInfo,
    "EnableDefaultInternetAccess" : Boolean,
    "ImageArn" : String,
    "ImageName" : String,
    "InstanceType" : String,
    "Name" : String,
    "VpcConfig" : VpcConfig
  }
}

YAML


Type: "AWS::AppStream::ImageBuilder"
Properties:
  AppstreamAgentVersion: String
  Description: String  
  DisplayName: String
  DomainJoinInfo: DomainJoinInfo
  EnableDefaultInternetAccess: Boolean
  ImageArn: String
  ImageName: String
  InstanceType: String
  Name: String
  VpcConfig: VpcConfig

Properties

AppstreamAgentVersion

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

Required: No

Type: String

Update requires: No interruption

Description

The description to display.

Required: No

Type: String

Update requires: No interruption

DisplayName

The image builder name to display.

Required: No

Type: String

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

ImageArn

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

Required: No

Type: String

Update requires: No interruption

ImageName

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

Required: No

Type: String

Update requires: No interruption

InstanceType

The instance type to use when launching the image builder.

Required: Yes

Type: String

Update requires: No interruption

Name

A unique name for the image builder.

Required: Yes

Type: String

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

Fn::GetAtt

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

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

For more information about using Fn::GetAtt, see Fn::GetAtt.

AWS::AppStream::ImageBuilder

Syntax

JSON

YAML

Properties

Return Values

Fn::GetAtt

See Also