Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . appstream ]

create-image-builder

Description

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 .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-image-builder
--name <value>
[--image-name <value>]
[--image-arn <value>]
--instance-type <value>
[--description <value>]
[--display-name <value>]
[--vpc-config <value>]
[--enable-default-internet-access | --no-enable-default-internet-access]
[--domain-join-info <value>]
[--appstream-agent-version <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

A unique name for the image builder.

--image-name (string)

The name of the image used to create the builder.

--image-arn (string)

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

--instance-type (string)

The instance type to use when launching the image builder.

--description (string)

The description for display.

--display-name (string)

The image builder name for display.

--vpc-config (structure)

The VPC configuration for the image builder. You can specify only one subnet.

Shorthand Syntax:

SubnetIds=string,string,SecurityGroupIds=string,string

JSON Syntax:

{
  "SubnetIds": ["string", ...],
  "SecurityGroupIds": ["string", ...]
}

--enable-default-internet-access | --no-enable-default-internet-access (boolean)

Enables or disables default internet access for the image builder.

--domain-join-info (structure)

The information needed to join a Microsoft Active Directory domain.

Shorthand Syntax:

DirectoryName=string,OrganizationalUnitDistinguishedName=string

JSON Syntax:

{
  "DirectoryName": "string",
  "OrganizationalUnitDistinguishedName": "string"
}

--appstream-agent-version (string)

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].

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ImageBuilder -> (structure)

Information about the image builder.

Name -> (string)

The name of the image builder.

Arn -> (string)

The ARN for the image builder.

ImageArn -> (string)

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

Description -> (string)

The description for display.

DisplayName -> (string)

The image builder name for display.

VpcConfig -> (structure)

The VPC configuration of the image builder.

SubnetIds -> (list)

The subnets to which a network interface is established from the fleet instance.

(string)

SecurityGroupIds -> (list)

The security groups for the fleet.

(string)

InstanceType -> (string)

The instance type for the image builder.

Platform -> (string)

The operating system platform of the image builder.

State -> (string)

The state of the image builder.

StateChangeReason -> (structure)

The reason why the last state change occurred.

Code -> (string)

The state change reason code.

Message -> (string)

The state change reason message.

CreatedTime -> (timestamp)

The time stamp when the image builder was created.

EnableDefaultInternetAccess -> (boolean)

Enables or disables default internet access for the image builder.

DomainJoinInfo -> (structure)

The information needed to join a Microsoft Active Directory domain.

DirectoryName -> (string)

The fully qualified name of the directory (for example, corp.example.com).

OrganizationalUnitDistinguishedName -> (string)

The distinguished name of the organizational unit for computer accounts.

ImageBuilderErrors -> (list)

The image builder errors.

(structure)

Describes a resource error.

ErrorCode -> (string)

The error code.

ErrorMessage -> (string)

The error message.

ErrorTimestamp -> (timestamp)

The time the error occurred.

AppstreamAgentVersion -> (string)

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