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

* Disconnects the custom key store from its backing key store. This operation disconnects * an CloudHSM key store from its associated CloudHSM cluster or disconnects an * external key store from the external key store proxy that communicates with * your external key manager. *

*

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

*

* While a custom key store is disconnected, you can manage the custom key store * and its KMS keys, but you cannot create or use its KMS keys. You can * reconnect the custom key store at any time. *

* *

* While a custom key store is disconnected, all attempts to create KMS keys in * the custom key store or to use existing KMS keys in cryptographic operations will fail. This action can prevent users from * storing and accessing sensitive data. *

* *

* When you disconnect a custom key store, its ConnectionState * changes to Disconnected. To find the connection state of a * custom key store, use the DescribeCustomKeyStores operation. To * reconnect a custom key store, use the ConnectCustomKeyStore operation. *

*

* 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:DisconnectCustomKeyStore (IAM policy) *

*

* Related operations: *

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

* Enter the ID of the custom key store you want to disconnect. 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 disconnect. 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 disconnect. 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 disconnect. 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 disconnect. * 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 disconnect. 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 disconnect. * 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 DisconnectCustomKeyStoreRequest 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 DisconnectCustomKeyStoreRequest == false) return false; DisconnectCustomKeyStoreRequest other = (DisconnectCustomKeyStoreRequest) obj; if (other.getCustomKeyStoreId() == null ^ this.getCustomKeyStoreId() == null) return false; if (other.getCustomKeyStoreId() != null && other.getCustomKeyStoreId().equals(this.getCustomKeyStoreId()) == false) return false; return true; } }