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

* Deletes the specified alias. *

* *

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

* *

* Because an alias is not a property of a KMS key, you can delete and change * the aliases of a KMS key without affecting the KMS key. Also, aliases do not * appear in the response from the DescribeKey operation. To get the * aliases of all KMS keys, use the ListAliases operation. *

*

* Each KMS key can have multiple aliases. To change the alias of a KMS key, use * DeleteAlias to delete the current alias and CreateAlias to * create a new alias. To associate an existing alias with a different KMS key, * call UpdateAlias. *

*

* 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 DeleteAliasRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The alias to be deleted. The alias name must begin with * alias/ followed by the alias name, such as * alias/ExampleAlias. *

*

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

* The alias to be deleted. The alias name must begin with * alias/ followed by the alias name, such as * alias/ExampleAlias. *

*

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

* The alias to be deleted. The alias name must begin with * alias/ followed by the alias name, such as * alias/ExampleAlias. *

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

* The alias to be deleted. The alias name must begin with * alias/ followed by the alias name, such as * alias/ExampleAlias. *

*

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

* The alias to be deleted. The alias name must begin with * alias/ followed by the alias name, such as * alias/ExampleAlias. *

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

* The alias to be deleted. The alias name must begin with * alias/ followed by the alias name, such as * alias/ExampleAlias. *

*

* 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

* The alias to be deleted. The alias name must begin with * alias/ followed by the alias name, such as * alias/ExampleAlias. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DeleteAliasRequest withAliasName(String aliasName) { this.aliasName = aliasName; 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()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getAliasName() == null) ? 0 : getAliasName().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DeleteAliasRequest == false) return false; DeleteAliasRequest other = (DeleteAliasRequest) obj; if (other.getAliasName() == null ^ this.getAliasName() == null) return false; if (other.getAliasName() != null && other.getAliasName().equals(this.getAliasName()) == false) return false; return true; } }