com.amazonaws.services.kms.model.GenerateDataKeyPairWithoutPlaintextRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2015-2020 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 GenerateDataKeyPairWithoutPlaintextRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Specifies the encryption context that will be used when encrypting the private key in the data key pair.
*
*
* An encryption context is a collection of non-secret key-value pairs that represents additional
* authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact
* case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting
* with a symmetric CMK, but it is highly recommended.
*
*
* For more information, see Encryption Context
* in the AWS Key Management Service Developer Guide.
*
*/
private com.amazonaws.internal.SdkInternalMap encryptionContext;
/**
*
* Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You
* cannot use an asymmetric CMK.
*
*
* To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
* prefix it with "alias/".
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Alias name: alias/ExampleAlias
*
*
* -
*
* Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
*
*
*
*
* To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
* alias ARN, use ListAliases.
*
*/
private String keyId;
/**
*
* Determines the type of data key pair that is generated.
*
*
* The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but
* not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of
* AWS KMS.
*
*/
private String keyPairSpec;
/**
*
* A list of grant tokens.
*
*
* For more information, see Grant Tokens in the
* AWS Key Management Service Developer Guide.
*
*/
private com.amazonaws.internal.SdkInternalList grantTokens;
/**
*
* Specifies the encryption context that will be used when encrypting the private key in the data key pair.
*
*
* An encryption context is a collection of non-secret key-value pairs that represents additional
* authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact
* case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting
* with a symmetric CMK, but it is highly recommended.
*
*
* For more information, see Encryption Context
* in the AWS Key Management Service Developer Guide.
*
*
* @return Specifies the encryption context that will be used when encrypting the private key in the data key
* pair.
*
* An encryption context is a collection of non-secret key-value pairs that represents additional
* authenticated data. When you use an encryption context to encrypt data, you must specify the same (an
* exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional
* when encrypting with a symmetric CMK, but it is highly recommended.
*
*
* For more information, see Encryption
* Context in the AWS Key Management Service Developer Guide.
*/
public java.util.Map getEncryptionContext() {
if (encryptionContext == null) {
encryptionContext = new com.amazonaws.internal.SdkInternalMap();
}
return encryptionContext;
}
/**
*
* Specifies the encryption context that will be used when encrypting the private key in the data key pair.
*
*
* An encryption context is a collection of non-secret key-value pairs that represents additional
* authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact
* case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting
* with a symmetric CMK, but it is highly recommended.
*
*
* For more information, see Encryption Context
* in the AWS Key Management Service Developer Guide.
*
*
* @param encryptionContext
* Specifies the encryption context that will be used when encrypting the private key in the data key
* pair.
*
* An encryption context is a collection of non-secret key-value pairs that represents additional
* authenticated data. When you use an encryption context to encrypt data, you must specify the same (an
* exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when
* encrypting with a symmetric CMK, but it is highly recommended.
*
*
* For more information, see Encryption
* Context in the AWS Key Management Service Developer Guide.
*/
public void setEncryptionContext(java.util.Map encryptionContext) {
this.encryptionContext = encryptionContext == null ? null : new com.amazonaws.internal.SdkInternalMap(encryptionContext);
}
/**
*
* Specifies the encryption context that will be used when encrypting the private key in the data key pair.
*
*
* An encryption context is a collection of non-secret key-value pairs that represents additional
* authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact
* case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting
* with a symmetric CMK, but it is highly recommended.
*
*
* For more information, see Encryption Context
* in the AWS Key Management Service Developer Guide.
*
*
* @param encryptionContext
* Specifies the encryption context that will be used when encrypting the private key in the data key
* pair.
*
* An encryption context is a collection of non-secret key-value pairs that represents additional
* authenticated data. When you use an encryption context to encrypt data, you must specify the same (an
* exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when
* encrypting with a symmetric CMK, but it is highly recommended.
*
*
* For more information, see Encryption
* Context in the AWS Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyPairWithoutPlaintextRequest withEncryptionContext(java.util.Map encryptionContext) {
setEncryptionContext(encryptionContext);
return this;
}
public GenerateDataKeyPairWithoutPlaintextRequest addEncryptionContextEntry(String key, String value) {
if (null == this.encryptionContext) {
this.encryptionContext = new com.amazonaws.internal.SdkInternalMap();
}
if (this.encryptionContext.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.encryptionContext.put(key, value);
return this;
}
/**
* Removes all the entries added into EncryptionContext.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyPairWithoutPlaintextRequest clearEncryptionContextEntries() {
this.encryptionContext = null;
return this;
}
/**
*
* Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You
* cannot use an asymmetric CMK.
*
*
* To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
* prefix it with "alias/".
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Alias name: alias/ExampleAlias
*
*
* -
*
* Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
*
*
*
*
* To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
* alias ARN, use ListAliases.
*
*
* @param keyId
* Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK.
* You cannot use an asymmetric CMK.
*
* To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an
* alias name, prefix it with "alias/".
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Alias name: alias/ExampleAlias
*
*
* -
*
* Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
*
*
*
*
* To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name
* and alias ARN, use ListAliases.
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You
* cannot use an asymmetric CMK.
*
*
* To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
* prefix it with "alias/".
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Alias name: alias/ExampleAlias
*
*
* -
*
* Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
*
*
*
*
* To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
* alias ARN, use ListAliases.
*
*
* @return Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK.
* You cannot use an asymmetric CMK.
*
* To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an
* alias name, prefix it with "alias/".
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Alias name: alias/ExampleAlias
*
*
* -
*
* Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
*
*
*
*
* To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name
* and alias ARN, use ListAliases.
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You
* cannot use an asymmetric CMK.
*
*
* To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
* prefix it with "alias/".
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Alias name: alias/ExampleAlias
*
*
* -
*
* Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
*
*
*
*
* To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
* alias ARN, use ListAliases.
*
*
* @param keyId
* Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK.
* You cannot use an asymmetric CMK.
*
* To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an
* alias name, prefix it with "alias/".
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Alias name: alias/ExampleAlias
*
*
* -
*
* Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
*
*
*
*
* To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name
* and alias ARN, use ListAliases.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyPairWithoutPlaintextRequest withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* Determines the type of data key pair that is generated.
*
*
* The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but
* not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of
* AWS KMS.
*
*
* @param keyPairSpec
* Determines the type of data key pair that is generated.
*
* The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and
* verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not
* effective outside of AWS KMS.
* @see DataKeyPairSpec
*/
public void setKeyPairSpec(String keyPairSpec) {
this.keyPairSpec = keyPairSpec;
}
/**
*
* Determines the type of data key pair that is generated.
*
*
* The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but
* not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of
* AWS KMS.
*
*
* @return Determines the type of data key pair that is generated.
*
* The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and
* verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not
* effective outside of AWS KMS.
* @see DataKeyPairSpec
*/
public String getKeyPairSpec() {
return this.keyPairSpec;
}
/**
*
* Determines the type of data key pair that is generated.
*
*
* The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but
* not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of
* AWS KMS.
*
*
* @param keyPairSpec
* Determines the type of data key pair that is generated.
*
* The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and
* verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not
* effective outside of AWS KMS.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataKeyPairSpec
*/
public GenerateDataKeyPairWithoutPlaintextRequest withKeyPairSpec(String keyPairSpec) {
setKeyPairSpec(keyPairSpec);
return this;
}
/**
*
* Determines the type of data key pair that is generated.
*
*
* The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but
* not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of
* AWS KMS.
*
*
* @param keyPairSpec
* Determines the type of data key pair that is generated.
*
* The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and
* verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not
* effective outside of AWS KMS.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataKeyPairSpec
*/
public GenerateDataKeyPairWithoutPlaintextRequest withKeyPairSpec(DataKeyPairSpec keyPairSpec) {
this.keyPairSpec = keyPairSpec.toString();
return this;
}
/**
*
* A list of grant tokens.
*
*
* For more information, see Grant Tokens in the
* AWS Key Management Service Developer Guide.
*
*
* @return A list of grant tokens.
*
* For more information, see Grant Tokens
* in the AWS 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.
*
*
* For more information, see Grant Tokens in the
* AWS Key Management Service Developer Guide.
*
*
* @param grantTokens
* A list of grant tokens.
*
* For more information, see Grant Tokens in
* the AWS 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.
*
*
* For more information, see Grant Tokens in the
* AWS 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.
*
* For more information, see Grant Tokens in
* the AWS Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyPairWithoutPlaintextRequest 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.
*
*
* For more information, see Grant Tokens in the
* AWS Key Management Service Developer Guide.
*
*
* @param grantTokens
* A list of grant tokens.
*
* For more information, see Grant Tokens in
* the AWS Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyPairWithoutPlaintextRequest withGrantTokens(java.util.Collection grantTokens) {
setGrantTokens(grantTokens);
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 (getEncryptionContext() != null)
sb.append("EncryptionContext: ").append(getEncryptionContext()).append(",");
if (getKeyId() != null)
sb.append("KeyId: ").append(getKeyId()).append(",");
if (getKeyPairSpec() != null)
sb.append("KeyPairSpec: ").append(getKeyPairSpec()).append(",");
if (getGrantTokens() != null)
sb.append("GrantTokens: ").append(getGrantTokens());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GenerateDataKeyPairWithoutPlaintextRequest == false)
return false;
GenerateDataKeyPairWithoutPlaintextRequest other = (GenerateDataKeyPairWithoutPlaintextRequest) obj;
if (other.getEncryptionContext() == null ^ this.getEncryptionContext() == null)
return false;
if (other.getEncryptionContext() != null && other.getEncryptionContext().equals(this.getEncryptionContext()) == 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.getGrantTokens() == null ^ this.getGrantTokens() == null)
return false;
if (other.getGrantTokens() != null && other.getGrantTokens().equals(this.getGrantTokens()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEncryptionContext() == null) ? 0 : getEncryptionContext().hashCode());
hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode());
hashCode = prime * hashCode + ((getKeyPairSpec() == null) ? 0 : getKeyPairSpec().hashCode());
hashCode = prime * hashCode + ((getGrantTokens() == null) ? 0 : getGrantTokens().hashCode());
return hashCode;
}
@Override
public GenerateDataKeyPairWithoutPlaintextRequest clone() {
return (GenerateDataKeyPairWithoutPlaintextRequest) super.clone();
}
}