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"],
  },
  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",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#access_endpointsArray<Types::AccessEndpoint>

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

Returns:



762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 762

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

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


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 762

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

#descriptionString

The description to display.

Returns:

  • (String)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 762

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

#display_nameString

The image builder name to display.

Returns:

  • (String)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 762

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

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



762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 762

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

#enable_default_internet_accessBoolean

Enables or disables default internet access for the image builder.

Returns:

  • (Boolean)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 762

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

#iam_role_arnString

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.

Returns:

  • (String)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 762

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

#image_arnString

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

Returns:

  • (String)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 762

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

#image_nameString

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

Returns:

  • (String)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 762

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

#instance_typeString

The instance type to use when launching the image builder.

Returns:

  • (String)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 762

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

#nameString

A unique name for the image builder.

Returns:

  • (String)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 762

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

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

Returns:

  • (Hash<String,String>)


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 762

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

#vpc_configTypes::VpcConfig

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

Returns:



762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 762

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