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

Inherits:

Struct

• Object
• Struct
• Aws::AppStream::Types::CreateImageBuilderRequest

Includes:

Structure

Defined in:

lib/aws-sdk-appstream/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #access_endpoints ⇒ Array<Types::AccessEndpoint>

  The list of interface VPC endpoint (interface endpoint) objects.

• #appstream_agent_version ⇒ String

  The version of the WorkSpaces Applications agent to use for this image builder.

• #description ⇒ String

  The description to display.

• #display_name ⇒ 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.

• #enable_default_internet_access ⇒ 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.

• #image_arn ⇒ 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.

• #instance_type ⇒ String

  The instance type to use when launching the image builder.

• #name ⇒ String

  A unique name for the image builder.

• #root_volume_config ⇒ Types::VolumeConfig

  The configuration for the root volume of the image builder.

• #softwares_to_install ⇒ Array<String>

  The list of license included applications to install on the image builder during creation.

• #softwares_to_uninstall ⇒ Array<String>

  The list of license included applications to uninstall from the image builder during creation.

• #tags ⇒ Hash<String,String>

  The tags to associate with the image builder.

• #vpc_config ⇒ Types::VpcConfig

  The VPC configuration for the image builder.

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:

• (Array<Types::AccessEndpoint>)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end

#appstream_agent_version ⇒ String

The version of the WorkSpaces Applications agent to use for this image builder. To use the latest version of the WorkSpaces Applications agent, specify [LATEST].

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description to display.

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The image builder name to display.

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end

#enable_default_internet_access ⇒ Boolean

Enables or disables default internet access for the image builder.

Returns:

• (Boolean)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end

#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. WorkSpaces Applications 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 WorkSpaces Applications Streaming Instances] in the *Amazon WorkSpaces Applications Administration Guide*.

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

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end

#image_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end

#image_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ String

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.g4dn.xlarge

• stream.graphics.g4dn.2xlarge

• stream.graphics.g4dn.4xlarge

• stream.graphics.g4dn.8xlarge

• stream.graphics.g4dn.12xlarge

• stream.graphics.g4dn.16xlarge

• stream.graphics.g5.xlarge

• stream.graphics.g5.2xlarge

• stream.graphics.g5.4xlarge

• stream.graphics.g5.8xlarge

• stream.graphics.g5.16xlarge

• stream.graphics.g5.12xlarge

• stream.graphics.g5.24xlarge

• stream.graphics.g6.xlarge

• stream.graphics.g6.2xlarge

• stream.graphics.g6.4xlarge

• stream.graphics.g6.8xlarge

• stream.graphics.g6.16xlarge

• stream.graphics.g6.12xlarge

• stream.graphics.g6.24xlarge

• stream.graphics.gr6.4xlarge

• stream.graphics.gr6.8xlarge

• stream.graphics.g6f.large

• stream.graphics.g6f.xlarge

• stream.graphics.g6f.2xlarge

• stream.graphics.g6f.4xlarge

• stream.graphics.gr6f.4xlarge

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A unique name for the image builder.

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end

#root_volume_config ⇒ Types::VolumeConfig

The configuration for the root volume of the image builder. Use this to customize storage capacity from 200 GB up to 500 GB based on your application installation requirements.

Returns:

• (Types::VolumeConfig)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end

#softwares_to_install ⇒ Array<String>

The list of license included applications to install on the image builder during creation.

Possible values include the following:

• Microsoft_Office_2021_LTSC_Professional_Plus_32Bit

• Microsoft_Office_2021_LTSC_Professional_Plus_64Bit

• Microsoft_Office_2024_LTSC_Professional_Plus_32Bit

• Microsoft_Office_2024_LTSC_Professional_Plus_64Bit

• Microsoft_Visio_2021_LTSC_Professional_32Bit

• Microsoft_Visio_2021_LTSC_Professional_64Bit

• Microsoft_Visio_2024_LTSC_Professional_32Bit

• Microsoft_Visio_2024_LTSC_Professional_64Bit

• Microsoft_Project_2021_Professional_32Bit

• Microsoft_Project_2021_Professional_64Bit

• Microsoft_Project_2024_Professional_32Bit

• Microsoft_Project_2024_Professional_64Bit

• Microsoft_Office_2021_LTSC_Standard_32Bit

• Microsoft_Office_2021_LTSC_Standard_64Bit

• Microsoft_Office_2024_LTSC_Standard_32Bit

• Microsoft_Office_2024_LTSC_Standard_64Bit

• Microsoft_Visio_2021_LTSC_Standard_32Bit

• Microsoft_Visio_2021_LTSC_Standard_64Bit

• Microsoft_Visio_2024_LTSC_Standard_32Bit

• Microsoft_Visio_2024_LTSC_Standard_64Bit

• Microsoft_Project_2021_Standard_32Bit

• Microsoft_Project_2021_Standard_64Bit

• Microsoft_Project_2024_Standard_32Bit

• Microsoft_Project_2024_Standard_64Bit

Returns:

• (Array<String>)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end

#softwares_to_uninstall ⇒ Array<String>

The list of license included applications to uninstall from the image builder during creation.

Possible values include the following:

• Microsoft_Office_2021_LTSC_Professional_Plus_32Bit

• Microsoft_Office_2021_LTSC_Professional_Plus_64Bit

• Microsoft_Office_2024_LTSC_Professional_Plus_32Bit

• Microsoft_Office_2024_LTSC_Professional_Plus_64Bit

• Microsoft_Visio_2021_LTSC_Professional_32Bit

• Microsoft_Visio_2021_LTSC_Professional_64Bit

• Microsoft_Visio_2024_LTSC_Professional_32Bit

• Microsoft_Visio_2024_LTSC_Professional_64Bit

• Microsoft_Project_2021_Professional_32Bit

• Microsoft_Project_2021_Professional_64Bit

• Microsoft_Project_2024_Professional_32Bit

• Microsoft_Project_2024_Professional_64Bit

• Microsoft_Office_2021_LTSC_Standard_32Bit

• Microsoft_Office_2021_LTSC_Standard_64Bit

• Microsoft_Office_2024_LTSC_Standard_32Bit

• Microsoft_Office_2024_LTSC_Standard_64Bit

• Microsoft_Visio_2021_LTSC_Standard_32Bit

• Microsoft_Visio_2021_LTSC_Standard_64Bit

• Microsoft_Visio_2024_LTSC_Standard_32Bit

• Microsoft_Visio_2024_LTSC_Standard_64Bit

• Microsoft_Project_2021_Standard_32Bit

• Microsoft_Project_2021_Standard_64Bit

• Microsoft_Project_2024_Standard_32Bit

• Microsoft_Project_2024_Standard_64Bit

Returns:

• (Array<String>)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end

#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 WorkSpaces Applications Administration Guide*.

[1]: docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ Types::VpcConfig

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

Returns:

• (Types::VpcConfig)

# File 'lib/aws-sdk-appstream/types.rb', line 2024

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :iam_role_arn,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags,
  :access_endpoints,
  :root_volume_config,
  :softwares_to_install,
  :softwares_to_uninstall)
  SENSITIVE = []
  include Aws::Structure
end