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

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

Overview

A detailed view of a component.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the component.

Returns:

  • (String)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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_descriptionString

The change description of the component.

Returns:

  • (String)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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

#dataString

Component data contains the YAML document content for the component.

Returns:

  • (String)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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_createdString

The date that Image Builder created the component.

Returns:

  • (String)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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

#descriptionString

The description of the component.

Returns:

  • (String)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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

#encryptedBoolean

The encryption status of the component.

Returns:

  • (Boolean)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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_idString

The KMS key identifier used to encrypt the component.

Returns:

  • (String)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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

#nameString

The name of the component.

Returns:

  • (String)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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

#obfuscateBoolean

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

Returns:

  • (Boolean)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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

#ownerString

The owner of the component.

Returns:

  • (String)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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

#parametersArray<Types::ComponentParameterDetail>

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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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

#platformString

The operating system platform of the component.

Returns:

  • (String)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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

#publisherString

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

Returns:

  • (String)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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

#stateTypes::ComponentState

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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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_versionsArray<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>)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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

#tagsHash<String,String>

The tags that apply to the component.

Returns:

  • (Hash<String,String>)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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

#typeString

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

Returns:

  • (String)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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

#versionString

The version of the component.

Returns:

  • (String)


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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