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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appstream/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",
}

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)


465
466
467
468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 465

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)
  include Aws::Structure
end

#descriptionString

The description for display.

Returns:

  • (String)


465
466
467
468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 465

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)
  include Aws::Structure
end

#display_nameString

The image builder name for display.

Returns:

  • (String)


465
466
467
468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 465

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)
  include Aws::Structure
end

#domain_join_infoTypes::DomainJoinInfo

The information needed to join a Microsoft Active Directory domain.



465
466
467
468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 465

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)
  include Aws::Structure
end

#enable_default_internet_accessBoolean

Enables or disables default internet access for the image builder.

Returns:

  • (Boolean)


465
466
467
468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 465

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)
  include Aws::Structure
end

#image_arnString

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

Returns:

  • (String)


465
466
467
468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 465

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)
  include Aws::Structure
end

#image_nameString

The name of the image used to create the builder.

Returns:

  • (String)


465
466
467
468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 465

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)
  include Aws::Structure
end

#instance_typeString

The instance type to use when launching the image builder.

Returns:

  • (String)


465
466
467
468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 465

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)
  include Aws::Structure
end

#nameString

A unique name for the image builder.

Returns:

  • (String)


465
466
467
468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 465

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)
  include Aws::Structure
end

#vpc_configTypes::VpcConfig

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

Returns:



465
466
467
468
469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 465

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)
  include Aws::Structure
end