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"],
  },
  enable_default_internet_access: false,
  domain_join_info: {
    directory_name: "DirectoryName",
    organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
  },
  appstream_agent_version: "AppstreamAgentVersion",
  tags: {
    "TagKey" => "TagValue",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#appstream_agent_versionString

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.

#descriptionString

The description to display.

Returns:

  • (String)

    The description to display.

#display_nameString

The image builder name to display.

Returns:

  • (String)

    The image builder name to display.

#domain_join_infoTypes::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_accessBoolean

Enables or disables default internet access for the image builder.

Returns:

  • (Boolean)

    Enables or disables default internet access for the image builder.

#image_arnString

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_nameString

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_typeString

The instance type to use when launching the image builder.

Returns:

  • (String)

    The instance type to use when launching the image builder.

#nameString

A unique name for the image builder.

Returns:

  • (String)

    A unique name for the image builder.

#tagsHash<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 Developer Guide.

Returns:

  • (Hash<String,String>)

    The tags to associate with the image builder.

#vpc_configTypes::VpcConfig

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

Returns: