@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DeriveSharedSecretResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
DeriveSharedSecretResult() |
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.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setKeyId(String keyId)
Identifies the KMS key used to derive the shared secret.
keyId
- Identifies the KMS key used to derive the shared secret.public String getKeyId()
Identifies the KMS key used to derive the shared secret.
public DeriveSharedSecretResult withKeyId(String keyId)
Identifies the KMS key used to derive the shared secret.
keyId
- Identifies the KMS key used to derive the shared secret.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.
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.
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.
ByteBuffer
s 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
.
If the response includes the CiphertextForRecipient
field, the SharedSecret
field is null or empty.
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.
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.
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.
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.
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.
ByteBuffer
s 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
.
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.
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.
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.
public void setKeyAgreementAlgorithm(String keyAgreementAlgorithm)
Identifies the key agreement algorithm used to derive the shared secret.
keyAgreementAlgorithm
- Identifies the key agreement algorithm used to derive the shared secret.KeyAgreementAlgorithmSpec
public String getKeyAgreementAlgorithm()
Identifies the key agreement algorithm used to derive the shared secret.
KeyAgreementAlgorithmSpec
public DeriveSharedSecretResult withKeyAgreementAlgorithm(String keyAgreementAlgorithm)
Identifies the key agreement algorithm used to derive the shared secret.
keyAgreementAlgorithm
- Identifies the key agreement algorithm used to derive the shared secret.KeyAgreementAlgorithmSpec
public DeriveSharedSecretResult withKeyAgreementAlgorithm(KeyAgreementAlgorithmSpec keyAgreementAlgorithm)
Identifies the key agreement algorithm used to derive the shared secret.
keyAgreementAlgorithm
- Identifies the key agreement algorithm used to derive the shared secret.KeyAgreementAlgorithmSpec
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
.
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
.
OriginType
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
.
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
.
OriginType
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
.
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
.
OriginType
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
.
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
.
OriginType
public String toString()
toString
in class Object
Object.toString()
public DeriveSharedSecretResult clone()