You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::AppStream::Types::ImageBuilder
- Inherits:
-
Struct
- Object
- Struct
- Aws::AppStream::Types::ImageBuilder
- Defined in:
- (unknown)
Overview
Describes a virtual machine that is used to create an image.
Returned by:
Instance Attribute Summary collapse
-
#access_endpoints ⇒ Array<Types::AccessEndpoint>
The list of virtual private cloud (VPC) interface endpoint objects.
-
#appstream_agent_version ⇒ String
The version of the AppStream 2.0 agent that is currently being used by the image builder.
-
#arn ⇒ String
The ARN for the image builder.
-
#created_time ⇒ Time
The time stamp when the image builder was created.
-
#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 ARN of the IAM role that is applied to the image builder.
-
#image_arn ⇒ String
The ARN of the image from which this builder was created.
-
#image_builder_errors ⇒ Array<Types::ResourceError>
The image builder errors.
-
#instance_type ⇒ String
The instance type for the image builder.
-
#name ⇒ String
The name of the image builder.
-
#network_access_configuration ⇒ Types::NetworkAccessConfiguration
Describes the network details of the fleet or image builder instance.
.
-
#platform ⇒ String
The operating system platform of the image builder.
-
#state ⇒ String
The state of the image builder.
-
#state_change_reason ⇒ Types::ImageBuilderStateChangeReason
The reason why the last state change occurred.
-
#vpc_config ⇒ Types::VpcConfig
The VPC configuration of the image builder.
Instance Attribute Details
#access_endpoints ⇒ Array<Types::AccessEndpoint>
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
#appstream_agent_version ⇒ String
The version of the AppStream 2.0 agent that is currently being used by the image builder.
#arn ⇒ String
The ARN for the image builder.
#created_time ⇒ Time
The time stamp when the image builder was created.
#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 ARN of the IAM role that is applied 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.
#image_arn ⇒ String
The ARN of the image from which this builder was created.
#image_builder_errors ⇒ Array<Types::ResourceError>
The image builder errors.
#instance_type ⇒ String
The instance type for the image builder. The following instance types are available:
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
#name ⇒ String
The name of the image builder.
#network_access_configuration ⇒ Types::NetworkAccessConfiguration
Describes the network details of the fleet or image builder instance.
#platform ⇒ String
The operating system platform of the image builder.
Possible values:
- WINDOWS
- WINDOWS_SERVER_2016
- WINDOWS_SERVER_2019
#state ⇒ String
The state of the image builder.
Possible values:
- PENDING
- UPDATING_AGENT
- RUNNING
- STOPPING
- STOPPED
- REBOOTING
- SNAPSHOTTING
- DELETING
- FAILED
#state_change_reason ⇒ Types::ImageBuilderStateChangeReason
The reason why the last state change occurred.
#vpc_config ⇒ Types::VpcConfig
The VPC configuration of the image builder.