class Aws::KMS::Types::ReEncryptRequest

@see docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncryptRequest AWS API Documentation
@return [Boolean] : docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html permissions][1] in the *Key Management Service Developer Guide*.
To learn more about how to use this parameter, see [Testing your
parameter.
Checks if your request will succeed. ‘DryRun` is an optional
@!attribute [rw] dry_run
@return [Array<String>] : docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html [1]: docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token token][2] in the *Key Management Service Developer Guide*.
For more information, see [Grant token] and [Using a grant
from a new grant that has not yet achieved *eventual consistency*.
Use a grant token when your permission to call this operation comes
A list of grant tokens.
@!attribute [rw] grant_tokens
@return [String]
asymmetric KMS key.
This parameter is required only when the destination KMS key is an
symmetric encryption KMS keys.
`SYMMETRIC_DEFAULT`, represents the encryption algorithm used for
data after it has decrypted it. The default value,
Specifies the encryption algorithm that KMS will use to reecrypt the
@!attribute [rw] destination_encryption_algorithm
@return [String]
under an asymmetric KMS key.
This parameter is required only when the ciphertext was encrypted
If you specify a different algorithm, the decrypt attempt fails.
Specify the same algorithm that was used to encrypt the ciphertext.
encryption KMS keys.
`SYMMETRIC_DEFAULT`, represents the algorithm used for symmetric
ciphertext before it is reencrypted. The default value,
Specifies the encryption algorithm that KMS will use to decrypt the
@!attribute [rw] source_encryption_algorithm
@return [Hash<String,String>] : docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html Management Service Developer Guide*.
For more information, see [Encryption context] in the *Key
recommended.
keys, an encryption context is optional, but it is strongly
encryption KMS keys. On operations with symmetric encryption KMS
An encryption context is supported only on operations with symmetric
exact case-sensitive match) encryption context to decrypt the data.
encryption context to encrypt data, you must specify the same (an
pairs that represent additional authenticated data. When you use an
An *encryption context* is a collection of non-secret key-value
format for asymmetric KMS keys does not include fields for metadata.
KMS key is a symmetric encryption KMS key. The standard ciphertext
A destination encryption context is valid only when the destination
other output.
This field may be displayed in plaintext in CloudTrail logs and
Do not include confidential or sensitive information in this field.
data.
Specifies that encryption context to use when the reencrypting the
@!attribute [rw] destination_encryption_context
@return [String]
DescribeKey. To get the alias name and alias ARN, use ListAliases.
To get the key ID and key ARN for a KMS key, use ListKeys or
* Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
* Alias name: `alias/ExampleAlias`
`arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
* Key ARN:
* Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
For example:
the key ARN or alias ARN.
a KMS key in a different Amazon Web Services account, you must use
ARN. When using an alias name, prefix it with `“alias/”`. To specify
To specify a KMS key, use its key ID, key ARN, alias name, or alias
`KeyUsage` value of a KMS key, use the DescribeKey operation.
key with a `KeyUsage` value of `ENCRYPT_DECRYPT`. To find the
data. Specify a symmetric encryption KMS key or an asymmetric KMS
A unique identifier for the KMS key that is used to reencrypt the
@!attribute [rw] destination_key_id
@return [String]
DescribeKey. To get the alias name and alias ARN, use ListAliases.
To get the key ID and key ARN for a KMS key, use ListKeys or
* Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
* Alias name: `alias/ExampleAlias`
`arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
* Key ARN:
* Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
For example:
the key ARN or alias ARN.
a KMS key in a different Amazon Web Services account, you must use
ARN. When using an alias name, prefix it with `“alias/”`. To specify
To specify a KMS key, use its key ID, key ARN, alias name, or alias
you intend.
best practice. This practice ensures that you use the KMS key that
symmetric ciphertext blob. However, it is always recommended as a
key, KMS can get the KMS key from metadata that it adds to the
under an asymmetric KMS key. If you used a symmetric encryption KMS
This parameter is required only when the ciphertext was encrypted
operation throws an `IncorrectKeyException`.
ciphertext. If you identify a different KMS key, the `ReEncrypt`
Enter a key ID of the KMS key that was used to encrypt the
before it is re-encrypted.
Specifies the KMS key that KMS will use to decrypt the ciphertext
@!attribute [rw] source_key_id
@return [Hash<String,String>] : docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html Management Service Developer Guide*.
For more information, see [Encryption context] in the *Key
recommended.
keys, an encryption context is optional, but it is strongly
encryption KMS keys. On operations with symmetric encryption KMS
An encryption context is supported only on operations with symmetric
exact case-sensitive match) encryption context to decrypt the data.
encryption context to encrypt data, you must specify the same (an
pairs that represent additional authenticated data. When you use an
An *encryption context* is a collection of non-secret key-value
ciphertext.
Enter the same encryption context that was used to encrypt the
Specifies the encryption context to use to decrypt the ciphertext.
@!attribute [rw] source_encryption_context
@return [String]
Ciphertext of the data to reencrypt.
@!attribute [rw] ciphertext_blob

class Aws::KMS::Types::ReEncryptRequest

Namespace

Included Modules

Defined in