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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#key_idString

The identifier of the symmetric encryption KMS key into which you will import key material. The `Origin` of the KMS key must be `EXTERNAL`.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Returns:

  • (String)

2721
2722
2723
2724
2725
2726
2727
# File 'lib/aws-sdk-kms/types.rb', line 2721

class GetParametersForImportRequest < Struct.new(
  :key_id,
  :wrapping_algorithm,
  :wrapping_key_spec)
  SENSITIVE = []
  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][1

in the *Key Management Service

Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html

Returns:

  • (String)

2721
2722
2723
2724
2725
2726
2727
# File 'lib/aws-sdk-kms/types.rb', line 2721

class GetParametersForImportRequest < Struct.new(
  :key_id,
  :wrapping_algorithm,
  :wrapping_key_spec)
  SENSITIVE = []
  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)

2721
2722
2723
2724
2725
2726
2727
# File 'lib/aws-sdk-kms/types.rb', line 2721

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