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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-appstream/types.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

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


634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/aws-sdk-appstream/types.rb', line 634

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags)
  include Aws::Structure
end

#description ⇒ String

The description to display.

Returns:

  • (String) 


634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/aws-sdk-appstream/types.rb', line 634

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags)
  include Aws::Structure
end

#display_name ⇒ String

The image builder name to display.

Returns:

  • (String) 


634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/aws-sdk-appstream/types.rb', line 634

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags)
  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:



634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/aws-sdk-appstream/types.rb', line 634

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags)
  include Aws::Structure
end

#enable_default_internet_access ⇒ Boolean

Enables or disables default internet access for the image builder.

Returns:

  • (Boolean) 


634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/aws-sdk-appstream/types.rb', line 634

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags)
  include Aws::Structure
end

#image_arn ⇒ String

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

Returns:

  • (String) 


634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/aws-sdk-appstream/types.rb', line 634

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags)
  include Aws::Structure
end

#image_name ⇒ String

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

Returns:

  • (String) 


634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/aws-sdk-appstream/types.rb', line 634

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags)
  include Aws::Structure
end

#instance_type ⇒ String

The instance type to use when launching the image builder.

Returns:

  • (String) 


634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/aws-sdk-appstream/types.rb', line 634

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags)
  include Aws::Structure
end

#name ⇒ String

A unique name for the image builder.

Returns:

  • (String) 


634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/aws-sdk-appstream/types.rb', line 634

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags)
  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=.

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

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

Returns:

  • (Hash<String,String>) 


634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/aws-sdk-appstream/types.rb', line 634

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags)
  include Aws::Structure
end

#vpc_config ⇒ Types::VpcConfig

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

Returns:



634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/aws-sdk-appstream/types.rb', line 634

class CreateImageBuilderRequest < Struct.new(
  :name,
  :image_name,
  :image_arn,
  :instance_type,
  :description,
  :display_name,
  :vpc_config,
  :enable_default_internet_access,
  :domain_join_info,
  :appstream_agent_version,
  :tags)
  include Aws::Structure
end