Class: Aws::Imagebuilder::Types::ImportComponentRequest

Inherits:

Struct

• Object
• Struct
• Aws::Imagebuilder::Types::ImportComponentRequest

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

  The data of the component.

• #description ⇒ String

  The description of the component.

• #format ⇒ String

  The format of the resource that you want to import as a component.

• #kms_key_id ⇒ String

  The ID of the KMS key that should be used to encrypt this component.

• #name ⇒ String

  The name of the component.

• #platform ⇒ String

  The platform of the component.

• #semantic_version ⇒ String

  The semantic version of the component.

• #tags ⇒ Hash<String,String>

  The tags of the component.

• #type ⇒ String

  The type of the component denotes whether the component is used to build the image, or only to test it.

• #uri ⇒ String

  The uri of the component.

Instance Attribute Details

#change_description ⇒ String

The change description of the component. This description indicates the change that 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 4288

class ImportComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :type,
  :format,
  :platform,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token)
  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 4288

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

#data ⇒ String

The data of the component. Used to specify the data inline. Either ‘data` or `uri` can be used to specify the data within the component.

Returns:

• (String)

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

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

#description ⇒ String

The description of the component. Describes the contents of the component.

Returns:

• (String)

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

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

#format ⇒ String

The format of the resource that you want to import as a component.

Returns:

• (String)

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

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

#kms_key_id ⇒ String

The ID of the KMS key that should be used to encrypt this component.

Returns:

• (String)

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

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

#name ⇒ String

The name of the component.

Returns:

• (String)

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

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

#platform ⇒ String

The platform of the component.

Returns:

• (String)

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

class ImportComponentRequest < Struct.new(
  :name,
  :semantic_version,
  :description,
  :change_description,
  :type,
  :format,
  :platform,
  :data,
  :uri,
  :kms_key_id,
  :tags,
  :client_token)
  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.

**Filtering:** With semantic versioning, you have the flexibility to

use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

</note>

Returns:

• (String)

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

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

#tags ⇒ Hash<String,String>

The tags of the component.

Returns:

• (Hash<String,String>)

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

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

#type ⇒ String

The type of the component denotes whether the component is used to build the image, or only to test it.

Returns:

• (String)

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

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

#uri ⇒ String

The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either ‘data` or `uri` can be used to specify the data within the component.

Returns:

• (String)

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

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