public static interface GenerateDataKeyPairRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<GenerateDataKeyPairRequest.Builder,GenerateDataKeyPairRequest>
| Modifier and Type | Method and Description |
|---|---|
GenerateDataKeyPairRequest.Builder |
encryptionContext(Map<String,String> encryptionContext)
Specifies the encryption context that will be used when encrypting the private key in the data key pair.
|
GenerateDataKeyPairRequest.Builder |
grantTokens(Collection<String> grantTokens)
A list of grant tokens.
|
GenerateDataKeyPairRequest.Builder |
grantTokens(String... grantTokens)
A list of grant tokens.
|
GenerateDataKeyPairRequest.Builder |
keyId(String keyId)
Specifies the symmetric KMS key that encrypts the private key in the data key pair.
|
GenerateDataKeyPairRequest.Builder |
keyPairSpec(DataKeyPairSpec keyPairSpec)
Determines the type of data key pair that is generated.
|
GenerateDataKeyPairRequest.Builder |
keyPairSpec(String keyPairSpec)
Determines the type of data key pair that is generated.
|
GenerateDataKeyPairRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
GenerateDataKeyPairRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
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 KMS key, but it is highly 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 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 KMS key, but it is highly recommended.
For more information, see Encryption Context in the Key Management Service Developer Guide.
GenerateDataKeyPairRequest.Builder keyId(String keyId)
Specifies the symmetric KMS key that encrypts the private key in the data key pair. 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 KMS key that encrypts the private key in the data key pair. 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.
GenerateDataKeyPairRequest.Builder keyPairSpec(String keyPairSpec)
Determines the type of data key pair that is generated.
The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.
keyPairSpec - Determines the type of data key pair that is generated.
The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.
DataKeyPairSpec,
DataKeyPairSpecGenerateDataKeyPairRequest.Builder keyPairSpec(DataKeyPairSpec keyPairSpec)
Determines the type of data key pair that is generated.
The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.
keyPairSpec - Determines the type of data key pair that is generated.
The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.
DataKeyPairSpec,
DataKeyPairSpecGenerateDataKeyPairRequest.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.
GenerateDataKeyPairRequest.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.
GenerateDataKeyPairRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderGenerateDataKeyPairRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.