com.amazonaws.services.kms.model

Class GenerateDataKeyWithoutPlaintextRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.GenerateDataKeyWithoutPlaintextRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class GenerateDataKeyWithoutPlaintextRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the GenerateDataKeyWithoutPlaintext operation.

Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like GenerateDataKey. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key.

See Also:

AWSKMS.generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GenerateDataKeyWithoutPlaintextRequest()

Method Summary

Methods

Modifier and Type	Method and Description
GenerateDataKeyWithoutPlaintextRequest	addEncryptionContextEntry(String key, String value) Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
GenerateDataKeyWithoutPlaintextRequest	clearEncryptionContextEntries() Removes all the entries added into EncryptionContext.
GenerateDataKeyWithoutPlaintextRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Map<String,String>	getEncryptionContext() Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
List<String>	getGrantTokens() For more information, see Grant Tokens.
String	getKeyId() A unique identifier for the customer master key.
String	getKeySpec() Value that identifies the encryption algorithm and key size.
Integer	getNumberOfBytes() Integer that contains the number of bytes to generate.
int	hashCode()
void	setEncryptionContext(Map<String,String> encryptionContext) Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
void	setGrantTokens(Collection<String> grantTokens) For more information, see Grant Tokens.
void	setKeyId(String keyId) A unique identifier for the customer master key.
void	setKeySpec(DataKeySpec keySpec) Value that identifies the encryption algorithm and key size.
void	setKeySpec(String keySpec) Value that identifies the encryption algorithm and key size.
void	setNumberOfBytes(Integer numberOfBytes) Integer that contains the number of bytes to generate.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GenerateDataKeyWithoutPlaintextRequest	withEncryptionContext(Map<String,String> encryptionContext) Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
GenerateDataKeyWithoutPlaintextRequest	withGrantTokens(Collection<String> grantTokens) For more information, see Grant Tokens.
GenerateDataKeyWithoutPlaintextRequest	withGrantTokens(String... grantTokens) For more information, see Grant Tokens.
GenerateDataKeyWithoutPlaintextRequest	withKeyId(String keyId) A unique identifier for the customer master key.
GenerateDataKeyWithoutPlaintextRequest	withKeySpec(DataKeySpec keySpec) Value that identifies the encryption algorithm and key size.
GenerateDataKeyWithoutPlaintextRequest	withKeySpec(String keySpec) Value that identifies the encryption algorithm and key size.
GenerateDataKeyWithoutPlaintextRequest	withNumberOfBytes(Integer numberOfBytes) Integer that contains the number of bytes to generate.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerateDataKeyWithoutPlaintextRequest

public GenerateDataKeyWithoutPlaintextRequest()

Method Detail

getKeyId

public String getKeyId()

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
• Alias Name Example - alias/MyAliasName

Constraints:
Length: 1 - 256

Returns:

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
• Alias Name Example - alias/MyAliasName

setKeyId

public void setKeyId(String keyId)

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
• Alias Name Example - alias/MyAliasName

Constraints:
Length: 1 - 256

Parameters:

keyId - A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
• Alias Name Example - alias/MyAliasName

withKeyId

public GenerateDataKeyWithoutPlaintextRequest withKeyId(String keyId)

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
• Alias Name Example - alias/MyAliasName

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

Parameters:

keyId - A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
• Alias Name Example - alias/MyAliasName

Returns:

A reference to this updated object so that method calls can be chained together.

getEncryptionContext

public Map<String,String> getEncryptionContext()

Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.

Returns:

Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.

setEncryptionContext

public void setEncryptionContext(Map<String,String> encryptionContext)

Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.

Parameters:

encryptionContext - Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.

withEncryptionContext

public GenerateDataKeyWithoutPlaintextRequest withEncryptionContext(Map<String,String> encryptionContext)

Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

encryptionContext - Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.

Returns:

A reference to this updated object so that method calls can be chained together.

addEncryptionContextEntry

public GenerateDataKeyWithoutPlaintextRequest addEncryptionContextEntry(String key,
                                                               String value)

Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.

The method adds a new key-value pair into EncryptionContext parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into EncryptionContext.

value - The corresponding value of the entry to be added into EncryptionContext.

clearEncryptionContextEntries

public GenerateDataKeyWithoutPlaintextRequest clearEncryptionContextEntries()

Removes all the entries added into EncryptionContext.

Returns a reference to this object so that method calls can be chained together.

getKeySpec

public String getKeySpec()

Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.

Constraints:
Allowed Values: AES_256, AES_128

Returns:

Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.

See Also:

DataKeySpec

setKeySpec

public void setKeySpec(String keySpec)

Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.

Constraints:
Allowed Values: AES_256, AES_128

Parameters:

keySpec - Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.

See Also:

DataKeySpec

withKeySpec

public GenerateDataKeyWithoutPlaintextRequest withKeySpec(String keySpec)

Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: AES_256, AES_128

Parameters:

keySpec - Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

DataKeySpec

setKeySpec

public void setKeySpec(DataKeySpec keySpec)

Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.

Constraints:
Allowed Values: AES_256, AES_128

Parameters:

keySpec - Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.

See Also:

DataKeySpec

withKeySpec

public GenerateDataKeyWithoutPlaintextRequest withKeySpec(DataKeySpec keySpec)

Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: AES_256, AES_128

Parameters:

keySpec - Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

DataKeySpec

getNumberOfBytes

public Integer getNumberOfBytes()

Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the KeySpec parameter instead.

Constraints:
Range: 1 - 1024

Returns:

Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the KeySpec parameter instead.

setNumberOfBytes

public void setNumberOfBytes(Integer numberOfBytes)

Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the KeySpec parameter instead.

Constraints:
Range: 1 - 1024

Parameters:

numberOfBytes - Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the KeySpec parameter instead.

withNumberOfBytes

public GenerateDataKeyWithoutPlaintextRequest withNumberOfBytes(Integer numberOfBytes)

Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the KeySpec parameter instead.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 1024

Parameters:

numberOfBytes - Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the KeySpec parameter instead.

Returns:

A reference to this updated object so that method calls can be chained together.

getGrantTokens

public List<String> getGrantTokens()

For more information, see Grant Tokens.

Constraints:
Length: 0 - 10

Returns:

For more information, see Grant Tokens.

setGrantTokens

public void setGrantTokens(Collection<String> grantTokens)

For more information, see Grant Tokens.

Constraints:
Length: 0 - 10

Parameters:

grantTokens - For more information, see Grant Tokens.

withGrantTokens

public GenerateDataKeyWithoutPlaintextRequest withGrantTokens(String... grantTokens)

For more information, see Grant Tokens.

NOTE: This method appends the values to the existing list (if any). Use setGrantTokens(java.util.Collection) or withGrantTokens(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 10

Parameters:

grantTokens - For more information, see Grant Tokens.

Returns:

A reference to this updated object so that method calls can be chained together.

withGrantTokens

public GenerateDataKeyWithoutPlaintextRequest withGrantTokens(Collection<String> grantTokens)

For more information, see Grant Tokens.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 10

Parameters:

grantTokens - For more information, see Grant Tokens.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public GenerateDataKeyWithoutPlaintextRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()