class Aws::AppStream::Types::CreateImageBuilderRequest

@note When making an API call, you may pass CreateImageBuilderRequest

data as a hash:

    {
      name: "Name", # required
      image_name: "String",
      image_arn: "Arn",
      instance_type: "String", # required
      description: "Description",
      display_name: "DisplayName",
      vpc_config: {
        subnet_ids: ["String"],
        security_group_ids: ["String"],
      },
      iam_role_arn: "Arn",
      enable_default_internet_access: false,
      domain_join_info: {
        directory_name: "DirectoryName",
        organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
      },
      appstream_agent_version: "AppstreamAgentVersion",
      tags: {
        "TagKey" => "TagValue",
      },
      access_endpoints: [
        {
          endpoint_type: "STREAMING", # required, accepts STREAMING
          vpce_id: "String",
        },
      ],
    }

@!attribute [rw] name

A unique name for the image builder.
@return [String]

@!attribute [rw] image_name

The name of the image used to create the image builder.
@return [String]

@!attribute [rw] image_arn

The ARN of the public, private, or shared image to use.
@return [String]

@!attribute [rw] instance_type

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
@return [String]

@!attribute [rw] description

The description to display.
@return [String]

@!attribute [rw] display_name

The image builder name to display.
@return [String]

@!attribute [rw] vpc_config

The VPC configuration for the image builder. You can specify only
one subnet.
@return [Types::VpcConfig]

@!attribute [rw] iam_role_arn

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) `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][1] in the *Amazon AppStream 2.0 Administration Guide*.

[1]: https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html
@return [String]

@!attribute [rw] enable_default_internet_access

Enables or disables default internet access for the image builder.
@return [Boolean]

@!attribute [rw] domain_join_info

The name of the directory and organizational unit (OU) to use to
join the image builder to a Microsoft Active Directory domain.
@return [Types::DomainJoinInfo]

@!attribute [rw] appstream_agent_version

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\].
@return [String]

@!attribute [rw] 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][1] in
the *Amazon AppStream 2.0 Administration Guide*.

[1]: https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html
@return [Hash<String,String>]

@!attribute [rw] access_endpoints

The list of interface VPC endpoint (interface endpoint) objects.
Administrators can connect to the image builder only through the
specified endpoints.
@return [Array<Types::AccessEndpoint>]

@see docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateImageBuilderRequest AWS API Documentation

Constants

SENSITIVE