Menu
Amazon AppStream 2.0
API Reference (API Version 2016-12-01)

ImageBuilder

Describes a streaming instance used for editing an image. New images are created from a snapshot through an image builder.

Contents

Arn

The ARN for the image builder.

Type: String

Pattern: ^arn:aws:[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}$

Required: No

CreatedTime

The time stamp when the image builder was created.

Type: Timestamp

Required: No

Description

The description for display.

Type: String

Length Constraints: Minimum length of 1.

Required: No

DisplayName

The image builder name for display.

Type: String

Length Constraints: Minimum length of 1.

Required: No

DomainJoinInfo

The information needed to join a Microsoft Active Directory domain.

Type: DomainJoinInfo object

Required: No

EnableDefaultInternetAccess

Enables or disables default internet access for the image builder.

Type: Boolean

Required: No

ImageArn

The ARN of the image from which this builder was created.

Type: String

Pattern: ^arn:aws:[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}$

Required: No

ImageBuilderErrors

The image builder errors.

Type: Array of ResourceError objects

Required: No

InstanceType

The instance type for the image builder.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Name

The name of the image builder.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Platform

The operating system platform of the image builder.

Type: String

Valid Values: WINDOWS

Required: No

State

The state of the image builder.

Type: String

Valid Values: PENDING | RUNNING | STOPPING | STOPPED | REBOOTING | SNAPSHOTTING | DELETING | FAILED

Required: No

StateChangeReason

The reason why the last state change occurred.

Type: ImageBuilderStateChangeReason object

Required: No

VpcConfig

The VPC configuration of the image builder.

Type: VpcConfig object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: