Class: Aws::AppStream::Types::CreateImageBuilderRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AppStream::Types::CreateImageBuilderRequest
- Defined in:
- gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#access_endpoints ⇒ Array<Types::AccessEndpoint>
The list of interface VPC endpoint (interface endpoint) objects.
-
#appstream_agent_version ⇒ String
The version of the AppStream 2.0 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.
-
#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.
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1610 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) SENSITIVE = [] include Aws::Structure end |
#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].
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1610 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) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description to display.
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1610 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) SENSITIVE = [] include Aws::Structure end |
#display_name ⇒ String
The image builder name to display.
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1610 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) 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.
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1610 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) SENSITIVE = [] include Aws::Structure end |
#enable_default_internet_access ⇒ Boolean
Enables or disables default internet access for the image builder.
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1610 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) 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. AppStream 2.0 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 AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1610 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) SENSITIVE = [] include Aws::Structure end |
#image_arn ⇒ String
The ARN of the public, private, or shared image to use.
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1610 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) SENSITIVE = [] include Aws::Structure end |
#image_name ⇒ String
The name of the image used to create the image builder.
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1610 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) 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-desktop.2xlarge
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-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1610 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) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
A unique name for the image builder.
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1610 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) 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 AppStream 2.0 Administration Guide.
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1610 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) SENSITIVE = [] include Aws::Structure end |
#vpc_config ⇒ Types::VpcConfig
The VPC configuration for the image builder. You can specify only one subnet.
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1610 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) SENSITIVE = [] include Aws::Structure end |