Class: Aws::KMS::Types::ReEncryptRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ciphertext_blobString

Ciphertext of the data to reencrypt.

Returns:

  • (String)


5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5256

class ReEncryptRequest < Struct.new(
  :ciphertext_blob,
  :source_encryption_context,
  :source_key_id,
  :destination_key_id,
  :destination_encryption_context,
  :source_encryption_algorithm,
  :destination_encryption_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#destination_encryption_algorithmString

Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption algorithm used for symmetric encryption KMS keys.

This parameter is required only when the destination KMS key is an asymmetric KMS key.

Returns:

  • (String)


5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5256

class ReEncryptRequest < Struct.new(
  :ciphertext_blob,
  :source_encryption_context,
  :source_key_id,
  :destination_key_id,
  :destination_encryption_context,
  :source_encryption_algorithm,
  :destination_encryption_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#destination_encryption_contextHash<String,String>

Specifies that encryption context to use when the reencrypting the data.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

A destination encryption context is valid only when the destination KMS key is a symmetric encryption KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for metadata.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

Returns:

  • (Hash<String,String>)


5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5256

class ReEncryptRequest < Struct.new(
  :ciphertext_blob,
  :source_encryption_context,
  :source_key_id,
  :destination_key_id,
  :destination_encryption_context,
  :source_encryption_algorithm,
  :destination_encryption_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#destination_key_idString

A unique identifier for the KMS key that is used to reencrypt the data. Specify a symmetric encryption KMS key or an asymmetric KMS key with a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage value of a KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

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

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

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Returns:

  • (String)


5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5256

class ReEncryptRequest < Struct.new(
  :ciphertext_blob,
  :source_encryption_context,
  :source_key_id,
  :destination_key_id,
  :destination_encryption_context,
  :source_encryption_algorithm,
  :destination_encryption_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#dry_runBoolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

Returns:

  • (Boolean)


5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5256

class ReEncryptRequest < Struct.new(
  :ciphertext_blob,
  :source_encryption_context,
  :source_key_id,
  :destination_key_id,
  :destination_encryption_context,
  :source_encryption_algorithm,
  :destination_encryption_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#grant_tokensArray<String>

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Returns:

  • (Array<String>)


5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5256

class ReEncryptRequest < Struct.new(
  :ciphertext_blob,
  :source_encryption_context,
  :source_key_id,
  :destination_key_id,
  :destination_encryption_context,
  :source_encryption_algorithm,
  :destination_encryption_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#source_encryption_algorithmString

Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm used for symmetric encryption KMS keys.

Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.

Returns:

  • (String)


5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5256

class ReEncryptRequest < Struct.new(
  :ciphertext_blob,
  :source_encryption_context,
  :source_key_id,
  :destination_key_id,
  :destination_encryption_context,
  :source_encryption_algorithm,
  :destination_encryption_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#source_encryption_contextHash<String,String>

Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context that was used to encrypt the ciphertext.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

Returns:

  • (Hash<String,String>)


5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5256

class ReEncryptRequest < Struct.new(
  :ciphertext_blob,
  :source_encryption_context,
  :source_key_id,
  :destination_key_id,
  :destination_encryption_context,
  :source_encryption_algorithm,
  :destination_encryption_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#source_key_idString

Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted.

Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the ReEncrypt operation throws an IncorrectKeyException.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

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

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

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Returns:

  • (String)


5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5256

class ReEncryptRequest < Struct.new(
  :ciphertext_blob,
  :source_encryption_context,
  :source_key_id,
  :destination_key_id,
  :destination_encryption_context,
  :source_encryption_algorithm,
  :destination_encryption_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end