You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::KMS::Types::GetParametersForImportRequest

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

Overview

Note:

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

{
  key_id: "KeyIdType", # required
  wrapping_algorithm: "RSAES_PKCS1_V1_5", # required, accepts RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
  wrapping_key_spec: "RSA_2048", # required, accepts RSA_2048
}

Instance Attribute Summary collapse

Instance Attribute Details

#key_idString

The identifier of the CMK into which you will import key material. The CMK's Origin must be EXTERNAL.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Returns:

  • (String)


1167
1168
1169
1170
1171
1172
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1167

class GetParametersForImportRequest < Struct.new(
  :key_id,
  :wrapping_algorithm,
  :wrapping_key_spec)
  include Aws::Structure
end

#wrapping_algorithmString

The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.

Returns:

  • (String)


1167
1168
1169
1170
1171
1172
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1167

class GetParametersForImportRequest < Struct.new(
  :key_id,
  :wrapping_algorithm,
  :wrapping_key_spec)
  include Aws::Structure
end

#wrapping_key_specString

The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

Returns:

  • (String)


1167
1168
1169
1170
1171
1172
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1167

class GetParametersForImportRequest < Struct.new(
  :key_id,
  :wrapping_algorithm,
  :wrapping_key_spec)
  include Aws::Structure
end