software.amazon.awssdk.services.kms.model.EncryptRequest Maven / Gradle / Ivy
Show all versions of kms Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.kms.model;
import java.nio.ByteBuffer;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkBytes;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class EncryptRequest extends KmsRequest implements ToCopyableBuilder {
private static final SdkField KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("KeyId")
.getter(getter(EncryptRequest::keyId)).setter(setter(Builder::keyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyId").build()).build();
private static final SdkField PLAINTEXT_FIELD = SdkField. builder(MarshallingType.SDK_BYTES)
.memberName("Plaintext").getter(getter(EncryptRequest::plaintext)).setter(setter(Builder::plaintext))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Plaintext").build()).build();
private static final SdkField> ENCRYPTION_CONTEXT_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("EncryptionContext")
.getter(getter(EncryptRequest::encryptionContext))
.setter(setter(Builder::encryptionContext))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EncryptionContext").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField> GRANT_TOKENS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("GrantTokens")
.getter(getter(EncryptRequest::grantTokens))
.setter(setter(Builder::grantTokens))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GrantTokens").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField ENCRYPTION_ALGORITHM_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EncryptionAlgorithm").getter(getter(EncryptRequest::encryptionAlgorithmAsString))
.setter(setter(Builder::encryptionAlgorithm))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EncryptionAlgorithm").build())
.build();
private static final SdkField DRY_RUN_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("DryRun").getter(getter(EncryptRequest::dryRun)).setter(setter(Builder::dryRun))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DryRun").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(KEY_ID_FIELD, PLAINTEXT_FIELD,
ENCRYPTION_CONTEXT_FIELD, GRANT_TOKENS_FIELD, ENCRYPTION_ALGORITHM_FIELD, DRY_RUN_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("KeyId", KEY_ID_FIELD);
put("Plaintext", PLAINTEXT_FIELD);
put("EncryptionContext", ENCRYPTION_CONTEXT_FIELD);
put("GrantTokens", GRANT_TOKENS_FIELD);
put("EncryptionAlgorithm", ENCRYPTION_ALGORITHM_FIELD);
put("DryRun", DRY_RUN_FIELD);
}
});
private final String keyId;
private final SdkBytes plaintext;
private final Map encryptionContext;
private final List grantTokens;
private final String encryptionAlgorithm;
private final Boolean dryRun;
private EncryptRequest(BuilderImpl builder) {
super(builder);
this.keyId = builder.keyId;
this.plaintext = builder.plaintext;
this.encryptionContext = builder.encryptionContext;
this.grantTokens = builder.grantTokens;
this.encryptionAlgorithm = builder.encryptionAlgorithm;
this.dryRun = builder.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.
*
*
* @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 final String keyId() {
return keyId;
}
/**
*
* Data to be encrypted.
*
*
* @return Data to be encrypted.
*/
public final SdkBytes plaintext() {
return plaintext;
}
/**
* For responses, this returns true if the service returned a value for the EncryptionContext property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code 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 boolean hasEncryptionContext() {
return encryptionContext != null && !(encryptionContext instanceof SdkAutoConstructMap);
}
/**
*
* 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.
*
*
* 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 {@link #hasEncryptionContext} method.
*
*
* @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 final Map encryptionContext() {
return encryptionContext;
}
/**
* For responses, this returns true if the service returned a value for the GrantTokens property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code 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 boolean hasGrantTokens() {
return grantTokens != null && !(grantTokens instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasGrantTokens} method.
*
*
* @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 final List grantTokens() {
return grantTokens;
}
/**
*
* 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.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #encryptionAlgorithmAsString}.
*
*
* @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 final EncryptionAlgorithmSpec encryptionAlgorithm() {
return EncryptionAlgorithmSpec.fromValue(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.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #encryptionAlgorithmAsString}.
*
*
* @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 final String encryptionAlgorithmAsString() {
return 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.
*
*
* @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 final Boolean dryRun() {
return dryRun;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(keyId());
hashCode = 31 * hashCode + Objects.hashCode(plaintext());
hashCode = 31 * hashCode + Objects.hashCode(hasEncryptionContext() ? encryptionContext() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasGrantTokens() ? grantTokens() : null);
hashCode = 31 * hashCode + Objects.hashCode(encryptionAlgorithmAsString());
hashCode = 31 * hashCode + Objects.hashCode(dryRun());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof EncryptRequest)) {
return false;
}
EncryptRequest other = (EncryptRequest) obj;
return Objects.equals(keyId(), other.keyId()) && Objects.equals(plaintext(), other.plaintext())
&& hasEncryptionContext() == other.hasEncryptionContext()
&& Objects.equals(encryptionContext(), other.encryptionContext()) && hasGrantTokens() == other.hasGrantTokens()
&& Objects.equals(grantTokens(), other.grantTokens())
&& Objects.equals(encryptionAlgorithmAsString(), other.encryptionAlgorithmAsString())
&& Objects.equals(dryRun(), other.dryRun());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("EncryptRequest").add("KeyId", keyId())
.add("Plaintext", plaintext() == null ? null : "*** Sensitive Data Redacted ***")
.add("EncryptionContext", hasEncryptionContext() ? encryptionContext() : null)
.add("GrantTokens", hasGrantTokens() ? grantTokens() : null)
.add("EncryptionAlgorithm", encryptionAlgorithmAsString()).add("DryRun", dryRun()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "KeyId":
return Optional.ofNullable(clazz.cast(keyId()));
case "Plaintext":
return Optional.ofNullable(clazz.cast(plaintext()));
case "EncryptionContext":
return Optional.ofNullable(clazz.cast(encryptionContext()));
case "GrantTokens":
return Optional.ofNullable(clazz.cast(grantTokens()));
case "EncryptionAlgorithm":
return Optional.ofNullable(clazz.cast(encryptionAlgorithmAsString()));
case "DryRun":
return Optional.ofNullable(clazz.cast(dryRun()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((EncryptRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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.
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
Builder keyId(String keyId);
/**
*
* Data to be encrypted.
*
*
* @param plaintext
* Data to be encrypted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder plaintext(SdkBytes 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.
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
Builder encryptionContext(Map encryptionContext);
/**
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grantTokens(Collection 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grantTokens(String... grantTokens);
/**
*
* 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.
*
*
* @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
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionAlgorithmSpec
*/
Builder encryptionAlgorithm(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.
*
*
* @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
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionAlgorithmSpec
*/
Builder encryptionAlgorithm(EncryptionAlgorithmSpec 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.
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
Builder dryRun(Boolean dryRun);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends KmsRequest.BuilderImpl implements Builder {
private String keyId;
private SdkBytes plaintext;
private Map encryptionContext = DefaultSdkAutoConstructMap.getInstance();
private List grantTokens = DefaultSdkAutoConstructList.getInstance();
private String encryptionAlgorithm;
private Boolean dryRun;
private BuilderImpl() {
}
private BuilderImpl(EncryptRequest model) {
super(model);
keyId(model.keyId);
plaintext(model.plaintext);
encryptionContext(model.encryptionContext);
grantTokens(model.grantTokens);
encryptionAlgorithm(model.encryptionAlgorithm);
dryRun(model.dryRun);
}
public final String getKeyId() {
return keyId;
}
public final void setKeyId(String keyId) {
this.keyId = keyId;
}
@Override
public final Builder keyId(String keyId) {
this.keyId = keyId;
return this;
}
public final ByteBuffer getPlaintext() {
return plaintext == null ? null : plaintext.asByteBuffer();
}
public final void setPlaintext(ByteBuffer plaintext) {
plaintext(plaintext == null ? null : SdkBytes.fromByteBuffer(plaintext));
}
@Override
public final Builder plaintext(SdkBytes plaintext) {
this.plaintext = plaintext;
return this;
}
public final Map getEncryptionContext() {
if (encryptionContext instanceof SdkAutoConstructMap) {
return null;
}
return encryptionContext;
}
public final void setEncryptionContext(Map encryptionContext) {
this.encryptionContext = EncryptionContextTypeCopier.copy(encryptionContext);
}
@Override
public final Builder encryptionContext(Map encryptionContext) {
this.encryptionContext = EncryptionContextTypeCopier.copy(encryptionContext);
return this;
}
public final Collection getGrantTokens() {
if (grantTokens instanceof SdkAutoConstructList) {
return null;
}
return grantTokens;
}
public final void setGrantTokens(Collection grantTokens) {
this.grantTokens = GrantTokenListCopier.copy(grantTokens);
}
@Override
public final Builder grantTokens(Collection grantTokens) {
this.grantTokens = GrantTokenListCopier.copy(grantTokens);
return this;
}
@Override
@SafeVarargs
public final Builder grantTokens(String... grantTokens) {
grantTokens(Arrays.asList(grantTokens));
return this;
}
public final String getEncryptionAlgorithm() {
return encryptionAlgorithm;
}
public final void setEncryptionAlgorithm(String encryptionAlgorithm) {
this.encryptionAlgorithm = encryptionAlgorithm;
}
@Override
public final Builder encryptionAlgorithm(String encryptionAlgorithm) {
this.encryptionAlgorithm = encryptionAlgorithm;
return this;
}
@Override
public final Builder encryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm) {
this.encryptionAlgorithm(encryptionAlgorithm == null ? null : encryptionAlgorithm.toString());
return this;
}
public final Boolean getDryRun() {
return dryRun;
}
public final void setDryRun(Boolean dryRun) {
this.dryRun = dryRun;
}
@Override
public final Builder dryRun(Boolean dryRun) {
this.dryRun = dryRun;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public EncryptRequest build() {
return new EncryptRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}