/AWS1/CL_APS=>CREATEIMAGEBUILDER()¶
About CreateImageBuilder¶
Creates an image builder. An image builder is a virtual machine that is used to create an image.
The initial state of the builder is PENDING. When it is ready, the state is RUNNING.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_NAME TYPE /AWS1/APSNAME /AWS1/APSNAME¶
A unique name for the image builder.
IV_INSTANCETYPE TYPE /AWS1/APSSTRING /AWS1/APSSTRING¶
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
Optional arguments:¶
IV_IMAGENAME TYPE /AWS1/APSSTRING /AWS1/APSSTRING¶
The name of the image used to create the image builder.
IV_IMAGEARN TYPE /AWS1/APSARN /AWS1/APSARN¶
The ARN of the public, private, or shared image to use.
IV_DESCRIPTION TYPE /AWS1/APSDESCRIPTION /AWS1/APSDESCRIPTION¶
The description to display.
IV_DISPLAYNAME TYPE /AWS1/APSDISPLAYNAME /AWS1/APSDISPLAYNAME¶
The image builder name to display.
IO_VPCCONFIG TYPE REF TO /AWS1/CL_APSVPCCONFIG /AWS1/CL_APSVPCCONFIG¶
The VPC configuration for the image builder. You can specify only one subnet.
IV_IAMROLEARN TYPE /AWS1/APSARN /AWS1/APSARN¶
The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS)
AssumeRoleAPI 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.
IV_ENABLEDEFINTERNETACCESS TYPE /AWS1/APSBOOLEANOBJECT /AWS1/APSBOOLEANOBJECT¶
Enables or disables default internet access for the image builder.
IO_DOMAINJOININFO TYPE REF TO /AWS1/CL_APSDOMAINJOININFO /AWS1/CL_APSDOMAINJOININFO¶
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
IV_APPSTREAMAGENTVERSION TYPE /AWS1/APSAPPSTREAMAGENTVERSION /AWS1/APSAPPSTREAMAGENTVERSION¶
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].
IT_TAGS TYPE /AWS1/CL_APSTAGS_W=>TT_TAGS TT_TAGS¶
The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
_ . : / = + \ - @
If you do not specify a value, the value is set to an empty string.
For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
IT_ACCESSENDPOINTS TYPE /AWS1/CL_APSACCESSENDPOINT=>TT_ACCESSENDPOINTLIST TT_ACCESSENDPOINTLIST¶
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.