@Generated(value="software.amazon.awssdk:codegen") public final class EncryptRequest extends KmsRequest implements ToCopyableBuilder<EncryptRequest.Builder,EncryptRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
EncryptRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static EncryptRequest.Builder |
builder() |
EncryptionAlgorithmSpec |
encryptionAlgorithm()
Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.
|
String |
encryptionAlgorithmAsString()
Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.
|
Map<String,String> |
encryptionContext()
Specifies the encryption context that will be used to encrypt the data.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
List<String> |
grantTokens()
A list of grant tokens.
|
boolean |
hasEncryptionContext()
For responses, this returns true if the service returned a value for the EncryptionContext property.
|
boolean |
hasGrantTokens()
For responses, this returns true if the service returned a value for the GrantTokens property.
|
int |
hashCode() |
String |
keyId()
Identifies the KMS key to use in the encryption operation.
|
SdkBytes |
plaintext()
Data to be encrypted.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends EncryptRequest.Builder> |
serializableBuilderClass() |
EncryptRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final 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.
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 final SdkBytes plaintext()
Data to be encrypted.
public final boolean hasEncryptionContext()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasEncryptionContext()
method.
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 final boolean hasGrantTokens()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasGrantTokens()
method.
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 final 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.
If the service returns an enum value that is not available in the current SDK version,
encryptionAlgorithm
will return EncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from encryptionAlgorithmAsString()
.
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.
EncryptionAlgorithmSpec
public final String encryptionAlgorithmAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
encryptionAlgorithm
will return EncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from encryptionAlgorithmAsString()
.
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.
EncryptionAlgorithmSpec
public EncryptRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<EncryptRequest.Builder,EncryptRequest>
toBuilder
in class KmsRequest
public static EncryptRequest.Builder builder()
public static Class<? extends EncryptRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2022. All rights reserved.