@Generated(value="software.amazon.awssdk:codegen") public final class GenerateDataKeyWithoutPlaintextRequest extends KmsRequest implements ToCopyableBuilder<GenerateDataKeyWithoutPlaintextRequest.Builder,GenerateDataKeyWithoutPlaintextRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
GenerateDataKeyWithoutPlaintextRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static GenerateDataKeyWithoutPlaintextRequest.Builder |
builder() |
Map<String,String> |
encryptionContext()
A set of key-value pairs that represents additional authenticated data.
|
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()
The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption key.
|
DataKeySpec |
keySpec()
The length of the data encryption key.
|
String |
keySpecAsString()
The length of the data encryption key.
|
Integer |
numberOfBytes()
The length of the data encryption key in bytes.
|
static Class<? extends GenerateDataKeyWithoutPlaintextRequest.Builder> |
serializableBuilderClass() |
GenerateDataKeyWithoutPlaintextRequest.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()
The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption key.
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 Map<String,String> encryptionContext()
A set of key-value pairs that represents additional authenticated data.
For more information, see Encryption Context 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 Encryption Context in the AWS Key Management Service Developer Guide.
public DataKeySpec keySpec()
The length of the data encryption key. Use AES_128
to generate a 128-bit symmetric key, or
AES_256
to generate a 256-bit symmetric key.
If the service returns an enum value that is not available in the current SDK version, keySpec
will
return DataKeySpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
keySpecAsString()
.
AES_128
to generate a 128-bit symmetric key, or
AES_256
to generate a 256-bit symmetric key.DataKeySpec
public String keySpecAsString()
The length of the data encryption key. Use AES_128
to generate a 128-bit symmetric key, or
AES_256
to generate a 256-bit symmetric key.
If the service returns an enum value that is not available in the current SDK version, keySpec
will
return DataKeySpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
keySpecAsString()
.
AES_128
to generate a 128-bit symmetric key, or
AES_256
to generate a 256-bit symmetric key.DataKeySpec
public Integer numberOfBytes()
The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64
bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the
KeySpec
field instead of this one.
KeySpec
field instead of this one.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 GenerateDataKeyWithoutPlaintextRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GenerateDataKeyWithoutPlaintextRequest.Builder,GenerateDataKeyWithoutPlaintextRequest>
toBuilder
in class KmsRequest
public static GenerateDataKeyWithoutPlaintextRequest.Builder builder()
public static Class<? extends GenerateDataKeyWithoutPlaintextRequest.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.