Class GenerateDataKeyRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GenerateDataKeyRequest.Builder,
GenerateDataKeyRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Boolean
dryRun()
Checks if your request will succeed.Specifies the encryption context that will be used when encrypting the data key.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.A list of grant tokens.final boolean
For responses, this returns true if the service returned a value for the EncryptionContext property.final boolean
For responses, this returns true if the service returned a value for the GrantTokens property.final int
hashCode()
final String
keyId()
Specifies the symmetric encryption KMS key that encrypts the data key.final DataKeySpec
keySpec()
Specifies the length of the data key.final String
Specifies the length of the data key.final Integer
Specifies the length of the data key in bytes.final RecipientInfo
A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key.static Class
<? extends GenerateDataKeyRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
keyId
Specifies the symmetric encryption KMS key that encrypts the data key. 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.
- Returns:
- Specifies the symmetric encryption KMS key that encrypts the data key. 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.
-
-
-
hasEncryptionContext
public final boolean hasEncryptionContext()For responses, this returns true if the service returned a value for the EncryptionContext property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
encryptionContext
Specifies the encryption context that will be used when encrypting the data key.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
An encryption context is a collection of non-secret key-value pairs that represent 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 supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.
For more information, see Encryption context in the Key Management Service Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasEncryptionContext()
method.- Returns:
- Specifies the encryption context that will be used when encrypting the data key.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
An encryption context is a collection of non-secret key-value pairs that represent 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 supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.
For more information, see Encryption context in the Key Management Service Developer Guide.
-
numberOfBytes
Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the
KeySpec
parameter.You must specify either the
KeySpec
or theNumberOfBytes
parameter (but not both) in everyGenerateDataKey
request.- Returns:
- Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data
key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the
KeySpec
parameter.You must specify either the
KeySpec
or theNumberOfBytes
parameter (but not both) in everyGenerateDataKey
request.
-
keySpec
Specifies the length of the data key. Use
AES_128
to generate a 128-bit symmetric key, orAES_256
to generate a 256-bit symmetric key.You must specify either the
KeySpec
or theNumberOfBytes
parameter (but not both) in everyGenerateDataKey
request.If the service returns an enum value that is not available in the current SDK version,
keySpec
will returnDataKeySpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeySpecAsString()
.- Returns:
- Specifies the length of the data key. Use
AES_128
to generate a 128-bit symmetric key, orAES_256
to generate a 256-bit symmetric key.You must specify either the
KeySpec
or theNumberOfBytes
parameter (but not both) in everyGenerateDataKey
request. - See Also:
-
keySpecAsString
Specifies the length of the data key. Use
AES_128
to generate a 128-bit symmetric key, orAES_256
to generate a 256-bit symmetric key.You must specify either the
KeySpec
or theNumberOfBytes
parameter (but not both) in everyGenerateDataKey
request.If the service returns an enum value that is not available in the current SDK version,
keySpec
will returnDataKeySpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeySpecAsString()
.- Returns:
- Specifies the length of the data key. Use
AES_128
to generate a 128-bit symmetric key, orAES_256
to generate a 256-bit symmetric key.You must specify either the
KeySpec
or theNumberOfBytes
parameter (but not both) in everyGenerateDataKey
request. - See Also:
-
hasGrantTokens
public final boolean hasGrantTokens()For responses, this returns true if the service returned a value for the GrantTokens property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasGrantTokens()
method.- Returns:
- 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.
-
recipient
A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is
RSAES_OAEP_SHA_256
.This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.
When you use this parameter, instead of returning the plaintext data key, KMS encrypts the plaintext data key under the public key in the attestation document, and returns the resulting ciphertext in the
CiphertextForRecipient
field in the response. This ciphertext can be decrypted only with the private key in the enclave. TheCiphertextBlob
field in the response contains a copy of the data key encrypted under the KMS key specified by theKeyId
parameter. ThePlaintext
field in the response is null or empty.For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
- Returns:
- A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use
with the enclave's public key. The only valid encryption algorithm is
RSAES_OAEP_SHA_256
.This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.
When you use this parameter, instead of returning the plaintext data key, KMS encrypts the plaintext data key under the public key in the attestation document, and returns the resulting ciphertext in the
CiphertextForRecipient
field in the response. This ciphertext can be decrypted only with the private key in the enclave. TheCiphertextBlob
field in the response contains a copy of the data key encrypted under the KMS key specified by theKeyId
parameter. ThePlaintext
field in the response is null or empty.For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
-
dryRun
Checks if your request will succeed.
DryRun
is an optional parameter.To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
- Returns:
- Checks if your request will succeed.
DryRun
is an optional parameter.To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GenerateDataKeyRequest.Builder,
GenerateDataKeyRequest> - Specified by:
toBuilder
in classKmsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-