com.amazonaws.services.kms.model.GenerateDataKeyPairResult 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;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GenerateDataKeyPairResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
*
*/
private java.nio.ByteBuffer privateKeyCiphertextBlob;
/**
*
* The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
*
*
* If the response includes the CiphertextForRecipient field, the PrivateKeyPlaintext
* field is null or empty.
*
*/
private java.nio.ByteBuffer privateKeyPlaintext;
/**
*
* The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
*
*/
private java.nio.ByteBuffer publicKey;
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key that encrypted the private key.
*
*/
private String keyId;
/**
*
* The type of data key pair that was generated.
*
*/
private String keyPairSpec;
/**
*
* The plaintext private data key encrypted with the public key from the Nitro enclave. This ciphertext can be
* decrypted only by using a private key in the Nitro enclave.
*
*
* 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.
*
*/
private java.nio.ByteBuffer ciphertextForRecipient;
/**
*
* The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services 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.
*
*
* @param privateKeyCiphertextBlob
* The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value
* is Base64-encoded. Otherwise, it is not Base64-encoded.
*/
public void setPrivateKeyCiphertextBlob(java.nio.ByteBuffer privateKeyCiphertextBlob) {
this.privateKeyCiphertextBlob = privateKeyCiphertextBlob;
}
/**
*
* The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
*
*
* {@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 The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the
* value is Base64-encoded. Otherwise, it is not Base64-encoded.
*/
public java.nio.ByteBuffer getPrivateKeyCiphertextBlob() {
return this.privateKeyCiphertextBlob;
}
/**
*
* The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services 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.
*
*
* @param privateKeyCiphertextBlob
* The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value
* is Base64-encoded. Otherwise, it is not Base64-encoded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyPairResult withPrivateKeyCiphertextBlob(java.nio.ByteBuffer privateKeyCiphertextBlob) {
setPrivateKeyCiphertextBlob(privateKeyCiphertextBlob);
return this;
}
/**
*
* The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
*
*
* If the response includes the CiphertextForRecipient field, the PrivateKeyPlaintext
* 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.
*
*
* @param privateKeyPlaintext
* The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value
* is Base64-encoded. Otherwise, it is not Base64-encoded.
*
* If the response includes the CiphertextForRecipient field, the
* PrivateKeyPlaintext field is null or empty.
*/
public void setPrivateKeyPlaintext(java.nio.ByteBuffer privateKeyPlaintext) {
this.privateKeyPlaintext = privateKeyPlaintext;
}
/**
*
* The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
*
*
* If the response includes the CiphertextForRecipient field, the PrivateKeyPlaintext
* field is null or empty.
*
*
* {@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 The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the
* value is Base64-encoded. Otherwise, it is not Base64-encoded.
*
* If the response includes the CiphertextForRecipient field, the
* PrivateKeyPlaintext field is null or empty.
*/
public java.nio.ByteBuffer getPrivateKeyPlaintext() {
return this.privateKeyPlaintext;
}
/**
*
* The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
*
*
* If the response includes the CiphertextForRecipient field, the PrivateKeyPlaintext
* 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.
*
*
* @param privateKeyPlaintext
* The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value
* is Base64-encoded. Otherwise, it is not Base64-encoded.
*
* If the response includes the CiphertextForRecipient field, the
* PrivateKeyPlaintext field is null or empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyPairResult withPrivateKeyPlaintext(java.nio.ByteBuffer privateKeyPlaintext) {
setPrivateKeyPlaintext(privateKeyPlaintext);
return this;
}
/**
*
* The public key (in plaintext). When you use the HTTP API or the Amazon Web Services 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.
*
*
* @param publicKey
* The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
*/
public void setPublicKey(java.nio.ByteBuffer publicKey) {
this.publicKey = publicKey;
}
/**
*
* The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
*
*
* {@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 The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
*/
public java.nio.ByteBuffer getPublicKey() {
return this.publicKey;
}
/**
*
* The public key (in plaintext). When you use the HTTP API or the Amazon Web Services 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.
*
*
* @param publicKey
* The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyPairResult withPublicKey(java.nio.ByteBuffer publicKey) {
setPublicKey(publicKey);
return this;
}
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key that encrypted the private key.
*
*
* @param keyId
* The Amazon Resource Name (key ARN) of
* the KMS key that encrypted the private key.
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key that encrypted the private key.
*
*
* @return The Amazon Resource Name (key ARN) of
* the KMS key that encrypted the private key.
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key that encrypted the private key.
*
*
* @param keyId
* The Amazon Resource Name (key ARN) of
* the KMS key that encrypted the private key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyPairResult withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* The type of data key pair that was generated.
*
*
* @param keyPairSpec
* The type of data key pair that was generated.
* @see DataKeyPairSpec
*/
public void setKeyPairSpec(String keyPairSpec) {
this.keyPairSpec = keyPairSpec;
}
/**
*
* The type of data key pair that was generated.
*
*
* @return The type of data key pair that was generated.
* @see DataKeyPairSpec
*/
public String getKeyPairSpec() {
return this.keyPairSpec;
}
/**
*
* The type of data key pair that was generated.
*
*
* @param keyPairSpec
* The type of data key pair that was generated.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataKeyPairSpec
*/
public GenerateDataKeyPairResult withKeyPairSpec(String keyPairSpec) {
setKeyPairSpec(keyPairSpec);
return this;
}
/**
*
* The type of data key pair that was generated.
*
*
* @param keyPairSpec
* The type of data key pair that was generated.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataKeyPairSpec
*/
public GenerateDataKeyPairResult withKeyPairSpec(DataKeyPairSpec keyPairSpec) {
this.keyPairSpec = keyPairSpec.toString();
return this;
}
/**
*
* The plaintext private data key encrypted with the public key from the Nitro enclave. This ciphertext can be
* decrypted only by using a private key in the Nitro enclave.
*
*
* 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.
*
*
* @param ciphertextForRecipient
* The plaintext private data key encrypted with the public key from the Nitro enclave. This ciphertext can
* be decrypted only by using a private key in the Nitro enclave.
*
* 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 setCiphertextForRecipient(java.nio.ByteBuffer ciphertextForRecipient) {
this.ciphertextForRecipient = ciphertextForRecipient;
}
/**
*
* The plaintext private data key encrypted with the public key from the Nitro enclave. This ciphertext can be
* decrypted only by using a private key in the Nitro enclave.
*
*
* 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.
*
*
* {@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 The plaintext private data key encrypted with the public key from the Nitro enclave. This ciphertext can
* be decrypted only by using a private key in the Nitro enclave.
*
* 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 java.nio.ByteBuffer getCiphertextForRecipient() {
return this.ciphertextForRecipient;
}
/**
*
* The plaintext private data key encrypted with the public key from the Nitro enclave. This ciphertext can be
* decrypted only by using a private key in the Nitro enclave.
*
*
* 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.
*
*
* @param ciphertextForRecipient
* The plaintext private data key encrypted with the public key from the Nitro enclave. This ciphertext can
* be decrypted only by using a private key in the Nitro enclave.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyPairResult withCiphertextForRecipient(java.nio.ByteBuffer ciphertextForRecipient) {
setCiphertextForRecipient(ciphertextForRecipient);
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 (getPrivateKeyCiphertextBlob() != null)
sb.append("PrivateKeyCiphertextBlob: ").append(getPrivateKeyCiphertextBlob()).append(",");
if (getPrivateKeyPlaintext() != null)
sb.append("PrivateKeyPlaintext: ").append("***Sensitive Data Redacted***").append(",");
if (getPublicKey() != null)
sb.append("PublicKey: ").append(getPublicKey()).append(",");
if (getKeyId() != null)
sb.append("KeyId: ").append(getKeyId()).append(",");
if (getKeyPairSpec() != null)
sb.append("KeyPairSpec: ").append(getKeyPairSpec()).append(",");
if (getCiphertextForRecipient() != null)
sb.append("CiphertextForRecipient: ").append(getCiphertextForRecipient());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GenerateDataKeyPairResult == false)
return false;
GenerateDataKeyPairResult other = (GenerateDataKeyPairResult) obj;
if (other.getPrivateKeyCiphertextBlob() == null ^ this.getPrivateKeyCiphertextBlob() == null)
return false;
if (other.getPrivateKeyCiphertextBlob() != null && other.getPrivateKeyCiphertextBlob().equals(this.getPrivateKeyCiphertextBlob()) == false)
return false;
if (other.getPrivateKeyPlaintext() == null ^ this.getPrivateKeyPlaintext() == null)
return false;
if (other.getPrivateKeyPlaintext() != null && other.getPrivateKeyPlaintext().equals(this.getPrivateKeyPlaintext()) == 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.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false)
return false;
if (other.getKeyPairSpec() == null ^ this.getKeyPairSpec() == null)
return false;
if (other.getKeyPairSpec() != null && other.getKeyPairSpec().equals(this.getKeyPairSpec()) == false)
return false;
if (other.getCiphertextForRecipient() == null ^ this.getCiphertextForRecipient() == null)
return false;
if (other.getCiphertextForRecipient() != null && other.getCiphertextForRecipient().equals(this.getCiphertextForRecipient()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPrivateKeyCiphertextBlob() == null) ? 0 : getPrivateKeyCiphertextBlob().hashCode());
hashCode = prime * hashCode + ((getPrivateKeyPlaintext() == null) ? 0 : getPrivateKeyPlaintext().hashCode());
hashCode = prime * hashCode + ((getPublicKey() == null) ? 0 : getPublicKey().hashCode());
hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode());
hashCode = prime * hashCode + ((getKeyPairSpec() == null) ? 0 : getKeyPairSpec().hashCode());
hashCode = prime * hashCode + ((getCiphertextForRecipient() == null) ? 0 : getCiphertextForRecipient().hashCode());
return hashCode;
}
@Override
public GenerateDataKeyPairResult clone() {
try {
return (GenerateDataKeyPairResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}