/* * 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 a custom key store. This operation does not affect any backing elements of * the custom key store. It does not delete the CloudHSM cluster that is * associated with an CloudHSM key store, or affect any users or keys in the * cluster. For an external key store, it does not affect the external key store * proxy, external key manager, or any external keys. *

*

* This operation is part of the custom key stores feature in KMS, which combines the convenience and * extensive integration of KMS with the isolation and control of a key store * that you own and manage. *

*

* The custom key store that you delete cannot contain any KMS keys. Before deleting the key store, verify that you will never need * to use any of the KMS keys in the key store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete * the KMS keys from the key store. After the required waiting period expires * and all KMS keys are deleted from the custom key store, use * DisconnectCustomKeyStore to disconnect the key store from KMS. Then, * you can delete the custom key store. *

*

* For keys in an CloudHSM key store, the ScheduleKeyDeletion * operation makes a best effort to delete the key material from the associated * cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. KMS * never creates, manages, or deletes cryptographic keys in the external key * manager associated with an external key store. You must manage them using * your external key manager tools. *

*

* Instead of deleting the custom key store, consider using the * DisconnectCustomKeyStore operation to disconnect the custom key store * from its backing key store. While the key store is disconnected, you cannot * create or use the KMS keys in the key store. But, you do not need to delete * KMS keys and you can reconnect a disconnected custom key store at any time. *

*

* If the operation succeeds, it returns a JSON object with no properties. *

*

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

*

* Required permissions: kms:DeleteCustomKeyStore (IAM policy) *

*

* Related operations: *

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

* Enter the ID of the custom key store you want to delete. To find the ID * of a custom key store, use the DescribeCustomKeyStores operation. *

*

* Constraints:
* Length: 1 - 64
*/ private String customKeyStoreId; /** *

* Enter the ID of the custom key store you want to delete. To find the ID * of a custom key store, use the DescribeCustomKeyStores operation. *

*

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

* Enter the ID of the custom key store you want to delete. To find * the ID of a custom key store, use the * DescribeCustomKeyStores operation. *

*/ public String getCustomKeyStoreId() { return customKeyStoreId; } /** *

* Enter the ID of the custom key store you want to delete. To find the ID * of a custom key store, use the DescribeCustomKeyStores operation. *

*

* Constraints:
* Length: 1 - 64
* * @param customKeyStoreId

* Enter the ID of the custom key store you want to delete. To * find the ID of a custom key store, use the * DescribeCustomKeyStores operation. *

*/ public void setCustomKeyStoreId(String customKeyStoreId) { this.customKeyStoreId = customKeyStoreId; } /** *

* Enter the ID of the custom key store you want to delete. To find the ID * of a custom key store, use the DescribeCustomKeyStores operation. *

*

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

* Constraints:
* Length: 1 - 64
* * @param customKeyStoreId

* Enter the ID of the custom key store you want to delete. To * find the ID of a custom key store, use the * DescribeCustomKeyStores operation. *

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