com.amazonaws.services.kms.model.DeriveSharedSecretRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kms.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DeriveSharedSecretRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Identifies an asymmetric NIST-recommended ECC or SM2 (China Regions only) KMS key. KMS uses the private key in
* the specified key pair to derive the shared secret. The key usage of the KMS key must be
* KEY_AGREEMENT. To find the KeyUsage of a KMS key, use the DescribeKey operation.
*
*
* To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with
* "alias/". To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and
* alias ARN, use ListAliases.
*
*/
private String keyId;
/**
*
* Specifies the key agreement algorithm used to derive the shared secret. The only valid value is ECDH
* .
*
*/
private String keyAgreementAlgorithm;
/**
*
* Specifies the public key in your peer's NIST-recommended elliptic curve (ECC) or SM2 (China Regions only) key
* pair.
*
*
* The public key must be a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as
* defined in RFC 5280.
*
*
* GetPublicKey returns the public key of an asymmetric KMS key pair in the required DER-encoded format.
*
*
*
* If you use Amazon Web Services CLI
* version 1, you must provide the DER-encoded X.509 public key in a file. Otherwise, the Amazon Web Services
* CLI Base64-encodes the public key a second time, resulting in a ValidationException.
*
*
*
* You can specify the public key as binary data in a file using fileb (fileb://<path-to-file>)
* or in-line using a Base64 encoded string.
*
*/
private java.nio.ByteBuffer publicKey;
/**
*
* A list of grant tokens.
*
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved
* eventual consistency. For more information, see Grant token and Using a grant
* token in the Key Management Service Developer Guide.
*
*/
private com.amazonaws.internal.SdkInternalList grantTokens;
/**
*
* Checks if your request will succeed. DryRun is an optional parameter.
*
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*
*/
private Boolean dryRun;
/**
*
* A signed attestation
* document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's
* public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.
*
*
* This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To call
* DeriveSharedSecret for an Amazon Web Services Nitro Enclaves, use the Amazon Web Services
* Nitro Enclaves SDK to generate the attestation document and then use the Recipient parameter from any Amazon
* Web Services SDK to provide the attestation document for the enclave.
*
*
* When you use this parameter, instead of returning a plaintext copy of the shared secret, KMS encrypts the
* plaintext shared secret under the public key in the attestation document, and returns the resulting ciphertext in
* the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the
* private key in the enclave. The CiphertextBlob field in the response contains the encrypted shared
* secret derived from the KMS key specified by the KeyId parameter and public key specified by the
* PublicKey parameter. The SharedSecret field in the response is null or empty.
*
*
* 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.
*
*/
private RecipientInfo recipient;
/**
*
* Identifies an asymmetric NIST-recommended ECC or SM2 (China Regions only) KMS key. KMS uses the private key in
* the specified key pair to derive the shared secret. The key usage of the KMS key must be
* KEY_AGREEMENT. To find the KeyUsage of a KMS key, use the DescribeKey operation.
*
*
* To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with
* "alias/". To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and
* alias ARN, use ListAliases.
*
*
* @param keyId
* Identifies an asymmetric NIST-recommended ECC or SM2 (China Regions only) KMS key. KMS uses the private
* key in the specified key pair to derive the shared secret. The key usage of the KMS key must be
* KEY_AGREEMENT. To find the KeyUsage of a KMS key, use the DescribeKey
* operation.
*
* To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix
* it with "alias/". To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias
* name and alias ARN, use ListAliases.
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* Identifies an asymmetric NIST-recommended ECC or SM2 (China Regions only) KMS key. KMS uses the private key in
* the specified key pair to derive the shared secret. The key usage of the KMS key must be
* KEY_AGREEMENT. To find the KeyUsage of a KMS key, use the DescribeKey operation.
*
*
* To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with
* "alias/". To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and
* alias ARN, use ListAliases.
*
*
* @return Identifies an asymmetric NIST-recommended ECC or SM2 (China Regions only) KMS key. KMS uses the private
* key in the specified key pair to derive the shared secret. The key usage of the KMS key must be
* KEY_AGREEMENT. To find the KeyUsage of a KMS key, use the DescribeKey
* operation.
*
* To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix
* it with "alias/". To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias
* name and alias ARN, use ListAliases.
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* Identifies an asymmetric NIST-recommended ECC or SM2 (China Regions only) KMS key. KMS uses the private key in
* the specified key pair to derive the shared secret. The key usage of the KMS key must be
* KEY_AGREEMENT. To find the KeyUsage of a KMS key, use the DescribeKey operation.
*
*
* To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with
* "alias/". To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and
* alias ARN, use ListAliases.
*
*
* @param keyId
* Identifies an asymmetric NIST-recommended ECC or SM2 (China Regions only) KMS key. KMS uses the private
* key in the specified key pair to derive the shared secret. The key usage of the KMS key must be
* KEY_AGREEMENT. To find the KeyUsage of a KMS key, use the DescribeKey
* operation.
*
* To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix
* it with "alias/". To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias
* name and alias ARN, use ListAliases.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeriveSharedSecretRequest withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* Specifies the key agreement algorithm used to derive the shared secret. The only valid value is ECDH
* .
*
*
* @param keyAgreementAlgorithm
* Specifies the key agreement algorithm used to derive the shared secret. The only valid value is
* ECDH.
* @see KeyAgreementAlgorithmSpec
*/
public void setKeyAgreementAlgorithm(String keyAgreementAlgorithm) {
this.keyAgreementAlgorithm = keyAgreementAlgorithm;
}
/**
*
* Specifies the key agreement algorithm used to derive the shared secret. The only valid value is ECDH
* .
*
*
* @return Specifies the key agreement algorithm used to derive the shared secret. The only valid value is
* ECDH.
* @see KeyAgreementAlgorithmSpec
*/
public String getKeyAgreementAlgorithm() {
return this.keyAgreementAlgorithm;
}
/**
*
* Specifies the key agreement algorithm used to derive the shared secret. The only valid value is ECDH
* .
*
*
* @param keyAgreementAlgorithm
* Specifies the key agreement algorithm used to derive the shared secret. The only valid value is
* ECDH.
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeyAgreementAlgorithmSpec
*/
public DeriveSharedSecretRequest withKeyAgreementAlgorithm(String keyAgreementAlgorithm) {
setKeyAgreementAlgorithm(keyAgreementAlgorithm);
return this;
}
/**
*
* Specifies the key agreement algorithm used to derive the shared secret. The only valid value is ECDH
* .
*
*
* @param keyAgreementAlgorithm
* Specifies the key agreement algorithm used to derive the shared secret. The only valid value is
* ECDH.
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeyAgreementAlgorithmSpec
*/
public DeriveSharedSecretRequest withKeyAgreementAlgorithm(KeyAgreementAlgorithmSpec keyAgreementAlgorithm) {
this.keyAgreementAlgorithm = keyAgreementAlgorithm.toString();
return this;
}
/**
*
* Specifies the public key in your peer's NIST-recommended elliptic curve (ECC) or SM2 (China Regions only) key
* pair.
*
*
* The public key must be a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as
* defined in RFC 5280.
*
*
* GetPublicKey returns the public key of an asymmetric KMS key pair in the required DER-encoded format.
*
*
*
* If you use Amazon Web Services CLI
* version 1, you must provide the DER-encoded X.509 public key in a file. Otherwise, the Amazon Web Services
* CLI Base64-encodes the public key a second time, resulting in a ValidationException.
*
*
*
* You can specify the public key as binary data in a file using fileb (fileb://<path-to-file>)
* or in-line using a Base64 encoded string.
*
*
* 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.
*
*
* @param publicKey
* Specifies the public key in your peer's NIST-recommended elliptic curve (ECC) or SM2 (China Regions only)
* key pair.
*
* The public key must be a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo
* (SPKI), as defined in RFC 5280.
*
*
* GetPublicKey returns the public key of an asymmetric KMS key pair in the required DER-encoded
* format.
*
*
*
* If you use Amazon Web
* Services CLI version 1, you must provide the DER-encoded X.509 public key in a file. Otherwise, the
* Amazon Web Services CLI Base64-encodes the public key a second time, resulting in a
* ValidationException.
*
*
*
* You can specify the public key as binary data in a file using fileb (
* fileb://<path-to-file>) or in-line using a Base64 encoded string.
*/
public void setPublicKey(java.nio.ByteBuffer publicKey) {
this.publicKey = publicKey;
}
/**
*
* Specifies the public key in your peer's NIST-recommended elliptic curve (ECC) or SM2 (China Regions only) key
* pair.
*
*
* The public key must be a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as
* defined in RFC 5280.
*
*
* GetPublicKey returns the public key of an asymmetric KMS key pair in the required DER-encoded format.
*
*
*
* If you use Amazon Web Services CLI
* version 1, you must provide the DER-encoded X.509 public key in a file. Otherwise, the Amazon Web Services
* CLI Base64-encodes the public key a second time, resulting in a ValidationException.
*
*
*
* You can specify the public key as binary data in a file using fileb (fileb://<path-to-file>)
* or in-line using a Base64 encoded string.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend
* using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent
* {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}.
* Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the
* {@code position}.
*
*
* @return Specifies the public key in your peer's NIST-recommended elliptic curve (ECC) or SM2 (China Regions only)
* key pair.
*
* The public key must be a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo
* (SPKI), as defined in RFC 5280.
*
*
* GetPublicKey returns the public key of an asymmetric KMS key pair in the required DER-encoded
* format.
*
*
*
* If you use Amazon Web
* Services CLI version 1, you must provide the DER-encoded X.509 public key in a file. Otherwise, the
* Amazon Web Services CLI Base64-encodes the public key a second time, resulting in a
* ValidationException.
*
*
*
* You can specify the public key as binary data in a file using fileb (
* fileb://<path-to-file>) or in-line using a Base64 encoded string.
*/
public java.nio.ByteBuffer getPublicKey() {
return this.publicKey;
}
/**
*
* Specifies the public key in your peer's NIST-recommended elliptic curve (ECC) or SM2 (China Regions only) key
* pair.
*
*
* The public key must be a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as
* defined in RFC 5280.
*
*
* GetPublicKey returns the public key of an asymmetric KMS key pair in the required DER-encoded format.
*
*
*
* If you use Amazon Web Services CLI
* version 1, you must provide the DER-encoded X.509 public key in a file. Otherwise, the Amazon Web Services
* CLI Base64-encodes the public key a second time, resulting in a ValidationException.
*
*
*
* You can specify the public key as binary data in a file using fileb (fileb://<path-to-file>)
* or in-line using a Base64 encoded string.
*
*
* 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.
*
*
* @param publicKey
* Specifies the public key in your peer's NIST-recommended elliptic curve (ECC) or SM2 (China Regions only)
* key pair.
*
* The public key must be a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo
* (SPKI), as defined in RFC 5280.
*
*
* GetPublicKey returns the public key of an asymmetric KMS key pair in the required DER-encoded
* format.
*
*
*
* If you use Amazon Web
* Services CLI version 1, you must provide the DER-encoded X.509 public key in a file. Otherwise, the
* Amazon Web Services CLI Base64-encodes the public key a second time, resulting in a
* ValidationException.
*
*
*
* You can specify the public key as binary data in a file using fileb (
* fileb://<path-to-file>) or in-line using a Base64 encoded string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeriveSharedSecretRequest withPublicKey(java.nio.ByteBuffer publicKey) {
setPublicKey(publicKey);
return this;
}
/**
*
* A list of grant tokens.
*
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved
* eventual consistency. For more information, see Grant token and Using a grant
* token in the Key Management Service Developer Guide.
*
*
* @return A list of grant tokens.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token and
* Using
* a grant token in the Key Management Service Developer Guide.
*/
public java.util.List getGrantTokens() {
if (grantTokens == null) {
grantTokens = new com.amazonaws.internal.SdkInternalList();
}
return grantTokens;
}
/**
*
* A list of grant tokens.
*
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved
* eventual consistency. For more information, see Grant token and Using a grant
* token in the Key Management Service Developer Guide.
*
*
* @param grantTokens
* A list of grant tokens.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token and
* Using
* a grant token in the Key Management Service Developer Guide.
*/
public void setGrantTokens(java.util.Collection grantTokens) {
if (grantTokens == null) {
this.grantTokens = null;
return;
}
this.grantTokens = new com.amazonaws.internal.SdkInternalList(grantTokens);
}
/**
*
* A list of grant tokens.
*
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved
* eventual consistency. For more information, see Grant token and Using a grant
* token in the Key Management Service Developer Guide.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setGrantTokens(java.util.Collection)} or {@link #withGrantTokens(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param grantTokens
* A list of grant tokens.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token and
* Using
* a grant token in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeriveSharedSecretRequest withGrantTokens(String... grantTokens) {
if (this.grantTokens == null) {
setGrantTokens(new com.amazonaws.internal.SdkInternalList(grantTokens.length));
}
for (String ele : grantTokens) {
this.grantTokens.add(ele);
}
return this;
}
/**
*
* A list of grant tokens.
*
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved
* eventual consistency. For more information, see Grant token and Using a grant
* token in the Key Management Service Developer Guide.
*
*
* @param grantTokens
* A list of grant tokens.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token and
* Using
* a grant token in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeriveSharedSecretRequest withGrantTokens(java.util.Collection grantTokens) {
setGrantTokens(grantTokens);
return this;
}
/**
*
* Checks if your request will succeed. DryRun is an optional parameter.
*
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*
*
* @param dryRun
* Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*/
public void setDryRun(Boolean dryRun) {
this.dryRun = dryRun;
}
/**
*
* Checks if your request will succeed. DryRun is an optional parameter.
*
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*
*
* @return Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*/
public Boolean getDryRun() {
return this.dryRun;
}
/**
*
* Checks if your request will succeed. DryRun is an optional parameter.
*
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*
*
* @param dryRun
* Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeriveSharedSecretRequest withDryRun(Boolean dryRun) {
setDryRun(dryRun);
return this;
}
/**
*
* Checks if your request will succeed. DryRun is an optional parameter.
*
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*
*
* @return Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*/
public Boolean isDryRun() {
return this.dryRun;
}
/**
*
* A signed attestation
* document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's
* public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.
*
*
* This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To call
* DeriveSharedSecret for an Amazon Web Services Nitro Enclaves, use the Amazon Web Services
* Nitro Enclaves SDK to generate the attestation document and then use the Recipient parameter from any Amazon
* Web Services SDK to provide the attestation document for the enclave.
*
*
* When you use this parameter, instead of returning a plaintext copy of the shared secret, KMS encrypts the
* plaintext shared secret under the public key in the attestation document, and returns the resulting ciphertext in
* the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the
* private key in the enclave. The CiphertextBlob field in the response contains the encrypted shared
* secret derived from the KMS key specified by the KeyId parameter and public key specified by the
* PublicKey parameter. The SharedSecret field in the response is null or empty.
*
*
* 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.
*
*
* @param recipient
* A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use
* with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.
*
*
* This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To call
* DeriveSharedSecret for an Amazon Web Services Nitro Enclaves, use the Amazon Web
* Services Nitro Enclaves SDK to generate the attestation document and then use the Recipient parameter
* from any Amazon Web Services SDK to provide the attestation document for the enclave.
*
*
* When you use this parameter, instead of returning a plaintext copy of the shared secret, KMS encrypts the
* plaintext shared secret under the public key in the attestation document, and returns the resulting
* ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be
* decrypted only with the private key in the enclave. The CiphertextBlob field in the response
* contains the encrypted shared secret derived from the KMS key specified by the KeyId
* parameter and public key specified by the PublicKey parameter. The SharedSecret
* field in the response is null or empty.
*
*
* 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 setRecipient(RecipientInfo recipient) {
this.recipient = recipient;
}
/**
*
* A signed attestation
* document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's
* public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.
*
*
* This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To call
* DeriveSharedSecret for an Amazon Web Services Nitro Enclaves, use the Amazon Web Services
* Nitro Enclaves SDK to generate the attestation document and then use the Recipient parameter from any Amazon
* Web Services SDK to provide the attestation document for the enclave.
*
*
* When you use this parameter, instead of returning a plaintext copy of the shared secret, KMS encrypts the
* plaintext shared secret under the public key in the attestation document, and returns the resulting ciphertext in
* the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the
* private key in the enclave. The CiphertextBlob field in the response contains the encrypted shared
* secret derived from the KMS key specified by the KeyId parameter and public key specified by the
* PublicKey parameter. The SharedSecret field in the response is null or empty.
*
*
* 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.
*
*
* @return A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use
* with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.
*
*
* This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To call
* DeriveSharedSecret for an Amazon Web Services Nitro Enclaves, use the Amazon Web
* Services Nitro Enclaves SDK to generate the attestation document and then use the Recipient parameter
* from any Amazon Web Services SDK to provide the attestation document for the enclave.
*
*
* When you use this parameter, instead of returning a plaintext copy of the shared secret, KMS encrypts the
* plaintext shared secret under the public key in the attestation document, and returns the resulting
* ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be
* decrypted only with the private key in the enclave. The CiphertextBlob field in the response
* contains the encrypted shared secret derived from the KMS key specified by the KeyId
* parameter and public key specified by the PublicKey parameter. The SharedSecret
* field in the response is null or empty.
*
*
* 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 RecipientInfo getRecipient() {
return this.recipient;
}
/**
*
* A signed attestation
* document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's
* public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.
*
*
* This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To call
* DeriveSharedSecret for an Amazon Web Services Nitro Enclaves, use the Amazon Web Services
* Nitro Enclaves SDK to generate the attestation document and then use the Recipient parameter from any Amazon
* Web Services SDK to provide the attestation document for the enclave.
*
*
* When you use this parameter, instead of returning a plaintext copy of the shared secret, KMS encrypts the
* plaintext shared secret under the public key in the attestation document, and returns the resulting ciphertext in
* the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the
* private key in the enclave. The CiphertextBlob field in the response contains the encrypted shared
* secret derived from the KMS key specified by the KeyId parameter and public key specified by the
* PublicKey parameter. The SharedSecret field in the response is null or empty.
*
*
* 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.
*
*
* @param recipient
* A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use
* with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.
*
*
* This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To call
* DeriveSharedSecret for an Amazon Web Services Nitro Enclaves, use the Amazon Web
* Services Nitro Enclaves SDK to generate the attestation document and then use the Recipient parameter
* from any Amazon Web Services SDK to provide the attestation document for the enclave.
*
*
* When you use this parameter, instead of returning a plaintext copy of the shared secret, KMS encrypts the
* plaintext shared secret under the public key in the attestation document, and returns the resulting
* ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be
* decrypted only with the private key in the enclave. The CiphertextBlob field in the response
* contains the encrypted shared secret derived from the KMS key specified by the KeyId
* parameter and public key specified by the PublicKey parameter. The SharedSecret
* field in the response is null or empty.
*
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeriveSharedSecretRequest withRecipient(RecipientInfo recipient) {
setRecipient(recipient);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getKeyId() != null)
sb.append("KeyId: ").append(getKeyId()).append(",");
if (getKeyAgreementAlgorithm() != null)
sb.append("KeyAgreementAlgorithm: ").append(getKeyAgreementAlgorithm()).append(",");
if (getPublicKey() != null)
sb.append("PublicKey: ").append(getPublicKey()).append(",");
if (getGrantTokens() != null)
sb.append("GrantTokens: ").append(getGrantTokens()).append(",");
if (getDryRun() != null)
sb.append("DryRun: ").append(getDryRun()).append(",");
if (getRecipient() != null)
sb.append("Recipient: ").append(getRecipient());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DeriveSharedSecretRequest == false)
return false;
DeriveSharedSecretRequest other = (DeriveSharedSecretRequest) obj;
if (other.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false)
return false;
if (other.getKeyAgreementAlgorithm() == null ^ this.getKeyAgreementAlgorithm() == null)
return false;
if (other.getKeyAgreementAlgorithm() != null && other.getKeyAgreementAlgorithm().equals(this.getKeyAgreementAlgorithm()) == false)
return false;
if (other.getPublicKey() == null ^ this.getPublicKey() == null)
return false;
if (other.getPublicKey() != null && other.getPublicKey().equals(this.getPublicKey()) == false)
return false;
if (other.getGrantTokens() == null ^ this.getGrantTokens() == null)
return false;
if (other.getGrantTokens() != null && other.getGrantTokens().equals(this.getGrantTokens()) == false)
return false;
if (other.getDryRun() == null ^ this.getDryRun() == null)
return false;
if (other.getDryRun() != null && other.getDryRun().equals(this.getDryRun()) == false)
return false;
if (other.getRecipient() == null ^ this.getRecipient() == null)
return false;
if (other.getRecipient() != null && other.getRecipient().equals(this.getRecipient()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode());
hashCode = prime * hashCode + ((getKeyAgreementAlgorithm() == null) ? 0 : getKeyAgreementAlgorithm().hashCode());
hashCode = prime * hashCode + ((getPublicKey() == null) ? 0 : getPublicKey().hashCode());
hashCode = prime * hashCode + ((getGrantTokens() == null) ? 0 : getGrantTokens().hashCode());
hashCode = prime * hashCode + ((getDryRun() == null) ? 0 : getDryRun().hashCode());
hashCode = prime * hashCode + ((getRecipient() == null) ? 0 : getRecipient().hashCode());
return hashCode;
}
@Override
public DeriveSharedSecretRequest clone() {
return (DeriveSharedSecretRequest) super.clone();
}
}