@Generated(value="software.amazon.awssdk:codegen") public final class EncryptRequest extends KmsRequest implements ToCopyableBuilder<EncryptRequest.Builder,EncryptRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
EncryptRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static EncryptRequest.Builder |
builder() |
Map<String,String> |
encryptionContext()
Name-value pair that specifies the encryption context to be used for authenticated encryption.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
List<String> |
grantTokens()
A list of grant tokens.
|
int |
hashCode() |
String |
keyId()
A unique identifier for the customer master key (CMK).
|
SdkBytes |
plaintext()
Data to be encrypted.
|
static Class<? extends EncryptRequest.Builder> |
serializableBuilderClass() |
EncryptRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public 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.
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.
public SdkBytes plaintext()
Data to be encrypted.
public 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Decrypt
API or decryption will fail. For more
information, see Encryption
Context.public List<String> grantTokens()
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
public EncryptRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<EncryptRequest.Builder,EncryptRequest>
toBuilder
in class KmsRequest
public static EncryptRequest.Builder builder()
public static Class<? extends EncryptRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.