/* * Copyright 2010-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 com.amazonaws.AmazonWebServiceRequest; /** *

* Creates a friendly name for a KMS key. *

* *

* Adding, deleting, or updating an alias can allow or deny permission to the * KMS key. For details, see ABAC * for KMS in the Key Management Service Developer Guide. *

* *

* You can use an alias to identify a KMS key in the KMS console, in the * DescribeKey operation and in cryptographic operations, such as Encrypt and * GenerateDataKey. You can also change the KMS key that's associated * with the alias (UpdateAlias) or delete the alias (DeleteAlias) * at any time. These operations don't affect the underlying KMS key. *

*

* You can associate the alias with any customer managed key in the same Amazon * Web Services Region. Each alias is associated with only one KMS key at a * time, but a KMS key can have multiple aliases. A valid KMS key is required. * You can't create an alias without a KMS key. *

*

* The alias must be unique in the account and Region, but you can have aliases * with the same name in different Regions. For detailed information about * aliases, see Using aliases in the Key Management Service Developer Guide. *

*

* This operation does not return a response. To get the alias that you created, * use the ListAliases operation. *

*

* The KMS key that you use for this operation must be in a compatible key * state. For details, see Key states of KMS keys in the Key Management Service Developer * Guide. *

*

* Cross-account use: No. You cannot perform this operation on an alias * in a different Amazon Web Services account. *

*

* Required permissions *

* *

* For details, see Controlling access to aliases in the Key Management Service Developer * Guide. *

*

* Related operations: *

* */ public class CreateAliasRequest extends AmazonWebServiceRequest implements Serializable { /** *

* Specifies the alias name. This value must begin with alias/ * followed by a name, such as alias/ExampleAlias. *

* *

* Do not include confidential or sensitive information in this field. This * field may be displayed in plaintext in CloudTrail logs and other output. *

* *

* The AliasName value must be string of 1-256 characters. It * can contain only alphanumeric characters, forward slashes (/), * underscores (_), and dashes (-). The alias name cannot begin with * alias/aws/. The alias/aws/ prefix is reserved * for Amazon Web Services managed keys. *

*

* Constraints:
* Length: 1 - 256
* Pattern: ^[a-zA-Z0-9:/_-]+$
*/ private String aliasName; /** *

* Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web * Services Region. *

*

* A valid key ID is required. If you supply a null or empty string value, * this operation returns an error. *

*

* For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service * Developer Guide . *

*

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

*

* Constraints:
* Length: 1 - 2048
*/ private String targetKeyId; /** *

* Specifies the alias name. This value must begin with alias/ * followed by a name, such as alias/ExampleAlias. *

* *

* Do not include confidential or sensitive information in this field. This * field may be displayed in plaintext in CloudTrail logs and other output. *

* *

* The AliasName value must be string of 1-256 characters. It * can contain only alphanumeric characters, forward slashes (/), * underscores (_), and dashes (-). The alias name cannot begin with * alias/aws/. The alias/aws/ prefix is reserved * for Amazon Web Services managed keys. *

*

* Constraints:
* Length: 1 - 256
* Pattern: ^[a-zA-Z0-9:/_-]+$
* * @return

* Specifies the alias name. This value must begin with * alias/ followed by a name, such as * alias/ExampleAlias. *

* *

* Do not include confidential or sensitive information in this * field. This field may be displayed in plaintext in CloudTrail * logs and other output. *

* *

* The AliasName value must be string of 1-256 * characters. It can contain only alphanumeric characters, forward * slashes (/), underscores (_), and dashes (-). The alias name * cannot begin with alias/aws/. The * alias/aws/ prefix is reserved for Amazon Web Services managed keys. *

*/ public String getAliasName() { return aliasName; } /** *

* Specifies the alias name. This value must begin with alias/ * followed by a name, such as alias/ExampleAlias. *

* *

* Do not include confidential or sensitive information in this field. This * field may be displayed in plaintext in CloudTrail logs and other output. *

* *

* The AliasName value must be string of 1-256 characters. It * can contain only alphanumeric characters, forward slashes (/), * underscores (_), and dashes (-). The alias name cannot begin with * alias/aws/. The alias/aws/ prefix is reserved * for Amazon Web Services managed keys. *

*

* Constraints:
* Length: 1 - 256
* Pattern: ^[a-zA-Z0-9:/_-]+$
* * @param aliasName

* Specifies the alias name. This value must begin with * alias/ followed by a name, such as * alias/ExampleAlias. *

* *

* Do not include confidential or sensitive information in this * field. This field may be displayed in plaintext in CloudTrail * logs and other output. *

* *

* The AliasName value must be string of 1-256 * characters. It can contain only alphanumeric characters, * forward slashes (/), underscores (_), and dashes (-). The * alias name cannot begin with alias/aws/. The * alias/aws/ prefix is reserved for Amazon Web Services managed keys. *

*/ public void setAliasName(String aliasName) { this.aliasName = aliasName; } /** *

* Specifies the alias name. This value must begin with alias/ * followed by a name, such as alias/ExampleAlias. *

* *

* Do not include confidential or sensitive information in this field. This * field may be displayed in plaintext in CloudTrail logs and other output. *

* *

* The AliasName value must be string of 1-256 characters. It * can contain only alphanumeric characters, forward slashes (/), * underscores (_), and dashes (-). The alias name cannot begin with * alias/aws/. The alias/aws/ prefix is reserved * for Amazon Web Services managed keys. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 256
* Pattern: ^[a-zA-Z0-9:/_-]+$
* * @param aliasName

* Specifies the alias name. This value must begin with * alias/ followed by a name, such as * alias/ExampleAlias. *

* *

* Do not include confidential or sensitive information in this * field. This field may be displayed in plaintext in CloudTrail * logs and other output. *

* *

* The AliasName value must be string of 1-256 * characters. It can contain only alphanumeric characters, * forward slashes (/), underscores (_), and dashes (-). The * alias name cannot begin with alias/aws/. The * alias/aws/ prefix is reserved for Amazon Web Services managed keys. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateAliasRequest withAliasName(String aliasName) { this.aliasName = aliasName; return this; } /** *

* Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web * Services Region. *

*

* A valid key ID is required. If you supply a null or empty string value, * this operation returns an error. *

*

* For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service * Developer Guide . *

*

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

*

* Constraints:
* Length: 1 - 2048
* * @return

* Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon * Web Services Region. *

*

* A valid key ID is required. If you supply a null or empty string * value, this operation returns an error. *

*

* For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management * Service Developer Guide . *

*

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

*/ public String getTargetKeyId() { return targetKeyId; } /** *

* Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web * Services Region. *

*

* A valid key ID is required. If you supply a null or empty string value, * this operation returns an error. *

*

* For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service * Developer Guide . *

*

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

*

* Constraints:
* Length: 1 - 2048
* * @param targetKeyId

* Associates the alias with the specified customer managed key. The KMS key must be in the same * Amazon Web Services Region. *

*

* A valid key ID is required. If you supply a null or empty * string value, this operation returns an error. *

*

* For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management * Service Developer Guide . *

*

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

*/ public void setTargetKeyId(String targetKeyId) { this.targetKeyId = targetKeyId; } /** *

* Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web * Services Region. *

*

* A valid key ID is required. If you supply a null or empty string value, * this operation returns an error. *

*

* For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service * Developer Guide . *

*

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

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 2048
* * @param targetKeyId

* Associates the alias with the specified customer managed key. The KMS key must be in the same * Amazon Web Services Region. *

*

* A valid key ID is required. If you supply a null or empty * string value, this operation returns an error. *

*

* For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management * Service Developer Guide . *

*

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

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateAliasRequest withTargetKeyId(String targetKeyId) { this.targetKeyId = targetKeyId; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @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: " + getAliasName() + ","); if (getTargetKeyId() != null) sb.append("TargetKeyId: " + getTargetKeyId()); sb.append("}"); return sb.toString(); } @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 boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateAliasRequest == false) return false; CreateAliasRequest other = (CreateAliasRequest) 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; } }