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

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

Overview

Note:

When making an API call, you may pass ImportComponentRequest data as a hash:

{
  name: "ResourceName", # required
  semantic_version: "VersionNumber", # required
  description: "NonEmptyString",
  change_description: "NonEmptyString",
  type: "BUILD", # required, accepts BUILD, TEST
  format: "SHELL", # required, accepts SHELL
  platform: "Windows", # required, accepts Windows, Linux
  data: "NonEmptyString",
  uri: "Uri",
  kms_key_id: "NonEmptyString",
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#change_descriptionString

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 this component.

Returns:

  • (String)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 3477

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_tokenString

The idempotency token of the component.

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

Returns:

  • (String)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 3477

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

#dataString

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)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 3477

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

#descriptionString

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

Returns:

  • (String)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 3477

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

#formatString

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

Returns:

  • (String)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 3477

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_idString

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

Returns:

  • (String)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 3477

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

#nameString

The name of the component.

Returns:

  • (String)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 3477

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

#platformString

The platform of the component.

Returns:

  • (String)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 3477

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_versionString

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

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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.

Returns:

  • (String)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 3477

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

#tagsHash<String,String>

The tags of the component.

Returns:

  • (Hash<String,String>)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 3477

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

#typeString

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

Returns:

  • (String)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 3477

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

#uriString

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)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 3477

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