software.amazon.awssdk.services.kms.model

Class GenerateDataKeyPairWithoutPlaintextRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kms.model.KmsRequest

software.amazon.awssdk.services.kms.model.GenerateDataKeyPairWithoutPlaintextRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GenerateDataKeyPairWithoutPlaintextRequest.Builder,GenerateDataKeyPairWithoutPlaintextRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GenerateDataKeyPairWithoutPlaintextRequest
extends KmsRequest
implements ToCopyableBuilder<GenerateDataKeyPairWithoutPlaintextRequest.Builder,GenerateDataKeyPairWithoutPlaintextRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GenerateDataKeyPairWithoutPlaintextRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GenerateDataKeyPairWithoutPlaintextRequest.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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<String>	grantTokens() A list of grant tokens.
boolean	hasEncryptionContext() Returns true if the EncryptionContext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasGrantTokens() Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	keyId() Specifies the CMK 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 GenerateDataKeyPairWithoutPlaintextRequest.Builder>	serializableBuilderClass()
GenerateDataKeyPairWithoutPlaintextRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasEncryptionContext

public final boolean hasEncryptionContext()

Returns true if the EncryptionContext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

encryptionContext

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 CMK, but it is highly recommended.

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.

You can use hasEncryptionContext() to see if a value was sent in this field.

Returns:

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 CMK, but it is highly recommended.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

keyId

public final String keyId()

Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

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.

Returns:

Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

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.

keyPairSpec

public final DataKeyPairSpec keyPairSpec()

Determines the type of data key pair that is generated.

The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS 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().

Returns:

Determines the type of data key pair that is generated.

The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.

See Also:

DataKeyPairSpec

keyPairSpecAsString

public final String keyPairSpecAsString()

Determines the type of data key pair that is generated.

The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS 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().

Returns:

Determines the type of data key pair that is generated.

The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.

See Also:

DataKeyPairSpec

hasGrantTokens

public final boolean hasGrantTokens()

Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

grantTokens

public final 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.

You can use hasGrantTokens() to see if a value was sent in this field.

Returns:

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

toBuilder

public GenerateDataKeyPairWithoutPlaintextRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GenerateDataKeyPairWithoutPlaintextRequest.Builder,GenerateDataKeyPairWithoutPlaintextRequest>

Specified by:

toBuilder in class KmsRequest

builder

public static GenerateDataKeyPairWithoutPlaintextRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GenerateDataKeyPairWithoutPlaintextRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo