@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class EncryptRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
EncryptRequest() |
Modifier and Type | Method and Description |
---|---|
EncryptRequest |
addEncryptionContextEntry(String key,
String value)
Add a single EncryptionContext entry
|
EncryptRequest |
clearEncryptionContextEntries()
Removes all the entries added into EncryptionContext.
|
EncryptRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Boolean |
getDryRun()
Checks if your request will succeed.
|
String |
getEncryptionAlgorithm()
Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.
|
Map<String,String> |
getEncryptionContext()
Specifies the encryption context that will be used to encrypt the data.
|
List<String> |
getGrantTokens()
A list of grant tokens.
|
String |
getKeyId()
Identifies the KMS key to use in the encryption operation.
|
ByteBuffer |
getPlaintext()
Data to be encrypted.
|
int |
hashCode() |
Boolean |
isDryRun()
Checks if your request will succeed.
|
void |
setDryRun(Boolean dryRun)
Checks if your request will succeed.
|
void |
setEncryptionAlgorithm(String encryptionAlgorithm)
Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.
|
void |
setEncryptionContext(Map<String,String> encryptionContext)
Specifies the encryption context that will be used to encrypt the data.
|
void |
setGrantTokens(Collection<String> grantTokens)
A list of grant tokens.
|
void |
setKeyId(String keyId)
Identifies the KMS key to use in the encryption operation.
|
void |
setPlaintext(ByteBuffer plaintext)
Data to be encrypted.
|
String |
toString()
Returns a string representation of this object.
|
EncryptRequest |
withDryRun(Boolean dryRun)
Checks if your request will succeed.
|
EncryptRequest |
withEncryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)
Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.
|
EncryptRequest |
withEncryptionAlgorithm(String encryptionAlgorithm)
Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.
|
EncryptRequest |
withEncryptionContext(Map<String,String> encryptionContext)
Specifies the encryption context that will be used to encrypt the data.
|
EncryptRequest |
withGrantTokens(Collection<String> grantTokens)
A list of grant tokens.
|
EncryptRequest |
withGrantTokens(String... grantTokens)
A list of grant tokens.
|
EncryptRequest |
withKeyId(String keyId)
Identifies the KMS key to use in the encryption operation.
|
EncryptRequest |
withPlaintext(ByteBuffer plaintext)
Data to be encrypted.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setKeyId(String 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.
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 String getKeyId()
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.
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 EncryptRequest withKeyId(String 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.
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 setPlaintext(ByteBuffer plaintext)
Data to be encrypted.
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.
plaintext
- Data to be encrypted.public ByteBuffer getPlaintext()
Data to be encrypted.
ByteBuffer
s are stateful. Calling their get
methods changes their position
. We recommend
using ByteBuffer.asReadOnlyBuffer()
to create a read-only view of the buffer with an independent
position
, and calling get
methods on this rather than directly on the returned ByteBuffer
.
Doing so will ensure that anyone else using the ByteBuffer
will not be affected by changes to the
position
.
public EncryptRequest withPlaintext(ByteBuffer plaintext)
Data to be encrypted.
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.
plaintext
- Data to be encrypted.public Map<String,String> getEncryptionContext()
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.
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(Map<String,String> 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.
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 EncryptRequest withEncryptionContext(Map<String,String> 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.
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 EncryptRequest addEncryptionContextEntry(String key, String value)
public EncryptRequest clearEncryptionContextEntries()
public List<String> getGrantTokens()
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.
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(Collection<String> 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.
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 EncryptRequest withGrantTokens(String... grantTokens)
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setGrantTokens(java.util.Collection)
or withGrantTokens(java.util.Collection)
if you want to
override the existing values.
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 EncryptRequest withGrantTokens(Collection<String> 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.
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 setEncryptionAlgorithm(String 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.
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.
EncryptionAlgorithmSpec
public String getEncryptionAlgorithm()
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.
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.
EncryptionAlgorithmSpec
public EncryptRequest withEncryptionAlgorithm(String 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.
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.
EncryptionAlgorithmSpec
public EncryptRequest withEncryptionAlgorithm(EncryptionAlgorithmSpec 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.
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.
EncryptionAlgorithmSpec
public void setDryRun(Boolean 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.
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 Boolean getDryRun()
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.
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 EncryptRequest withDryRun(Boolean 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.
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 Boolean isDryRun()
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.
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 String toString()
toString
in class Object
Object.toString()
public EncryptRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()