software.amazon.awssdk.services.ec2.model.ModifyEbsDefaultKmsKeyIdRequest Maven / Gradle / Ivy
/*
* 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.ec2.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
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.LocationTrait;
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 ModifyEbsDefaultKmsKeyIdRequest extends Ec2Request implements
ToCopyableBuilder {
private static final SdkField KMS_KEY_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("KmsKeyId")
.getter(getter(ModifyEbsDefaultKmsKeyIdRequest::kmsKeyId))
.setter(setter(Builder::kmsKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KmsKeyId")
.unmarshallLocationName("KmsKeyId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(KMS_KEY_ID_FIELD));
private final String kmsKeyId;
private ModifyEbsDefaultKmsKeyIdRequest(BuilderImpl builder) {
super(builder);
this.kmsKeyId = builder.kmsKeyId;
}
/**
*
* The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS
* encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is
* specified, the encrypted state must be true.
*
*
* You can specify the CMK using any of the following:
*
*
* -
*
* Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Key alias. For example, alias/ExampleAlias.
*
*
* -
*
* Key ARN. For example,
* arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
*
*
* -
*
* Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*
*
*
*
* AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the
* action can appear to complete, but eventually fails.
*
*
* Amazon EBS does not support asymmetric CMKs.
*
*
* @return The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon
* EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If
* KmsKeyId is specified, the encrypted state must be true.
*
* You can specify the CMK using any of the following:
*
*
* -
*
* Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Key alias. For example, alias/ExampleAlias.
*
*
* -
*
* Key ARN. For example,
* arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
*
*
* -
*
* Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*
*
*
*
* AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not
* valid, the action can appear to complete, but eventually fails.
*
*
* Amazon EBS does not support asymmetric CMKs.
*/
public String kmsKeyId() {
return kmsKeyId;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(kmsKeyId());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ModifyEbsDefaultKmsKeyIdRequest)) {
return false;
}
ModifyEbsDefaultKmsKeyIdRequest other = (ModifyEbsDefaultKmsKeyIdRequest) obj;
return Objects.equals(kmsKeyId(), other.kmsKeyId());
}
/**
* 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 String toString() {
return ToString.builder("ModifyEbsDefaultKmsKeyIdRequest").add("KmsKeyId", kmsKeyId()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "KmsKeyId":
return Optional.ofNullable(clazz.cast(kmsKeyId()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ModifyEbsDefaultKmsKeyIdRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS
* encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If
* KmsKeyId is specified, the encrypted state must be true.
*
*
* You can specify the CMK using any of the following:
*
*
* -
*
* Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Key alias. For example, alias/ExampleAlias.
*
*
* -
*
* Key ARN. For example,
* arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
*
*
* -
*
* Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*
*
*
*
* AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid,
* the action can appear to complete, but eventually fails.
*
*
* Amazon EBS does not support asymmetric CMKs.
*
*
* @param kmsKeyId
* The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon
* EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If
* KmsKeyId is specified, the encrypted state must be true.
*
* You can specify the CMK using any of the following:
*
*
* -
*
* Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Key alias. For example, alias/ExampleAlias.
*
*
* -
*
* Key ARN. For example,
* arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
*
*
* -
*
* Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*
*
*
*
* AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not
* valid, the action can appear to complete, but eventually fails.
*
*
* Amazon EBS does not support asymmetric CMKs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kmsKeyId(String kmsKeyId);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends Ec2Request.BuilderImpl implements Builder {
private String kmsKeyId;
private BuilderImpl() {
}
private BuilderImpl(ModifyEbsDefaultKmsKeyIdRequest model) {
super(model);
kmsKeyId(model.kmsKeyId);
}
public final String getKmsKeyId() {
return kmsKeyId;
}
@Override
public final Builder kmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
return this;
}
public final void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ModifyEbsDefaultKmsKeyIdRequest build() {
return new ModifyEbsDefaultKmsKeyIdRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}