software.amazon.awssdk.services.kms.model.UpdateAliasRequest 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.util.Arrays;
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.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 UpdateAliasRequest extends KmsRequest implements
ToCopyableBuilder {
private static final SdkField ALIAS_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AliasName").getter(getter(UpdateAliasRequest::aliasName)).setter(setter(Builder::aliasName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AliasName").build()).build();
private static final SdkField TARGET_KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TargetKeyId").getter(getter(UpdateAliasRequest::targetKeyId)).setter(setter(Builder::targetKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetKeyId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ALIAS_NAME_FIELD,
TARGET_KEY_ID_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("AliasName", ALIAS_NAME_FIELD);
put("TargetKeyId", TARGET_KEY_ID_FIELD);
}
});
private final String aliasName;
private final String targetKeyId;
private UpdateAliasRequest(BuilderImpl builder) {
super(builder);
this.aliasName = builder.aliasName;
this.targetKeyId = builder.targetKeyId;
}
/**
*
* Identifies the alias that is changing its KMS key. This value must begin with alias/ followed by the
* alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias
* name.
*
*
*
* Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in
* CloudTrail logs and other output.
*
*
*
* @return Identifies the alias that is changing its KMS key. This value must begin with alias/
* followed by the alias name, such as alias/ExampleAlias. You cannot use
* UpdateAlias to change the alias name.
*
* Do not include confidential or sensitive information in this field. This field may be displayed in
* plaintext in CloudTrail logs and other output.
*
*/
public final String aliasName() {
return aliasName;
}
/**
*
* Identifies the customer managed key
* to associate with the alias. You don't have permission to associate an alias with an Amazon Web Services
* managed key.
*
*
* The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key
* must be the same type as the current target KMS key (both symmetric or both asymmetric or both HMAC) and they
* must have the same key usage.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*
*
* To verify that the alias is mapped to the correct KMS key, use ListAliases.
*
*
* @return Identifies the customer managed
* key to associate with the alias. You don't have permission to associate an alias with an Amazon Web
* Services managed key.
*
* The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target
* KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric or both
* HMAC) and they must have the same key usage.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*
*
* To verify that the alias is mapped to the correct KMS key, use ListAliases.
*/
public final String targetKeyId() {
return targetKeyId;
}
@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(aliasName());
hashCode = 31 * hashCode + Objects.hashCode(targetKeyId());
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 UpdateAliasRequest)) {
return false;
}
UpdateAliasRequest other = (UpdateAliasRequest) obj;
return Objects.equals(aliasName(), other.aliasName()) && Objects.equals(targetKeyId(), other.targetKeyId());
}
/**
* 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("UpdateAliasRequest").add("AliasName", aliasName()).add("TargetKeyId", targetKeyId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AliasName":
return Optional.ofNullable(clazz.cast(aliasName()));
case "TargetKeyId":
return Optional.ofNullable(clazz.cast(targetKeyId()));
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((UpdateAliasRequest) 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 alias that is changing its KMS key. This value must begin with alias/ followed by
* the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change
* the alias name.
*
*
*
* Do not include confidential or sensitive information in this field. This field may be displayed in plaintext
* in CloudTrail logs and other output.
*
*
*
* @param aliasName
* Identifies the alias that is changing its KMS key. This value must begin with alias/
* followed by the alias name, such as alias/ExampleAlias. You cannot use
* UpdateAlias to change the alias name.
*
* Do not include confidential or sensitive information in this field. This field may be displayed in
* plaintext in CloudTrail logs and other output.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder aliasName(String aliasName);
/**
*
* Identifies the customer managed
* key to associate with the alias. You don't have permission to associate an alias with an Amazon Web
* Services managed key.
*
*
* The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS
* key must be the same type as the current target KMS key (both symmetric or both asymmetric or both HMAC) and
* they must have the same key usage.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*
*
* To verify that the alias is mapped to the correct KMS key, use ListAliases.
*
*
* @param targetKeyId
* Identifies the customer
* managed key to associate with the alias. You don't have permission to associate an alias with an
* Amazon
* Web Services managed key.
*
* The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new
* target KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric
* or both HMAC) and they must have the same key usage.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*
*
* To verify that the alias is mapped to the correct KMS key, use ListAliases.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetKeyId(String targetKeyId);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends KmsRequest.BuilderImpl implements Builder {
private String aliasName;
private String targetKeyId;
private BuilderImpl() {
}
private BuilderImpl(UpdateAliasRequest model) {
super(model);
aliasName(model.aliasName);
targetKeyId(model.targetKeyId);
}
public final String getAliasName() {
return aliasName;
}
public final void setAliasName(String aliasName) {
this.aliasName = aliasName;
}
@Override
public final Builder aliasName(String aliasName) {
this.aliasName = aliasName;
return this;
}
public final String getTargetKeyId() {
return targetKeyId;
}
public final void setTargetKeyId(String targetKeyId) {
this.targetKeyId = targetKeyId;
}
@Override
public final Builder targetKeyId(String targetKeyId) {
this.targetKeyId = targetKeyId;
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 UpdateAliasRequest build() {
return new UpdateAliasRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}