Class: Aws::AppStream::Types::ImageBuilder

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

Overview

Describes a virtual machine that is used to create an image.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_endpointsArray<Types::AccessEndpoint>

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

Returns:



3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#appstream_agent_versionString

The version of the AppStream 2.0 agent that is currently being used by the image builder.

Returns:

  • (String)


3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#arnString

The ARN for the image builder.

Returns:

  • (String)


3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#created_timeTime

The time stamp when the image builder was created.

Returns:

  • (Time)


3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description to display.

Returns:

  • (String)


3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#display_nameString

The image builder name to display.

Returns:

  • (String)


3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  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.



3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#enable_default_internet_accessBoolean

Enables or disables default internet access for the image builder.

Returns:

  • (Boolean)


3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arnString

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.

Returns:

  • (String)


3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#image_arnString

The ARN of the image from which this builder was created.

Returns:

  • (String)


3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#image_builder_errorsArray<Types::ResourceError>

The image builder errors.

Returns:



3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typeString

The instance type for 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

Returns:

  • (String)


3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the image builder.

Returns:

  • (String)


3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#network_access_configurationTypes::NetworkAccessConfiguration

Describes the network details of the fleet or image builder instance.



3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#platformString

The operating system platform of the image builder.

Returns:

  • (String)


3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The state of the image builder.

Returns:

  • (String)


3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#state_change_reasonTypes::ImageBuilderStateChangeReason

The reason why the last state change occurred.



3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configTypes::VpcConfig

The VPC configuration of the image builder.

Returns:



3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3813

class ImageBuilder < Struct.new(
  :name,
  :arn,
  :image_arn,
  :description,
  :display_name,
  :vpc_config,
  :instance_type,
  :platform,
  :iam_role_arn,
  :state,
  :state_change_reason,
  :created_time,
  :enable_default_internet_access,
  :domain_join_info,
  :network_access_configuration,
  :image_builder_errors,
  :appstream_agent_version,
  :access_endpoints)
  SENSITIVE = []
  include Aws::Structure
end