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

ImageBuilder

Describes a virtual machine that is used to create an image.

Contents

AccessEndpoints

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

Type: Array of AccessEndpoint objects

Array Members: Minimum number of 1 item. Maximum number of 4 items.

Required: No

AppstreamAgentVersion

The version of the AppStream 2.0 agent that is currently being used by the image builder.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

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 to display.

Type: String

Length Constraints: Minimum length of 1.

Required: No

DisplayName

The image builder name to display.

Type: String

Length Constraints: Minimum length of 1.

Required: No

DomainJoinInfo

The name of the directory and organizational unit (OU) to use to join the image builder to 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

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 (STS) 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.

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

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. The following instance types are available:

  • 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.graphics-design.large

  • stream.graphics-design.xlarge

  • stream.graphics-design.2xlarge

  • stream.graphics-design.4xlarge

  • stream.graphics-desktop.2xlarge

  • stream.graphics-pro.4xlarge

  • stream.graphics-pro.8xlarge

  • stream.graphics-pro.16xlarge

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

NetworkAccessConfiguration

Describes the network details of the fleet or image builder instance.

Type: NetworkAccessConfiguration object

Required: No

Platform

The operating system platform of the image builder.

Type: String

Valid Values: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019

Required: No

State

The state of the image builder.

Type: String

Valid Values: PENDING | UPDATING_AGENT | 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: