com.amazonaws.services.kms.model

Class DeriveSharedSecretResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.kms.model.DeriveSharedSecretResult

All Implemented Interfaces:

Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeriveSharedSecretResult()

Method Summary

Modifier and Type	Method and Description
DeriveSharedSecretResult	clone()
boolean	equals(Object obj)
ByteBuffer	getCiphertextForRecipient() The plaintext shared secret encrypted with the public key in the attestation document.
String	getKeyAgreementAlgorithm() Identifies the key agreement algorithm used to derive the shared secret.
String	getKeyId() Identifies the KMS key used to derive the shared secret.
String	getKeyOrigin() The source of the key material for the specified KMS key.
ByteBuffer	getSharedSecret() The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.
int	hashCode()
void	setCiphertextForRecipient(ByteBuffer ciphertextForRecipient) The plaintext shared secret encrypted with the public key in the attestation document.
void	setKeyAgreementAlgorithm(String keyAgreementAlgorithm) Identifies the key agreement algorithm used to derive the shared secret.
void	setKeyId(String keyId) Identifies the KMS key used to derive the shared secret.
void	setKeyOrigin(String keyOrigin) The source of the key material for the specified KMS key.
void	setSharedSecret(ByteBuffer sharedSecret) The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.
String	toString() Returns a string representation of this object.
DeriveSharedSecretResult	withCiphertextForRecipient(ByteBuffer ciphertextForRecipient) The plaintext shared secret encrypted with the public key in the attestation document.
DeriveSharedSecretResult	withKeyAgreementAlgorithm(KeyAgreementAlgorithmSpec keyAgreementAlgorithm) Identifies the key agreement algorithm used to derive the shared secret.
DeriveSharedSecretResult	withKeyAgreementAlgorithm(String keyAgreementAlgorithm) Identifies the key agreement algorithm used to derive the shared secret.
DeriveSharedSecretResult	withKeyId(String keyId) Identifies the KMS key used to derive the shared secret.
DeriveSharedSecretResult	withKeyOrigin(OriginType keyOrigin) The source of the key material for the specified KMS key.
DeriveSharedSecretResult	withKeyOrigin(String keyOrigin) The source of the key material for the specified KMS key.
DeriveSharedSecretResult	withSharedSecret(ByteBuffer sharedSecret) The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

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

DeriveSharedSecretResult

public DeriveSharedSecretResult()

Method Detail

setKeyId

public void setKeyId(String keyId)

Identifies the KMS key used to derive the shared secret.

Parameters:

keyId - Identifies the KMS key used to derive the shared secret.

getKeyId

public String getKeyId()

Identifies the KMS key used to derive the shared secret.

Returns:

Identifies the KMS key used to derive the shared secret.

withKeyId

public DeriveSharedSecretResult withKeyId(String keyId)

Identifies the KMS key used to derive the shared secret.

Parameters:

keyId - Identifies the KMS key used to derive the shared secret.

Returns:

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

setSharedSecret

public void setSharedSecret(ByteBuffer sharedSecret)

The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

If the response includes the CiphertextForRecipient field, the SharedSecret field is null or empty.

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:

sharedSecret - The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

If the response includes the CiphertextForRecipient field, the SharedSecret field is null or empty.

getSharedSecret

public ByteBuffer getSharedSecret()

The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

If the response includes the CiphertextForRecipient field, the SharedSecret field is null or empty.

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 raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

If the response includes the CiphertextForRecipient field, the SharedSecret field is null or empty.

withSharedSecret

public DeriveSharedSecretResult withSharedSecret(ByteBuffer sharedSecret)

The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

If the response includes the CiphertextForRecipient field, the SharedSecret field is null or empty.

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:

sharedSecret - The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

If the response includes the CiphertextForRecipient field, the SharedSecret field is null or empty.

Returns:

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

setCiphertextForRecipient

public void setCiphertextForRecipient(ByteBuffer ciphertextForRecipient)

The plaintext shared secret encrypted with the public key in the attestation document.

This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. 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.

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:

ciphertextForRecipient - The plaintext shared secret encrypted with the public key in the attestation document.

This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. 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.

getCiphertextForRecipient

public ByteBuffer getCiphertextForRecipient()

The plaintext shared secret encrypted with the public key in the attestation document.

This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. 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.

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 plaintext shared secret encrypted with the public key in the attestation document.

This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. 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.

withCiphertextForRecipient

public DeriveSharedSecretResult withCiphertextForRecipient(ByteBuffer ciphertextForRecipient)

The plaintext shared secret encrypted with the public key in the attestation document.

This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. 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.

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:

ciphertextForRecipient - The plaintext shared secret encrypted with the public key in the attestation document.

This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. 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:

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

setKeyAgreementAlgorithm

public void setKeyAgreementAlgorithm(String keyAgreementAlgorithm)

Identifies the key agreement algorithm used to derive the shared secret.

Parameters:

keyAgreementAlgorithm - Identifies the key agreement algorithm used to derive the shared secret.

See Also:

KeyAgreementAlgorithmSpec

getKeyAgreementAlgorithm

public String getKeyAgreementAlgorithm()

Identifies the key agreement algorithm used to derive the shared secret.

Returns:

Identifies the key agreement algorithm used to derive the shared secret.

See Also:

KeyAgreementAlgorithmSpec

withKeyAgreementAlgorithm

public DeriveSharedSecretResult withKeyAgreementAlgorithm(String keyAgreementAlgorithm)

Identifies the key agreement algorithm used to derive the shared secret.

Parameters:

keyAgreementAlgorithm - Identifies the key agreement algorithm used to derive the shared secret.

Returns:

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

See Also:

KeyAgreementAlgorithmSpec

withKeyAgreementAlgorithm

public DeriveSharedSecretResult withKeyAgreementAlgorithm(KeyAgreementAlgorithmSpec keyAgreementAlgorithm)

Identifies the key agreement algorithm used to derive the shared secret.

Parameters:

keyAgreementAlgorithm - Identifies the key agreement algorithm used to derive the shared secret.

Returns:

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

See Also:

KeyAgreementAlgorithmSpec

setKeyOrigin

public void setKeyOrigin(String keyOrigin)

The source of the key material for the specified KMS key.

When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

Parameters:

keyOrigin - The source of the key material for the specified KMS key.

When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

See Also:

OriginType

getKeyOrigin

public String getKeyOrigin()

The source of the key material for the specified KMS key.

When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

Returns:

The source of the key material for the specified KMS key.

When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

See Also:

OriginType

withKeyOrigin

public DeriveSharedSecretResult withKeyOrigin(String keyOrigin)

The source of the key material for the specified KMS key.

When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

Parameters:

keyOrigin - The source of the key material for the specified KMS key.

When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

Returns:

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

See Also:

OriginType

withKeyOrigin

public DeriveSharedSecretResult withKeyOrigin(OriginType keyOrigin)

The source of the key material for the specified KMS key.

When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

Parameters:

keyOrigin - The source of the key material for the specified KMS key.

When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

Returns:

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

See Also:

OriginType

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 DeriveSharedSecretResult clone()

Overrides:

clone in class Object