public static interface EncryptRequest.Builder extends KMSRequest.Builder, CopyableBuilder<EncryptRequest.Builder,EncryptRequest>
Modifier and Type | Method and Description |
---|---|
EncryptRequest.Builder |
encryptionContext(Map<String,String> encryptionContext)
Name-value pair that specifies the encryption context to be used for authenticated encryption.
|
EncryptRequest.Builder |
grantTokens(Collection<String> grantTokens)
A list of grant tokens.
|
EncryptRequest.Builder |
grantTokens(String... grantTokens)
A list of grant tokens.
|
EncryptRequest.Builder |
keyId(String keyId)
A unique identifier for the customer master key (CMK).
|
EncryptRequest.Builder |
plaintext(ByteBuffer plaintext)
Data to be encrypted.
|
EncryptRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
EncryptRequest.Builder keyId(String keyId)
A unique identifier for the customer master key (CMK).
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
- A unique identifier for the customer master key (CMK).
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.
EncryptRequest.Builder plaintext(ByteBuffer plaintext)
Data to be encrypted.
To preserve immutability, the remaining bytes in the provided buffer will be copied into a new buffer when set.
plaintext
- Data to be encrypted.EncryptRequest.Builder encryptionContext(Map<String,String> encryptionContext)
Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here,
the same value must be supplied to the Decrypt
API or decryption will fail. For more
information, see Encryption Context.
encryptionContext
- Name-value pair that specifies the encryption context to be used for authenticated encryption. If used
here, the same value must be supplied to the Decrypt
API or decryption will fail. For
more information, see Encryption
Context.EncryptRequest.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.
EncryptRequest.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.
EncryptRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.