com.amazonaws.services.kms.model

Class GenerateDataKeyPairWithoutPlaintextResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.kms.model.GenerateDataKeyPairWithoutPlaintextResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GenerateDataKeyPairWithoutPlaintextResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GenerateDataKeyPairWithoutPlaintextResult()

Method Summary

Modifier and Type	Method and Description
GenerateDataKeyPairWithoutPlaintextResult	clone()
boolean	equals(Object obj)
String	getKeyId() Specifies the CMK that encrypted the private key in the data key pair.
String	getKeyPairSpec() The type of data key pair that was generated.
ByteBuffer	getPrivateKeyCiphertextBlob() The encrypted copy of the private key.
ByteBuffer	getPublicKey() The public key (in plaintext).
int	hashCode()
void	setKeyId(String keyId) Specifies the CMK that encrypted the private key in the data key pair.
void	setKeyPairSpec(String keyPairSpec) The type of data key pair that was generated.
void	setPrivateKeyCiphertextBlob(ByteBuffer privateKeyCiphertextBlob) The encrypted copy of the private key.
void	setPublicKey(ByteBuffer publicKey) The public key (in plaintext).
String	toString() Returns a string representation of this object.
GenerateDataKeyPairWithoutPlaintextResult	withKeyId(String keyId) Specifies the CMK that encrypted the private key in the data key pair.
GenerateDataKeyPairWithoutPlaintextResult	withKeyPairSpec(DataKeyPairSpec keyPairSpec) The type of data key pair that was generated.
GenerateDataKeyPairWithoutPlaintextResult	withKeyPairSpec(String keyPairSpec) The type of data key pair that was generated.
GenerateDataKeyPairWithoutPlaintextResult	withPrivateKeyCiphertextBlob(ByteBuffer privateKeyCiphertextBlob) The encrypted copy of the private key.
GenerateDataKeyPairWithoutPlaintextResult	withPublicKey(ByteBuffer publicKey) The public key (in plaintext).

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GenerateDataKeyPairWithoutPlaintextResult

public GenerateDataKeyPairWithoutPlaintextResult()

Method Detail

setPrivateKeyCiphertextBlob

public void setPrivateKeyCiphertextBlob(ByteBuffer privateKeyCiphertextBlob)

The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

privateKeyCiphertextBlob - The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

getPrivateKeyCiphertextBlob

public ByteBuffer getPrivateKeyCiphertextBlob()

The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

Returns:

The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

withPrivateKeyCiphertextBlob

public GenerateDataKeyPairWithoutPlaintextResult withPrivateKeyCiphertextBlob(ByteBuffer privateKeyCiphertextBlob)

The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

privateKeyCiphertextBlob - The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Returns:

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

setPublicKey

public void setPublicKey(ByteBuffer publicKey)

The public key (in plaintext).

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

publicKey - The public key (in plaintext).

getPublicKey

public ByteBuffer getPublicKey()

The public key (in plaintext).

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

Returns:

The public key (in plaintext).

withPublicKey

public GenerateDataKeyPairWithoutPlaintextResult withPublicKey(ByteBuffer publicKey)

The public key (in plaintext).

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

publicKey - The public key (in plaintext).

Returns:

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

setKeyId

public void setKeyId(String keyId)

Specifies the CMK that encrypted the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type 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/".

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.

Parameters:

keyId - Specifies the CMK that encrypted the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type 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/".

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.

getKeyId

public String getKeyId()

Specifies the CMK that encrypted the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type 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/".

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 encrypted the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type 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/".

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.

withKeyId

public GenerateDataKeyPairWithoutPlaintextResult withKeyId(String keyId)

Specifies the CMK that encrypted the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type 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/".

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.

Parameters:

keyId - Specifies the CMK that encrypted the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type 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/".

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:

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

setKeyPairSpec

public void setKeyPairSpec(String keyPairSpec)

The type of data key pair that was generated.

Parameters:

keyPairSpec - The type of data key pair that was generated.

See Also:

DataKeyPairSpec

getKeyPairSpec

public String getKeyPairSpec()

The type of data key pair that was generated.

Returns:

The type of data key pair that was generated.

See Also:

DataKeyPairSpec

withKeyPairSpec

public GenerateDataKeyPairWithoutPlaintextResult withKeyPairSpec(String keyPairSpec)

The type of data key pair that was generated.

Parameters:

keyPairSpec - The type of data key pair that was generated.

Returns:

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

See Also:

DataKeyPairSpec

withKeyPairSpec

public GenerateDataKeyPairWithoutPlaintextResult withKeyPairSpec(DataKeyPairSpec keyPairSpec)

The type of data key pair that was generated.

Parameters:

keyPairSpec - The type of data key pair that was generated.

Returns:

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

See Also:

DataKeyPairSpec

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GenerateDataKeyPairWithoutPlaintextResult clone()

Overrides:

clone in class Object