Class: Aws::Imagebuilder::Types::Component

Inherits:

Struct

• Object
• Struct
• Aws::Imagebuilder::Types::Component

Defined in:

gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb

Overview

A detailed view of a component.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the component.

• #change_description ⇒ String

  The change description of the component.

• #data ⇒ String

  Component data contains the YAML document content for the component.

• #date_created ⇒ String

  The date that Image Builder created the component.

• #description ⇒ String

  The description of the component.

• #encrypted ⇒ Boolean

  The encryption status of the component.

• #kms_key_id ⇒ String

  The KMS key identifier used to encrypt the component.

• #name ⇒ String

  The name of the component.

• #obfuscate ⇒ Boolean

  Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.

• #owner ⇒ String

  The owner of the component.

• #parameters ⇒ Array<Types::ComponentParameterDetail>

  Contains parameter details for each of the parameters that the component document defined for the component.

• #platform ⇒ String

  The operating system platform of the component.

• #publisher ⇒ String

  Contains the name of the publisher if this is a third-party component.

• #state ⇒ Types::ComponentState

  Describes the current status of the component.

• #supported_os_versions ⇒ Array<String>

  The operating system (OS) version supported by the component.

• #tags ⇒ Hash<String,String>

  The tags that apply to the component.

• #type ⇒ String

  The component type specifies whether Image Builder uses the component to build the image or only to test it.

• #version ⇒ String

  The version of the component.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the component.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#change_description ⇒ String

The change description of the component.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#data ⇒ String

Component data contains the YAML document content for the component.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#date_created ⇒ String

The date that Image Builder created the component.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the component.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ Boolean

The encryption status of the component.

Returns:

• (Boolean)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The KMS key identifier used to encrypt the component.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the component.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#obfuscate ⇒ Boolean

Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.

Returns:

• (Boolean)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#owner ⇒ String

The owner of the component.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Array<Types::ComponentParameterDetail>

Contains parameter details for each of the parameters that the component document defined for the component.

Returns:

• (Array<Types::ComponentParameterDetail>)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#platform ⇒ String

The operating system platform of the component.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#publisher ⇒ String

Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ Types::ComponentState

Describes the current status of the component. This is used for components that are no longer active.

Returns:

• (Types::ComponentState)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#supported_os_versions ⇒ Array<String>

The operating system (OS) version supported by the component. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags that apply to the component.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The component type specifies whether Image Builder uses the component to build the image or only to test it.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

The version of the component.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 308

class Component < Struct.new(
  :arn,
  :name,
  :version,
  :description,
  :change_description,
  :type,
  :platform,
  :supported_os_versions,
  :state,
  :parameters,
  :owner,
  :data,
  :kms_key_id,
  :encrypted,
  :date_created,
  :tags,
  :publisher,
  :obfuscate)
  SENSITIVE = []
  include Aws::Structure
end