/* * Copyright 2018-2023 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 com.amazonaws.services.kms.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class UpdateAliasRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* 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. *

* */ private 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: *

* *

* 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. *

*/ private String 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. *

* * * @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. *

*/ public void setAliasName(String aliasName) { this.aliasName = 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 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 String getAliasName() { return this.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. *

* * * @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. */ public UpdateAliasRequest withAliasName(String aliasName) { setAliasName(aliasName); return this; } /** *

* 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. */ public void setTargetKeyId(String targetKeyId) { this.targetKeyId = 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 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 String getTargetKeyId() { return this.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. *

* * @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. */ public UpdateAliasRequest withTargetKeyId(String targetKeyId) { setTargetKeyId(targetKeyId); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getAliasName() != null) sb.append("AliasName: ").append(getAliasName()).append(","); if (getTargetKeyId() != null) sb.append("TargetKeyId: ").append(getTargetKeyId()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof UpdateAliasRequest == false) return false; UpdateAliasRequest other = (UpdateAliasRequest) obj; if (other.getAliasName() == null ^ this.getAliasName() == null) return false; if (other.getAliasName() != null && other.getAliasName().equals(this.getAliasName()) == false) return false; if (other.getTargetKeyId() == null ^ this.getTargetKeyId() == null) return false; if (other.getTargetKeyId() != null && other.getTargetKeyId().equals(this.getTargetKeyId()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getAliasName() == null) ? 0 : getAliasName().hashCode()); hashCode = prime * hashCode + ((getTargetKeyId() == null) ? 0 : getTargetKeyId().hashCode()); return hashCode; } @Override public UpdateAliasRequest clone() { return (UpdateAliasRequest) super.clone(); } }