ImageBuilder

The name of the image builder.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

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

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

The ARN for the image builder.

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}$

Required: No

The time stamp when the image builder was created.

Type: Timestamp

Required: No

The description to display.

Type: String

Length Constraints: Minimum length of 1.

Required: No

The image builder name to display.

Type: String

Length Constraints: Minimum length of 1.

Required: No

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

Enables or disables default internet access for the image builder.

Type: Boolean

Required: No

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(?:\-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}$

Required: No

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

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}$

Required: No

The image builder errors.

Type: Array of ResourceError objects

Required: No

The instance type for the image builder. The following instance types are available:

Type: String

Length Constraints: Minimum length of 1.

Required: No

Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.

Type: String

Valid Values: TRUE | FALSE

Required: No

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

Type: NetworkAccessConfiguration object

Required: No

The operating system platform of the image builder.

Type: String

Valid Values: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2 | RHEL8

Required: No

The state of the image builder.

Type: String

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

Required: No

The reason why the last state change occurred.

Type: ImageBuilderStateChangeReason object

Required: No

The VPC configuration of the image builder.

Type: VpcConfig object

Required: No