/* * Copyright 2010-2023 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; /** *

* Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a * symmetric or asymmetric KMS key with a KeyUsage of * ENCRYPT_DECRYPT. *

*

* You can use this operation to encrypt small amounts of arbitrary data, such * as a personal identifier or database password, or other sensitive * information. You don't need to use the Encrypt operation to * encrypt a data key. The GenerateDataKey and GenerateDataKeyPair * operations return a plaintext data key and an encrypted copy of that data * key. *

*

* If you use a symmetric encryption KMS key, you can use an encryption context * to add additional security to your encryption operation. If you specify an * EncryptionContext when encrypting data, you must specify the * same encryption context (a case-sensitive exact match) when decrypting the * data. Otherwise, the request to decrypt fails with an * InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide. *

*

* If you specify an asymmetric KMS key, you must also specify the encryption * algorithm. The algorithm must be compatible with the KMS key spec. *

* *

* When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to * record the KMS key and encryption algorithm that you choose. You will be * required to provide the same KMS key and encryption algorithm when you * decrypt the data. If the KMS key and algorithm do not match the values used * to encrypt the data, the decrypt operation fails. *

*

* You are not required to supply the key ID and encryption algorithm when you * decrypt with symmetric encryption KMS keys because KMS stores this * information in the ciphertext blob. KMS cannot store metadata in ciphertext * generated with asymmetric keys. The standard format for asymmetric key * ciphertext does not include configurable fields. *

* *

* The maximum size of the data that you can encrypt varies with the type of KMS * key and the encryption algorithm that you choose. *

* *

* The KMS key that you use for this operation must be in a compatible key * state. For details, see Key states of KMS keys in the Key Management Service Developer * Guide. *

*

* Cross-account use: Yes. To perform this operation with a KMS key in a * different Amazon Web Services account, specify the key ARN or alias ARN in * the value of the KeyId parameter. *

*

* Required permissions: kms:Encrypt (key policy) *

*

* Related operations: *

* */ public class EncryptRequest extends AmazonWebServiceRequest implements Serializable { /** *

* Identifies the KMS key to use in the encryption operation. The KMS key * must have a KeyUsage of ENCRYPT_DECRYPT. 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: *

* *

* 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. *

*

* Constraints:
* Length: 1 - 2048
*/ private String keyId; /** *

* Data to be encrypted. *

*

* Constraints:
* Length: 1 - 4096
*/ private java.nio.ByteBuffer plaintext; /** *

* Specifies the encryption context that will be used to encrypt the data. * An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The * standard asymmetric encryption algorithms and HMAC algorithms that KMS * uses do not support an encryption context. *

* *

* Do not include confidential or sensitive information in this field. This * field may be displayed in plaintext in CloudTrail logs and other output. *

* *

* An encryption context is a collection of non-secret key-value * pairs that represent 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 supported only on operations with symmetric * encryption KMS keys. On operations with symmetric encryption KMS keys, an * encryption context is optional, but it is strongly recommended. *

*

* For more information, see Encryption context in the Key Management Service Developer * Guide. *

*/ private java.util.Map encryptionContext = new java.util.HashMap(); /** *

* 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 java.util.List grantTokens = new java.util.ArrayList(); /** *

* Specifies the encryption algorithm that KMS will use to encrypt the * plaintext message. The algorithm must be compatible with the KMS key that * you specify. *

*

* This parameter is required only for asymmetric KMS keys. The default * value, SYMMETRIC_DEFAULT, is the algorithm used for * symmetric encryption KMS keys. If you are using an asymmetric KMS key, we * recommend RSAES_OAEP_SHA_256. *

*

* The SM2PKE algorithm is only available in China Regions. *

*

* Constraints:
* Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, * RSAES_OAEP_SHA_256, SM2PKE */ private String encryptionAlgorithm; /** *

* 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; /** *

* Identifies the KMS key to use in the encryption operation. The KMS key * must have a KeyUsage of ENCRYPT_DECRYPT. 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. *

*

* Constraints:
* Length: 1 - 2048
* * @return

* Identifies the KMS key to use in the encryption operation. The * KMS key must have a KeyUsage of * ENCRYPT_DECRYPT. 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 keyId; } /** *

* Identifies the KMS key to use in the encryption operation. The KMS key * must have a KeyUsage of ENCRYPT_DECRYPT. 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. *

*

* Constraints:
* Length: 1 - 2048
* * @param keyId

* Identifies the KMS key to use in the encryption operation. The * KMS key must have a KeyUsage of * ENCRYPT_DECRYPT. 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 the KMS key to use in the encryption operation. The KMS key * must have a KeyUsage of ENCRYPT_DECRYPT. 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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 2048
* * @param keyId

* Identifies the KMS key to use in the encryption operation. The * KMS key must have a KeyUsage of * ENCRYPT_DECRYPT. 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 A reference to this updated object so that method calls can be * chained together. */ public EncryptRequest withKeyId(String keyId) { this.keyId = keyId; return this; } /** *

* Data to be encrypted. *

*

* Constraints:
* Length: 1 - 4096
* * @return

* Data to be encrypted. *

*/ public java.nio.ByteBuffer getPlaintext() { return plaintext; } /** *

* Data to be encrypted. *

*

* Constraints:
* Length: 1 - 4096
* * @param plaintext

* Data to be encrypted. *

*/ public void setPlaintext(java.nio.ByteBuffer plaintext) { this.plaintext = plaintext; } /** *

* Data to be encrypted. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 4096
* * @param plaintext

* Data to be encrypted. *

* @return A reference to this updated object so that method calls can be * chained together. */ public EncryptRequest withPlaintext(java.nio.ByteBuffer plaintext) { this.plaintext = plaintext; return this; } /** *

* Specifies the encryption context that will be used to encrypt the data. * An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The * standard asymmetric encryption algorithms and HMAC algorithms that KMS * uses do not support an encryption context. *

* *

* Do not include confidential or sensitive information in this field. This * field may be displayed in plaintext in CloudTrail logs and other output. *

* *

* An encryption context is a collection of non-secret key-value * pairs that represent 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 supported only on operations with symmetric * encryption KMS keys. On operations with symmetric encryption KMS keys, an * encryption context is optional, but it is strongly recommended. *

*

* For more information, see Encryption context in the Key Management Service Developer * Guide. *

* * @return

* Specifies the encryption context that will be used to encrypt the * data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS * key. The standard asymmetric encryption algorithms and HMAC * algorithms that KMS uses do not support an encryption context. *

* *

* Do not include confidential or sensitive information in this * field. This field may be displayed in plaintext in CloudTrail * logs and other output. *

* *

* An encryption context is a collection of non-secret * key-value pairs that represent 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 supported * only on operations with symmetric encryption KMS keys. On * operations with symmetric encryption KMS keys, an encryption * context is optional, but it is strongly recommended. *

*

* For more information, see Encryption context in the Key Management Service * Developer Guide. *

*/ public java.util.Map getEncryptionContext() { return encryptionContext; } /** *

* Specifies the encryption context that will be used to encrypt the data. * An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The * standard asymmetric encryption algorithms and HMAC algorithms that KMS * uses do not support an encryption context. *

* *

* Do not include confidential or sensitive information in this field. This * field may be displayed in plaintext in CloudTrail logs and other output. *

* *

* An encryption context is a collection of non-secret key-value * pairs that represent 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 supported only on operations with symmetric * encryption KMS keys. On operations with symmetric encryption KMS keys, an * encryption context is optional, but it is strongly recommended. *

*

* For more information, see Encryption context in the Key Management Service Developer * Guide. *

* * @param encryptionContext

* Specifies the encryption context that will be used to encrypt * the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS * key. The standard asymmetric encryption algorithms and HMAC * algorithms that KMS uses do not support an encryption context. *

* *

* Do not include confidential or sensitive information in this * field. This field may be displayed in plaintext in CloudTrail * logs and other output. *

* *

* An encryption context is a collection of non-secret * key-value pairs that represent 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 * supported only on operations with symmetric encryption KMS * keys. On operations with symmetric encryption KMS keys, an * encryption context is optional, but it is strongly * recommended. *

*

* For more information, see Encryption context in the Key Management Service * Developer Guide. *

*/ public void setEncryptionContext(java.util.Map encryptionContext) { this.encryptionContext = encryptionContext; } /** *

* Specifies the encryption context that will be used to encrypt the data. * An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The * standard asymmetric encryption algorithms and HMAC algorithms that KMS * uses do not support an encryption context. *

* *

* Do not include confidential or sensitive information in this field. This * field may be displayed in plaintext in CloudTrail logs and other output. *

* *

* An encryption context is a collection of non-secret key-value * pairs that represent 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 supported only on operations with symmetric * encryption KMS keys. On operations with symmetric encryption KMS keys, an * encryption context is optional, but it is strongly recommended. *

*

* For more information, see Encryption context in the Key Management Service Developer * Guide. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param encryptionContext

* Specifies the encryption context that will be used to encrypt * the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS * key. The standard asymmetric encryption algorithms and HMAC * algorithms that KMS uses do not support an encryption context. *

* *

* Do not include confidential or sensitive information in this * field. This field may be displayed in plaintext in CloudTrail * logs and other output. *

* *

* An encryption context is a collection of non-secret * key-value pairs that represent 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 * supported only on operations with symmetric encryption KMS * keys. On operations with symmetric encryption KMS keys, an * encryption context is optional, but it is strongly * recommended. *

*

* For more information, see Encryption context in the Key Management Service * Developer Guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public EncryptRequest withEncryptionContext(java.util.Map encryptionContext) { this.encryptionContext = encryptionContext; return this; } /** *

* Specifies the encryption context that will be used to encrypt the data. * An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The * standard asymmetric encryption algorithms and HMAC algorithms that KMS * uses do not support an encryption context. *

* *

* Do not include confidential or sensitive information in this field. This * field may be displayed in plaintext in CloudTrail logs and other output. *

* *

* An encryption context is a collection of non-secret key-value * pairs that represent 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 supported only on operations with symmetric * encryption KMS keys. On operations with symmetric encryption KMS keys, an * encryption context is optional, but it is strongly recommended. *

*

* For more information, see Encryption context in the Key Management Service Developer * Guide. *

*

* 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 EncryptRequest addEncryptionContextEntry(String key, String value) { if (null == this.encryptionContext) { this.encryptionContext = new java.util.HashMap(); } 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. *

* Returns a reference to this object so that method calls can be chained * together. */ public EncryptRequest clearEncryptionContextEntries() { this.encryptionContext = null; 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() { 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 java.util.ArrayList(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. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @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 A reference to this updated object so that method calls can be * chained together. */ public EncryptRequest withGrantTokens(String... grantTokens) { if (getGrantTokens() == null) { this.grantTokens = new java.util.ArrayList(grantTokens.length); } for (String value : grantTokens) { this.grantTokens.add(value); } 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. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @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 A reference to this updated object so that method calls can be * chained together. */ public EncryptRequest withGrantTokens(java.util.Collection grantTokens) { setGrantTokens(grantTokens); return this; } /** *

* Specifies the encryption algorithm that KMS will use to encrypt the * plaintext message. The algorithm must be compatible with the KMS key that * you specify. *

*

* This parameter is required only for asymmetric KMS keys. The default * value, SYMMETRIC_DEFAULT, is the algorithm used for * symmetric encryption KMS keys. If you are using an asymmetric KMS key, we * recommend RSAES_OAEP_SHA_256. *

*

* The SM2PKE algorithm is only available in China Regions. *

*

* Constraints:
* Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, * RSAES_OAEP_SHA_256, SM2PKE * * @return

* Specifies the encryption algorithm that KMS will use to encrypt * the plaintext message. The algorithm must be compatible with the * KMS key that you specify. *

*

* This parameter is required only for asymmetric KMS keys. The * default value, SYMMETRIC_DEFAULT, is the algorithm * used for symmetric encryption KMS keys. If you are using an * asymmetric KMS key, we recommend RSAES_OAEP_SHA_256. *

*

* The SM2PKE algorithm is only available in China Regions. *

* @see EncryptionAlgorithmSpec */ public String getEncryptionAlgorithm() { return encryptionAlgorithm; } /** *

* Specifies the encryption algorithm that KMS will use to encrypt the * plaintext message. The algorithm must be compatible with the KMS key that * you specify. *

*

* This parameter is required only for asymmetric KMS keys. The default * value, SYMMETRIC_DEFAULT, is the algorithm used for * symmetric encryption KMS keys. If you are using an asymmetric KMS key, we * recommend RSAES_OAEP_SHA_256. *

*

* The SM2PKE algorithm is only available in China Regions. *

*

* Constraints:
* Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, * RSAES_OAEP_SHA_256, SM2PKE * * @param encryptionAlgorithm

* Specifies the encryption algorithm that KMS will use to * encrypt the plaintext message. The algorithm must be * compatible with the KMS key that you specify. *

*

* This parameter is required only for asymmetric KMS keys. The * default value, SYMMETRIC_DEFAULT, is the * algorithm used for symmetric encryption KMS keys. If you are * using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256. *

*

* The SM2PKE algorithm is only available in China Regions. *

* @see EncryptionAlgorithmSpec */ public void setEncryptionAlgorithm(String encryptionAlgorithm) { this.encryptionAlgorithm = encryptionAlgorithm; } /** *

* Specifies the encryption algorithm that KMS will use to encrypt the * plaintext message. The algorithm must be compatible with the KMS key that * you specify. *

*

* This parameter is required only for asymmetric KMS keys. The default * value, SYMMETRIC_DEFAULT, is the algorithm used for * symmetric encryption KMS keys. If you are using an asymmetric KMS key, we * recommend RSAES_OAEP_SHA_256. *

*

* The SM2PKE algorithm is only available in China Regions. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, * RSAES_OAEP_SHA_256, SM2PKE * * @param encryptionAlgorithm

* Specifies the encryption algorithm that KMS will use to * encrypt the plaintext message. The algorithm must be * compatible with the KMS key that you specify. *

*

* This parameter is required only for asymmetric KMS keys. The * default value, SYMMETRIC_DEFAULT, is the * algorithm used for symmetric encryption KMS keys. If you are * using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256. *

*

* The SM2PKE algorithm is only available in China Regions. *

* @return A reference to this updated object so that method calls can be * chained together. * @see EncryptionAlgorithmSpec */ public EncryptRequest withEncryptionAlgorithm(String encryptionAlgorithm) { this.encryptionAlgorithm = encryptionAlgorithm; return this; } /** *

* Specifies the encryption algorithm that KMS will use to encrypt the * plaintext message. The algorithm must be compatible with the KMS key that * you specify. *

*

* This parameter is required only for asymmetric KMS keys. The default * value, SYMMETRIC_DEFAULT, is the algorithm used for * symmetric encryption KMS keys. If you are using an asymmetric KMS key, we * recommend RSAES_OAEP_SHA_256. *

*

* The SM2PKE algorithm is only available in China Regions. *

*

* Constraints:
* Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, * RSAES_OAEP_SHA_256, SM2PKE * * @param encryptionAlgorithm

* Specifies the encryption algorithm that KMS will use to * encrypt the plaintext message. The algorithm must be * compatible with the KMS key that you specify. *

*

* This parameter is required only for asymmetric KMS keys. The * default value, SYMMETRIC_DEFAULT, is the * algorithm used for symmetric encryption KMS keys. If you are * using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256. *

*

* The SM2PKE algorithm is only available in China Regions. *

* @see EncryptionAlgorithmSpec */ public void setEncryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm) { this.encryptionAlgorithm = encryptionAlgorithm.toString(); } /** *

* Specifies the encryption algorithm that KMS will use to encrypt the * plaintext message. The algorithm must be compatible with the KMS key that * you specify. *

*

* This parameter is required only for asymmetric KMS keys. The default * value, SYMMETRIC_DEFAULT, is the algorithm used for * symmetric encryption KMS keys. If you are using an asymmetric KMS key, we * recommend RSAES_OAEP_SHA_256. *

*

* The SM2PKE algorithm is only available in China Regions. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, * RSAES_OAEP_SHA_256, SM2PKE * * @param encryptionAlgorithm

* Specifies the encryption algorithm that KMS will use to * encrypt the plaintext message. The algorithm must be * compatible with the KMS key that you specify. *

*

* This parameter is required only for asymmetric KMS keys. The * default value, SYMMETRIC_DEFAULT, is the * algorithm used for symmetric encryption KMS keys. If you are * using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256. *

*

* The SM2PKE algorithm is only available in China Regions. *

* @return A reference to this updated object so that method calls can be * chained together. * @see EncryptionAlgorithmSpec */ public EncryptRequest withEncryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm) { this.encryptionAlgorithm = encryptionAlgorithm.toString(); 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 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 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. *

*/ 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. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @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 A reference to this updated object so that method calls can be * chained together. */ public EncryptRequest withDryRun(Boolean dryRun) { this.dryRun = dryRun; 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 (getPlaintext() != null) sb.append("Plaintext: " + getPlaintext() + ","); if (getEncryptionContext() != null) sb.append("EncryptionContext: " + getEncryptionContext() + ","); if (getGrantTokens() != null) sb.append("GrantTokens: " + getGrantTokens() + ","); if (getEncryptionAlgorithm() != null) sb.append("EncryptionAlgorithm: " + getEncryptionAlgorithm() + ","); if (getDryRun() != null) sb.append("DryRun: " + getDryRun()); 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 + ((getPlaintext() == null) ? 0 : getPlaintext().hashCode()); hashCode = prime * hashCode + ((getEncryptionContext() == null) ? 0 : getEncryptionContext().hashCode()); hashCode = prime * hashCode + ((getGrantTokens() == null) ? 0 : getGrantTokens().hashCode()); hashCode = prime * hashCode + ((getEncryptionAlgorithm() == null) ? 0 : getEncryptionAlgorithm().hashCode()); hashCode = prime * hashCode + ((getDryRun() == null) ? 0 : getDryRun().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof EncryptRequest == false) return false; EncryptRequest other = (EncryptRequest) obj; if (other.getKeyId() == null ^ this.getKeyId() == null) return false; if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false) return false; if (other.getPlaintext() == null ^ this.getPlaintext() == null) return false; if (other.getPlaintext() != null && other.getPlaintext().equals(this.getPlaintext()) == 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.getGrantTokens() == null ^ this.getGrantTokens() == null) return false; if (other.getGrantTokens() != null && other.getGrantTokens().equals(this.getGrantTokens()) == false) return false; if (other.getEncryptionAlgorithm() == null ^ this.getEncryptionAlgorithm() == null) return false; if (other.getEncryptionAlgorithm() != null && other.getEncryptionAlgorithm().equals(this.getEncryptionAlgorithm()) == false) return false; if (other.getDryRun() == null ^ this.getDryRun() == null) return false; if (other.getDryRun() != null && other.getDryRun().equals(this.getDryRun()) == false) return false; return true; } }