public static interface GenerateDataKeyPairRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<GenerateDataKeyPairRequest.Builder,GenerateDataKeyPairRequest>
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildGenerateDataKeyPairRequest.Builder encryptionContext(Map<String,String> encryptionContext)
Specifies the encryption context that will be used when encrypting the private key in the data key pair.
An encryption context is a collection of non-secret key-value pairs that represents 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 optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
encryptionContext - Specifies the encryption context that will be used when encrypting the private key in the data key
pair.
An encryption context is a collection of non-secret key-value pairs that represents 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 optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
GenerateDataKeyPairRequest.Builder keyId(String keyId)
Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot specify an asymmetric CMKs.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias
name, prefix it with "alias/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
keyId - Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot specify an
asymmetric CMKs.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an
alias name, prefix it with "alias/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
GenerateDataKeyPairRequest.Builder keyPairSpec(String keyPairSpec)
Determines the type of data key pair that is generated.
The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.
keyPairSpec - Determines the type of data key pair that is generated.
The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.
DataKeyPairSpec,
DataKeyPairSpecGenerateDataKeyPairRequest.Builder keyPairSpec(DataKeyPairSpec keyPairSpec)
Determines the type of data key pair that is generated.
The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.
keyPairSpec - Determines the type of data key pair that is generated.
The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.
DataKeyPairSpec,
DataKeyPairSpecGenerateDataKeyPairRequest.Builder grantTokens(Collection<String> grantTokens)
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
grantTokens - A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
GenerateDataKeyPairRequest.Builder grantTokens(String... grantTokens)
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
grantTokens - A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
GenerateDataKeyPairRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderGenerateDataKeyPairRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2020. All rights reserved.