/*
* Copyright 2010-2016 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 com.amazonaws.AmazonWebServiceRequest;
/**
* <p>
* Returns a data key encrypted by a customer master key without the plaintext
* copy of that key. Otherwise, this API functions exactly like
* <a>GenerateDataKey</a>. You can use this API to, for example, satisfy an
* audit requirement that an encrypted key be made available without exposing
* the plaintext copy of that key.
* </p>
*/
public class GenerateDataKeyWithoutPlaintextRequest extends AmazonWebServiceRequest implements
Serializable {
/**
* <p>
* A unique identifier for the customer master key. This value can be a
* globally unique identifier, a fully specified ARN to either an alias or a
* key, or an alias name prefixed by "alias/".
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias Name Example - alias/MyAliasName
* </p>
* </li>
* </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*/
private String keyId;
/**
* <p>
* Name:value pair that contains additional data to be authenticated during
* the encryption and decryption processes.
* </p>
*/
private java.util.Map<String, String> encryptionContext = new java.util.HashMap<String, String>();
/**
* <p>
* Value that identifies the encryption algorithm and key size. Currently
* this can be AES_128 or AES_256.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>AES_256, AES_128
*/
private String keySpec;
/**
* <p>
* Integer that contains the number of bytes to generate. Common values are
* 128, 256, 512, 1024 and so on. We recommend that you use the
* <code>KeySpec</code> parameter instead.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Range: </b>1 - 1024<br/>
*/
private Integer numberOfBytes;
/**
* <p>
* A list of grant tokens.
* </p>
* <p>
* For more information, see <a href=
* "http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token"
* >Grant Tokens</a> in the <i>AWS Key Management Service Developer
* Guide</i>.
* </p>
*/
private java.util.List<String> grantTokens = new java.util.ArrayList<String>();
/**
* <p>
* A unique identifier for the customer master key. This value can be a
* globally unique identifier, a fully specified ARN to either an alias or a
* key, or an alias name prefixed by "alias/".
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias Name Example - alias/MyAliasName
* </p>
* </li>
* </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @return <p>
* A unique identifier for the customer master key. This value can
* be a globally unique identifier, a fully specified ARN to either
* an alias or a key, or an alias name prefixed by "alias/".
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-
* 1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias ARN Example -
* arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example -
* 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias Name Example - alias/MyAliasName
* </p>
* </li>
* </ul>
*/
public String getKeyId() {
return keyId;
}
/**
* <p>
* A unique identifier for the customer master key. This value can be a
* globally unique identifier, a fully specified ARN to either an alias or a
* key, or an alias name prefixed by "alias/".
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias Name Example - alias/MyAliasName
* </p>
* </li>
* </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @param keyId <p>
* A unique identifier for the customer master key. This value
* can be a globally unique identifier, a fully specified ARN to
* either an alias or a key, or an alias name prefixed by
* "alias/".
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678
* -1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias ARN Example -
* arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example -
* 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias Name Example - alias/MyAliasName
* </p>
* </li>
* </ul>
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
* <p>
* A unique identifier for the customer master key. This value can be a
* globally unique identifier, a fully specified ARN to either an alias or a
* key, or an alias name prefixed by "alias/".
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias Name Example - alias/MyAliasName
* </p>
* </li>
* </ul>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @param keyId <p>
* A unique identifier for the customer master key. This value
* can be a globally unique identifier, a fully specified ARN to
* either an alias or a key, or an alias name prefixed by
* "alias/".
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678
* -1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias ARN Example -
* arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example -
* 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias Name Example - alias/MyAliasName
* </p>
* </li>
* </ul>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public GenerateDataKeyWithoutPlaintextRequest withKeyId(String keyId) {
this.keyId = keyId;
return this;
}
/**
* <p>
* Name:value pair that contains additional data to be authenticated during
* the encryption and decryption processes.
* </p>
*
* @return <p>
* Name:value pair that contains additional data to be authenticated
* during the encryption and decryption processes.
* </p>
*/
public java.util.Map<String, String> getEncryptionContext() {
return encryptionContext;
}
/**
* <p>
* Name:value pair that contains additional data to be authenticated during
* the encryption and decryption processes.
* </p>
*
* @param encryptionContext <p>
* Name:value pair that contains additional data to be
* authenticated during the encryption and decryption processes.
* </p>
*/
public void setEncryptionContext(java.util.Map<String, String> encryptionContext) {
this.encryptionContext = encryptionContext;
}
/**
* <p>
* Name:value pair that contains additional data to be authenticated during
* the encryption and decryption processes.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param encryptionContext <p>
* Name:value pair that contains additional data to be
* authenticated during the encryption and decryption processes.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public GenerateDataKeyWithoutPlaintextRequest withEncryptionContext(
java.util.Map<String, String> encryptionContext) {
this.encryptionContext = encryptionContext;
return this;
}
/**
* <p>
* Name:value pair that contains additional data to be authenticated during
* the encryption and decryption processes.
* </p>
* <p>
* The method adds a new key-value pair into EncryptionContext parameter,
* and returns a reference to this object so that method calls can be
* chained together.
*
* @param key The key of the entry to be added into EncryptionContext.
* @param value The corresponding value of the entry to be added into
* EncryptionContext.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public GenerateDataKeyWithoutPlaintextRequest addEncryptionContextEntry(String key, String value) {
if (null == this.encryptionContext) {
this.encryptionContext = new java.util.HashMap<String, String>();
}
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.
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*/
public GenerateDataKeyWithoutPlaintextRequest clearEncryptionContextEntries() {
this.encryptionContext = null;
return this;
}
/**
* <p>
* Value that identifies the encryption algorithm and key size. Currently
* this can be AES_128 or AES_256.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>AES_256, AES_128
*
* @return <p>
* Value that identifies the encryption algorithm and key size.
* Currently this can be AES_128 or AES_256.
* </p>
* @see DataKeySpec
*/
public String getKeySpec() {
return keySpec;
}
/**
* <p>
* Value that identifies the encryption algorithm and key size. Currently
* this can be AES_128 or AES_256.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>AES_256, AES_128
*
* @param keySpec <p>
* Value that identifies the encryption algorithm and key size.
* Currently this can be AES_128 or AES_256.
* </p>
* @see DataKeySpec
*/
public void setKeySpec(String keySpec) {
this.keySpec = keySpec;
}
/**
* <p>
* Value that identifies the encryption algorithm and key size. Currently
* this can be AES_128 or AES_256.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>AES_256, AES_128
*
* @param keySpec <p>
* Value that identifies the encryption algorithm and key size.
* Currently this can be AES_128 or AES_256.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
* @see DataKeySpec
*/
public GenerateDataKeyWithoutPlaintextRequest withKeySpec(String keySpec) {
this.keySpec = keySpec;
return this;
}
/**
* <p>
* Value that identifies the encryption algorithm and key size. Currently
* this can be AES_128 or AES_256.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>AES_256, AES_128
*
* @param keySpec <p>
* Value that identifies the encryption algorithm and key size.
* Currently this can be AES_128 or AES_256.
* </p>
* @see DataKeySpec
*/
public void setKeySpec(DataKeySpec keySpec) {
this.keySpec = keySpec.toString();
}
/**
* <p>
* Value that identifies the encryption algorithm and key size. Currently
* this can be AES_128 or AES_256.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>AES_256, AES_128
*
* @param keySpec <p>
* Value that identifies the encryption algorithm and key size.
* Currently this can be AES_128 or AES_256.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
* @see DataKeySpec
*/
public GenerateDataKeyWithoutPlaintextRequest withKeySpec(DataKeySpec keySpec) {
this.keySpec = keySpec.toString();
return this;
}
/**
* <p>
* Integer that contains the number of bytes to generate. Common values are
* 128, 256, 512, 1024 and so on. We recommend that you use the
* <code>KeySpec</code> parameter instead.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Range: </b>1 - 1024<br/>
*
* @return <p>
* Integer that contains the number of bytes to generate. Common
* values are 128, 256, 512, 1024 and so on. We recommend that you
* use the <code>KeySpec</code> parameter instead.
* </p>
*/
public Integer getNumberOfBytes() {
return numberOfBytes;
}
/**
* <p>
* Integer that contains the number of bytes to generate. Common values are
* 128, 256, 512, 1024 and so on. We recommend that you use the
* <code>KeySpec</code> parameter instead.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Range: </b>1 - 1024<br/>
*
* @param numberOfBytes <p>
* Integer that contains the number of bytes to generate. Common
* values are 128, 256, 512, 1024 and so on. We recommend that
* you use the <code>KeySpec</code> parameter instead.
* </p>
*/
public void setNumberOfBytes(Integer numberOfBytes) {
this.numberOfBytes = numberOfBytes;
}
/**
* <p>
* Integer that contains the number of bytes to generate. Common values are
* 128, 256, 512, 1024 and so on. We recommend that you use the
* <code>KeySpec</code> parameter instead.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Range: </b>1 - 1024<br/>
*
* @param numberOfBytes <p>
* Integer that contains the number of bytes to generate. Common
* values are 128, 256, 512, 1024 and so on. We recommend that
* you use the <code>KeySpec</code> parameter instead.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public GenerateDataKeyWithoutPlaintextRequest withNumberOfBytes(Integer numberOfBytes) {
this.numberOfBytes = numberOfBytes;
return this;
}
/**
* <p>
* A list of grant tokens.
* </p>
* <p>
* For more information, see <a href=
* "http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token"
* >Grant Tokens</a> in the <i>AWS Key Management Service Developer
* Guide</i>.
* </p>
*
* @return <p>
* A list of grant tokens.
* </p>
* <p>
* For more information, see <a href=
* "http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token"
* >Grant Tokens</a> in the <i>AWS Key Management Service Developer
* Guide</i>.
* </p>
*/
public java.util.List<String> getGrantTokens() {
return grantTokens;
}
/**
* <p>
* A list of grant tokens.
* </p>
* <p>
* For more information, see <a href=
* "http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token"
* >Grant Tokens</a> in the <i>AWS Key Management Service Developer
* Guide</i>.
* </p>
*
* @param grantTokens <p>
* A list of grant tokens.
* </p>
* <p>
* For more information, see <a href=
* "http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token"
* >Grant Tokens</a> in the <i>AWS Key Management Service
* Developer Guide</i>.
* </p>
*/
public void setGrantTokens(java.util.Collection<String> grantTokens) {
if (grantTokens == null) {
this.grantTokens = null;
return;
}
this.grantTokens = new java.util.ArrayList<String>(grantTokens);
}
/**
* <p>
* A list of grant tokens.
* </p>
* <p>
* For more information, see <a href=
* "http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token"
* >Grant Tokens</a> in the <i>AWS Key Management Service Developer
* Guide</i>.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param grantTokens <p>
* A list of grant tokens.
* </p>
* <p>
* For more information, see <a href=
* "http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token"
* >Grant Tokens</a> in the <i>AWS Key Management Service
* Developer Guide</i>.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public GenerateDataKeyWithoutPlaintextRequest withGrantTokens(String... grantTokens) {
if (getGrantTokens() == null) {
this.grantTokens = new java.util.ArrayList<String>(grantTokens.length);
}
for (String value : grantTokens) {
this.grantTokens.add(value);
}
return this;
}
/**
* <p>
* A list of grant tokens.
* </p>
* <p>
* For more information, see <a href=
* "http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token"
* >Grant Tokens</a> in the <i>AWS Key Management Service Developer
* Guide</i>.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param grantTokens <p>
* A list of grant tokens.
* </p>
* <p>
* For more information, see <a href=
* "http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token"
* >Grant Tokens</a> in the <i>AWS Key Management Service
* Developer Guide</i>.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public GenerateDataKeyWithoutPlaintextRequest withGrantTokens(
java.util.Collection<String> grantTokens) {
setGrantTokens(grantTokens);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @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: " + getKeyId() + ",");
if (getEncryptionContext() != null)
sb.append("EncryptionContext: " + getEncryptionContext() + ",");
if (getKeySpec() != null)
sb.append("KeySpec: " + getKeySpec() + ",");
if (getNumberOfBytes() != null)
sb.append("NumberOfBytes: " + getNumberOfBytes() + ",");
if (getGrantTokens() != null)
sb.append("GrantTokens: " + getGrantTokens());
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode());
hashCode = prime * hashCode
+ ((getEncryptionContext() == null) ? 0 : getEncryptionContext().hashCode());
hashCode = prime * hashCode + ((getKeySpec() == null) ? 0 : getKeySpec().hashCode());
hashCode = prime * hashCode
+ ((getNumberOfBytes() == null) ? 0 : getNumberOfBytes().hashCode());
hashCode = prime * hashCode
+ ((getGrantTokens() == null) ? 0 : getGrantTokens().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GenerateDataKeyWithoutPlaintextRequest == false)
return false;
GenerateDataKeyWithoutPlaintextRequest other = (GenerateDataKeyWithoutPlaintextRequest) obj;
if (other.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false)
return false;
if (other.getEncryptionContext() == null ^ this.getEncryptionContext() == null)
return false;
if (other.getEncryptionContext() != null
&& other.getEncryptionContext().equals(this.getEncryptionContext()) == false)
return false;
if (other.getKeySpec() == null ^ this.getKeySpec() == null)
return false;
if (other.getKeySpec() != null && other.getKeySpec().equals(this.getKeySpec()) == false)
return false;
if (other.getNumberOfBytes() == null ^ this.getNumberOfBytes() == null)
return false;
if (other.getNumberOfBytes() != null
&& other.getNumberOfBytes().equals(this.getNumberOfBytes()) == 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;
}
}