You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AppStream::Types::CreateImageBuilderRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateImageBuilderRequest as input to an Aws::Client method, you can use a vanilla 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",
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#access_endpoints ⇒ Array<Types::AccessEndpoint>

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

Returns:

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

Returns:

  • (String) —

    The version of the AppStream 2.0 agent to use for this image builder.

#description ⇒ String

The description to display.

Returns:

  • (String) —

    The description to display.

#display_name ⇒ String

The image builder name to display.

Returns:

  • (String) —

    The image builder name to display.

#domain_join_info ⇒ Types::DomainJoinInfo

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

Returns:

  • (Types::DomainJoinInfo) —

    The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

#enable_default_internet_access ⇒ Boolean

Enables or disables default internet access for the image builder.

Returns:

  • (Boolean) —

    Enables or disables default internet access for the image builder.

#iam_role_arn ⇒ String

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 in the Amazon AppStream 2.0 Administration Guide.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the IAM role to apply to the image builder.

#image_arn ⇒ String

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

Returns:

  • (String) —

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

#image_name ⇒ String

The name of the image used to create the image builder.

Returns:

  • (String) —

    The name of the image used to create the image builder.

#instance_type ⇒ String

The instance type to use when launching 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.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

Returns:

  • (String) —

    The instance type to use when launching the image builder.

#name ⇒ String

A unique name for the image builder.

Returns:

  • (String) —

    A unique name for the image builder.

#tags ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) —

    The tags to associate with the image builder.

#vpc_config ⇒ Types::VpcConfig

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

Returns: