Class: Aws::Imagebuilder::Types::CreateComponentRequest

Inherits:

Struct

• Object
• Struct
• Aws::Imagebuilder::Types::CreateComponentRequest

Includes:

Structure

Defined in:

lib/aws-sdk-imagebuilder/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #change_description ⇒ String

  The change description of the component.

• #client_token ⇒ String

  Unique, case-sensitive identifier you provide to ensure idempotency of the request.

• #data ⇒ String

  Component ‘data` contains inline YAML document content for the component.

• #description ⇒ String

  Describes the contents of the component.

• #dry_run ⇒ Boolean

  Validates the required permissions for the operation and the request parameters, without actually making the request, and provides an error response.

• #kms_key_id ⇒ String

  The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component.

• #name ⇒ String

  The name of the component.

• #platform ⇒ String

  The operating system platform of the component.

• #semantic_version ⇒ String

  The semantic version 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.

• #uri ⇒ String

  The ‘uri` of a YAML component document file.

Instance Attribute Details

#change_description ⇒ String

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.

Returns:

• (String)

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

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see [Ensuring idempotency] in the *Amazon EC2 API Reference*.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

• (String)

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

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#data ⇒ String

Component ‘data` contains inline YAML document content for the component. Alternatively, you can specify the `uri` of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

Returns:

• (String)

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

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Describes the contents of the component.

Returns:

• (String)

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

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

Validates the required permissions for the operation and the request parameters, without actually making the request, and provides an error response. Upon a successful request, the error response is ‘DryRunOperationException`.

Returns:

• (Boolean)

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

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see [Key identifiers (KeyId)] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN

Returns:

• (String)

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

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the component.

Returns:

• (String)

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

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#platform ⇒ String

The operating system platform of the component.

Returns:

• (String)

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

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#semantic_version ⇒ String

The semantic version of the component. This version follows the semantic version syntax.

<note markdown=“1”> The semantic version has four nodes: &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can assign values for the first three, and can filter on all of them.

**Assignment:** For the first three nodes you can assign any

positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

**Patterns:** You can use any numeric pattern that adheres to the

assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

</note>

Returns:

• (String)

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

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :dry_run)
  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, a prefix match is performed against the base image OS version during image recipe creation.

Returns:

• (Array<String>)

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

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags that apply to the component.

Returns:

• (Hash<String,String>)

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

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#uri ⇒ String

The ‘uri` of a YAML component document file. This must be an S3 URL (`s3://bucket/key`), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

Alternatively, you can specify the YAML document inline, using the component ‘data` property. You cannot specify both properties.

Returns:

• (String)

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

class CreateComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :platform,
  :supported_os_versions,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end