@Generated(value="software.amazon.awssdk:codegen") public final class GenerateDataKeyPairRequest extends KmsRequest implements ToCopyableBuilder<GenerateDataKeyPairRequest.Builder,GenerateDataKeyPairRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GenerateDataKeyPairRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static GenerateDataKeyPairRequest.Builder |
builder() |
Map<String,String> |
encryptionContext()
Specifies the encryption context that will be used when encrypting the private key in the data key pair.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<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.
|
boolean |
hasEncryptionContext()
For responses, this returns true if the service returned a value for the EncryptionContext property.
|
boolean |
hasGrantTokens()
For responses, this returns true if the service returned a value for the GrantTokens property.
|
int |
hashCode() |
String |
keyId()
Specifies the symmetric KMS key that encrypts the private key in the data key pair.
|
DataKeyPairSpec |
keyPairSpec()
Determines the type of data key pair that is generated.
|
String |
keyPairSpecAsString()
Determines the type of data key pair that is generated.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GenerateDataKeyPairRequest.Builder> |
serializableBuilderClass() |
GenerateDataKeyPairRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic final boolean hasEncryptionContext()
isEmpty() 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.public final 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.
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.
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.
public final 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.
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.
public final 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.
If the service returns an enum value that is not available in the current SDK version, keyPairSpec will
return DataKeyPairSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
keyPairSpecAsString().
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.
DataKeyPairSpecpublic final String keyPairSpecAsString()
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.
If the service returns an enum value that is not available in the current SDK version, keyPairSpec will
return DataKeyPairSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
keyPairSpecAsString().
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.
DataKeyPairSpecpublic final boolean hasGrantTokens()
isEmpty() 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.public final List<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.
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.
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.
public GenerateDataKeyPairRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<GenerateDataKeyPairRequest.Builder,GenerateDataKeyPairRequest>toBuilder in class KmsRequestpublic static GenerateDataKeyPairRequest.Builder builder()
public static Class<? extends GenerateDataKeyPairRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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 SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.