public static interface GenerateDataKeyRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<GenerateDataKeyRequest.Builder,GenerateDataKeyRequest>
| Modifier and Type | Method and Description |
|---|---|
GenerateDataKeyRequest.Builder |
dryRun(Boolean dryRun)
Checks if your request will succeed.
|
GenerateDataKeyRequest.Builder |
encryptionContext(Map<String,String> encryptionContext)
Specifies the encryption context that will be used when encrypting the data key.
|
GenerateDataKeyRequest.Builder |
grantTokens(Collection<String> grantTokens)
A list of grant tokens.
|
GenerateDataKeyRequest.Builder |
grantTokens(String... grantTokens)
A list of grant tokens.
|
GenerateDataKeyRequest.Builder |
keyId(String keyId)
Specifies the symmetric encryption KMS key that encrypts the data key.
|
GenerateDataKeyRequest.Builder |
keySpec(DataKeySpec keySpec)
Specifies the length of the data key.
|
GenerateDataKeyRequest.Builder |
keySpec(String keySpec)
Specifies the length of the data key.
|
GenerateDataKeyRequest.Builder |
numberOfBytes(Integer numberOfBytes)
Specifies the length of the data key in bytes.
|
GenerateDataKeyRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
GenerateDataKeyRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
default GenerateDataKeyRequest.Builder |
recipient(Consumer<RecipientInfo.Builder> recipient)
A signed
attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with
the enclave's public key.
|
GenerateDataKeyRequest.Builder |
recipient(RecipientInfo recipient)
A signed
attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with
the enclave's public key.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildGenerateDataKeyRequest.Builder keyId(String keyId)
Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your 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.
keyId - Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an
asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your 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.
GenerateDataKeyRequest.Builder encryptionContext(Map<String,String> encryptionContext)
Specifies the encryption context that will be used when encrypting the data key.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
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.
encryptionContext - Specifies the encryption context that will be used when encrypting the data key. Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
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.
GenerateDataKeyRequest.Builder numberOfBytes(Integer numberOfBytes)
Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key
(64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the KeySpec
parameter.
You must specify either the KeySpec or the NumberOfBytes parameter (but not both)
in every GenerateDataKey request.
numberOfBytes - Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit
data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the
KeySpec parameter.
You must specify either the KeySpec or the NumberOfBytes parameter (but not
both) in every GenerateDataKey request.
GenerateDataKeyRequest.Builder keySpec(String keySpec)
Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or
AES_256 to generate a 256-bit symmetric key.
You must specify either the KeySpec or the NumberOfBytes parameter (but not both)
in every GenerateDataKey request.
keySpec - Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or
AES_256 to generate a 256-bit symmetric key.
You must specify either the KeySpec or the NumberOfBytes parameter (but not
both) in every GenerateDataKey request.
DataKeySpec,
DataKeySpecGenerateDataKeyRequest.Builder keySpec(DataKeySpec keySpec)
Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or
AES_256 to generate a 256-bit symmetric key.
You must specify either the KeySpec or the NumberOfBytes parameter (but not both)
in every GenerateDataKey request.
keySpec - Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or
AES_256 to generate a 256-bit symmetric key.
You must specify either the KeySpec or the NumberOfBytes parameter (but not
both) in every GenerateDataKey request.
DataKeySpec,
DataKeySpecGenerateDataKeyRequest.Builder grantTokens(Collection<String> grantTokens)
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.
grantTokens - 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.
GenerateDataKeyRequest.Builder grantTokens(String... grantTokens)
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.
grantTokens - 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.
GenerateDataKeyRequest.Builder recipient(RecipientInfo recipient)
A signed
attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with
the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.
This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.
When you use this parameter, instead of returning the plaintext data key, KMS encrypts the plaintext data key
under the public key in the attestation document, and returns the resulting ciphertext in the
CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the
private key in the enclave. The CiphertextBlob field in the response contains a copy of the data
key encrypted under the KMS key specified by the KeyId parameter. The Plaintext
field in the response is null or empty.
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
recipient - A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to
use with the enclave's public key. The only valid encryption algorithm is
RSAES_OAEP_SHA_256.
This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.
When you use this parameter, instead of returning the plaintext data key, KMS encrypts the plaintext
data key under the public key in the attestation document, and returns the resulting ciphertext in the
CiphertextForRecipient field in the response. This ciphertext can be decrypted only with
the private key in the enclave. The CiphertextBlob field in the response contains a copy
of the data key encrypted under the KMS key specified by the KeyId parameter. The
Plaintext field in the response is null or empty.
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
default GenerateDataKeyRequest.Builder recipient(Consumer<RecipientInfo.Builder> recipient)
A signed
attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with
the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.
This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.
When you use this parameter, instead of returning the plaintext data key, KMS encrypts the plaintext data key
under the public key in the attestation document, and returns the resulting ciphertext in the
CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the
private key in the enclave. The CiphertextBlob field in the response contains a copy of the data
key encrypted under the KMS key specified by the KeyId parameter. The Plaintext
field in the response is null or empty.
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
This is a convenience method that creates an instance of theRecipientInfo.Builder avoiding the need
to create one manually via RecipientInfo.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to recipient(RecipientInfo).
recipient - a consumer that will call methods on RecipientInfo.Builderrecipient(RecipientInfo)GenerateDataKeyRequest.Builder dryRun(Boolean dryRun)
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.
dryRun - 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.
GenerateDataKeyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderGenerateDataKeyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.