All Downloads are FREE. Search and download functionalities are using the official Maven repository.

software.amazon.awssdk.services.kms.model.GenerateDataKeyWithoutPlaintextRequest Maven / Gradle / Ivy

Go to download

The AWS Java SDK for AWS KMS module holds the client classes that are used for communicating with AWS Key Management Service

There is a newer version: 2.29.39
Show newest version
/*
 * 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.util.Arrays;
import java.util.Collection;
import java.util.Collections;
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.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 GenerateDataKeyWithoutPlaintextRequest extends KmsRequest implements
        ToCopyableBuilder {
    private static final SdkField KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("KeyId")
            .getter(getter(GenerateDataKeyWithoutPlaintextRequest::keyId)).setter(setter(Builder::keyId))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyId").build()).build();

    private static final SdkField> ENCRYPTION_CONTEXT_FIELD = SdkField
            .> builder(MarshallingType.MAP)
            .memberName("EncryptionContext")
            .getter(getter(GenerateDataKeyWithoutPlaintextRequest::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 KEY_SPEC_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("KeySpec").getter(getter(GenerateDataKeyWithoutPlaintextRequest::keySpecAsString))
            .setter(setter(Builder::keySpec))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeySpec").build()).build();

    private static final SdkField NUMBER_OF_BYTES_FIELD = SdkField. builder(MarshallingType.INTEGER)
            .memberName("NumberOfBytes").getter(getter(GenerateDataKeyWithoutPlaintextRequest::numberOfBytes))
            .setter(setter(Builder::numberOfBytes))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NumberOfBytes").build()).build();

    private static final SdkField> GRANT_TOKENS_FIELD = SdkField
            .> builder(MarshallingType.LIST)
            .memberName("GrantTokens")
            .getter(getter(GenerateDataKeyWithoutPlaintextRequest::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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(KEY_ID_FIELD,
            ENCRYPTION_CONTEXT_FIELD, KEY_SPEC_FIELD, NUMBER_OF_BYTES_FIELD, GRANT_TOKENS_FIELD));

    private final String keyId;

    private final Map encryptionContext;

    private final String keySpec;

    private final Integer numberOfBytes;

    private final List grantTokens;

    private GenerateDataKeyWithoutPlaintextRequest(BuilderImpl builder) {
        super(builder);
        this.keyId = builder.keyId;
        this.encryptionContext = builder.encryptionContext;
        this.keySpec = builder.keySpec;
        this.numberOfBytes = builder.numberOfBytes;
        this.grantTokens = builder.grantTokens;
    }

    /**
     * 

* Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric KMS key * or a KMS key in a custom key store. To get the type and origin of your 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 Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric * KMS key or a KMS key in a custom key store. To get the type and origin of your 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; } /** * 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 when encrypting the data key. *

*

* 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 when encrypting the data key.

*

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

* The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 * to generate a 256-bit symmetric key. *

*

* If the service returns an enum value that is not available in the current SDK version, {@link #keySpec} will * return {@link DataKeySpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from * {@link #keySpecAsString}. *

* * @return The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or * AES_256 to generate a 256-bit symmetric key. * @see DataKeySpec */ public final DataKeySpec keySpec() { return DataKeySpec.fromValue(keySpec); } /** *

* The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 * to generate a 256-bit symmetric key. *

*

* If the service returns an enum value that is not available in the current SDK version, {@link #keySpec} will * return {@link DataKeySpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from * {@link #keySpecAsString}. *

* * @return The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or * AES_256 to generate a 256-bit symmetric key. * @see DataKeySpec */ public final String keySpecAsString() { return keySpec; } /** *

* The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is * 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the * KeySpec field instead of this one. *

* * @return The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 * bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you * use the KeySpec field instead of this one. */ public final Integer numberOfBytes() { return numberOfBytes; } /** * 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; } @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(hasEncryptionContext() ? encryptionContext() : null); hashCode = 31 * hashCode + Objects.hashCode(keySpecAsString()); hashCode = 31 * hashCode + Objects.hashCode(numberOfBytes()); hashCode = 31 * hashCode + Objects.hashCode(hasGrantTokens() ? grantTokens() : null); 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 GenerateDataKeyWithoutPlaintextRequest)) { return false; } GenerateDataKeyWithoutPlaintextRequest other = (GenerateDataKeyWithoutPlaintextRequest) obj; return Objects.equals(keyId(), other.keyId()) && hasEncryptionContext() == other.hasEncryptionContext() && Objects.equals(encryptionContext(), other.encryptionContext()) && Objects.equals(keySpecAsString(), other.keySpecAsString()) && Objects.equals(numberOfBytes(), other.numberOfBytes()) && hasGrantTokens() == other.hasGrantTokens() && Objects.equals(grantTokens(), other.grantTokens()); } /** * 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("GenerateDataKeyWithoutPlaintextRequest").add("KeyId", keyId()) .add("EncryptionContext", hasEncryptionContext() ? encryptionContext() : null).add("KeySpec", keySpecAsString()) .add("NumberOfBytes", numberOfBytes()).add("GrantTokens", hasGrantTokens() ? grantTokens() : null).build(); } public final Optional getValueForField(String fieldName, Class clazz) { switch (fieldName) { case "KeyId": return Optional.ofNullable(clazz.cast(keyId())); case "EncryptionContext": return Optional.ofNullable(clazz.cast(encryptionContext())); case "KeySpec": return Optional.ofNullable(clazz.cast(keySpecAsString())); case "NumberOfBytes": return Optional.ofNullable(clazz.cast(numberOfBytes())); case "GrantTokens": return Optional.ofNullable(clazz.cast(grantTokens())); default: return Optional.empty(); } } @Override public final List> sdkFields() { return SDK_FIELDS; } private static Function getter(Function g) { return obj -> g.apply((GenerateDataKeyWithoutPlaintextRequest) obj); } private static BiConsumer setter(BiConsumer s) { return (obj, val) -> s.accept((Builder) obj, val); } public interface Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder { /** *

* Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric KMS * key or a KMS key in a custom key store. To get the type and origin of your 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 * Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an * asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your 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); /** *

* Specifies the encryption context that will be used when encrypting the data key. *

*

* 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 when encrypting the data key.

*

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

* The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or * AES_256 to generate a 256-bit symmetric key. *

* * @param keySpec * The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or * AES_256 to generate a 256-bit symmetric key. * @see DataKeySpec * @return Returns a reference to this object so that method calls can be chained together. * @see DataKeySpec */ Builder keySpec(String keySpec); /** *

* The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or * AES_256 to generate a 256-bit symmetric key. *

* * @param keySpec * The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or * AES_256 to generate a 256-bit symmetric key. * @see DataKeySpec * @return Returns a reference to this object so that method calls can be chained together. * @see DataKeySpec */ Builder keySpec(DataKeySpec keySpec); /** *

* The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes * is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the * KeySpec field instead of this one. *

* * @param numberOfBytes * The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 * bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you * use the KeySpec field instead of this one. * @return Returns a reference to this object so that method calls can be chained together. */ Builder numberOfBytes(Integer numberOfBytes); /** *

* 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); @Override Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration); @Override Builder overrideConfiguration(Consumer builderConsumer); } static final class BuilderImpl extends KmsRequest.BuilderImpl implements Builder { private String keyId; private Map encryptionContext = DefaultSdkAutoConstructMap.getInstance(); private String keySpec; private Integer numberOfBytes; private List grantTokens = DefaultSdkAutoConstructList.getInstance(); private BuilderImpl() { } private BuilderImpl(GenerateDataKeyWithoutPlaintextRequest model) { super(model); keyId(model.keyId); encryptionContext(model.encryptionContext); keySpec(model.keySpec); numberOfBytes(model.numberOfBytes); grantTokens(model.grantTokens); } 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 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 String getKeySpec() { return keySpec; } public final void setKeySpec(String keySpec) { this.keySpec = keySpec; } @Override public final Builder keySpec(String keySpec) { this.keySpec = keySpec; return this; } @Override public final Builder keySpec(DataKeySpec keySpec) { this.keySpec(keySpec == null ? null : keySpec.toString()); return this; } public final Integer getNumberOfBytes() { return numberOfBytes; } public final void setNumberOfBytes(Integer numberOfBytes) { this.numberOfBytes = numberOfBytes; } @Override public final Builder numberOfBytes(Integer numberOfBytes) { this.numberOfBytes = numberOfBytes; 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; } @Override public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) { super.overrideConfiguration(overrideConfiguration); return this; } @Override public Builder overrideConfiguration(Consumer builderConsumer) { super.overrideConfiguration(builderConsumer); return this; } @Override public GenerateDataKeyWithoutPlaintextRequest build() { return new GenerateDataKeyWithoutPlaintextRequest(this); } @Override public List> sdkFields() { return SDK_FIELDS; } } }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy