# ConnectCustomKeyStore Connects or reconnects a [custom key store](https://docs.amazonaws.cn/kms/latest/developerguide/key-store-overview.html) to its backing key store. For an Amazon CloudHSM key store, `ConnectCustomKeyStore` connects the key store to its associated Amazon CloudHSM cluster. For an external key store, `ConnectCustomKeyStore` connects the key store to the external key store proxy that communicates with your external key manager. The custom key store must be connected before you can create KMS keys in the key store or use the KMS keys it contains. You can disconnect and reconnect a custom key store at any time. The connection process for a custom key store can take an extended amount of time to complete. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the [DescribeCustomKeyStores](API_DescribeCustomKeyStores.md) operation. This operation is part of the custom key stores feature in Amazon KMS, which combines the convenience and extensive integration of Amazon KMS with the isolation and control of a key store that you own and manage. The `ConnectCustomKeyStore` operation might fail for various reasons. To find the reason, use the [DescribeCustomKeyStores](API_DescribeCustomKeyStores.md) operation and see the `ConnectionErrorCode` in the response. For help interpreting the `ConnectionErrorCode`, see [CustomKeyStoresListEntry](API_CustomKeyStoresListEntry.md). To fix the failure, use the [DisconnectCustomKeyStore](API_DisconnectCustomKeyStore.md) operation to disconnect the custom key store, correct the error, use the [UpdateCustomKeyStore](API_UpdateCustomKeyStore.md) operation if necessary, and then use `ConnectCustomKeyStore` again. ** Amazon CloudHSM key store** During the connection process for an Amazon CloudHSM key store, Amazon KMS finds the Amazon CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the Amazon CloudHSM client as the `kmsuser` CU, and rotates its password. To connect an Amazon CloudHSM key store, its associated Amazon CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the [DescribeClusters](https://docs.amazonaws.cn/cloudhsm/latest/APIReference/API_DescribeClusters.html) operation. To add HSMs to the cluster, use the [CreateHsm](https://docs.amazonaws.cn/cloudhsm/latest/APIReference/API_CreateHsm.html) operation. Also, the [`kmsuser` crypto user](https://docs.amazonaws.cn/kms/latest/developerguide/keystore-cloudhsm.html#concept-kmsuser) (CU) must not be logged into the cluster. This prevents Amazon KMS from using this account to log in. If you are having trouble connecting or disconnecting a Amazon CloudHSM key store, see [Troubleshooting an Amazon CloudHSM key store](https://docs.amazonaws.cn/kms/latest/developerguide/fix-keystore.html) in the * Amazon Key Management Service Developer Guide*. **External key store** When you connect an external key store that uses public endpoint connectivity, Amazon KMS tests its ability to communicate with your external key manager by sending a request via the external key store proxy. When you connect to an external key store that uses VPC endpoint service connectivity, Amazon KMS establishes the networking elements that it needs to communicate with your external key manager via the external key store proxy. This includes creating an interface endpoint to the VPC endpoint service and a private hosted zone for traffic between Amazon KMS and the VPC endpoint service. To connect an external key store, Amazon KMS must be able to connect to the external key store proxy, the external key store proxy must be able to communicate with your external key manager, and the external key manager must be available for cryptographic operations. If you are having trouble connecting or disconnecting an external key store, see [Troubleshooting an external key store](https://docs.amazonaws.cn/kms/latest/developerguide/xks-troubleshooting.html) in the * Amazon Key Management Service Developer Guide*. **Cross-account use**: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account. **Required permissions**: [kms:ConnectCustomKeyStore](https://docs.amazonaws.cn/kms/latest/developerguide/kms-api-permissions-reference.html) (IAM policy) **Related operations** + [CreateCustomKeyStore](API_CreateCustomKeyStore.md) + [DeleteCustomKeyStore](API_DeleteCustomKeyStore.md) + [DescribeCustomKeyStores](API_DescribeCustomKeyStores.md) + [DisconnectCustomKeyStore](API_DisconnectCustomKeyStore.md) + [UpdateCustomKeyStore](API_UpdateCustomKeyStore.md) **Eventual consistency**: The Amazon KMS API follows an eventual consistency model. For more information, see [Amazon KMS eventual consistency](https://docs.amazonaws.cn/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency). ## Request Syntax ``` { "CustomKeyStoreId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. **Note** In the following list, the required parameters are described first. ** [CustomKeyStoreId](#API_ConnectCustomKeyStore_RequestSyntax) ** Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the [DescribeCustomKeyStores](API_DescribeCustomKeyStores.md) operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** CloudHsmClusterInvalidConfigurationException ** The request was rejected because the associated Amazon CloudHSM cluster did not meet the configuration requirements for an Amazon CloudHSM key store. + The Amazon CloudHSM cluster must be configured with private subnets in at least two different Availability Zones in the Region. + The [security group for the cluster](https://docs.amazonaws.cn/cloudhsm/latest/userguide/configure-sg.html) (cloudhsm-cluster-**-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The **Source** in the inbound rules and the **Destination** in the outbound rules must match the security group ID. These rules are set by default when you create the Amazon CloudHSM cluster. Do not delete or change them. To get information about a particular security group, use the [DescribeSecurityGroups](https://docs.amazonaws.cn/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html) operation. + The Amazon CloudHSM cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the Amazon CloudHSM [CreateHsm](https://docs.amazonaws.cn/cloudhsm/latest/APIReference/API_CreateHsm.html) operation. For the [CreateCustomKeyStore](API_CreateCustomKeyStore.md), [UpdateCustomKeyStore](API_UpdateCustomKeyStore.md), and [CreateKey](API_CreateKey.md) operations, the Amazon CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the [ConnectCustomKeyStore](#API_ConnectCustomKeyStore) operation, the Amazon CloudHSM must contain at least one active HSM. For information about the requirements for an Amazon CloudHSM cluster that is associated with an Amazon CloudHSM key store, see [Assemble the Prerequisites](https://docs.amazonaws.cn/kms/latest/developerguide/create-keystore.html#before-keystore) in the * Amazon Key Management Service Developer Guide*. For information about creating a private subnet for an Amazon CloudHSM cluster, see [Create a Private Subnet](https://docs.amazonaws.cn/cloudhsm/latest/userguide/create-subnets.html) in the * Amazon CloudHSM User Guide*. For information about cluster security groups, see [Configure a Default Security Group](https://docs.amazonaws.cn/cloudhsm/latest/userguide/configure-sg.html) in the * * Amazon CloudHSM User Guide* *. HTTP Status Code: 400 ** CloudHsmClusterNotActiveException ** The request was rejected because the Amazon CloudHSM cluster associated with the Amazon CloudHSM key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see [Getting Started](https://docs.amazonaws.cn/cloudhsm/latest/userguide/getting-started.html) in the * Amazon CloudHSM User Guide*. HTTP Status Code: 400 ** CustomKeyStoreInvalidStateException ** The request was rejected because of the `ConnectionState` of the custom key store. To get the `ConnectionState` of a custom key store, use the [DescribeCustomKeyStores](API_DescribeCustomKeyStores.md) operation. This exception is thrown under the following conditions: + You requested the [ConnectCustomKeyStore](#API_ConnectCustomKeyStore) operation on a custom key store with a `ConnectionState` of `DISCONNECTING` or `FAILED`. This operation is valid for all other `ConnectionState` values. To reconnect a custom key store in a `FAILED` state, disconnect it ([DisconnectCustomKeyStore](API_DisconnectCustomKeyStore.md)), then connect it (`ConnectCustomKeyStore`). + You requested the [CreateKey](API_CreateKey.md) operation in a custom key store that is not connected. This operations is valid only when the custom key store `ConnectionState` is `CONNECTED`. + You requested the [DisconnectCustomKeyStore](API_DisconnectCustomKeyStore.md) operation on a custom key store with a `ConnectionState` of `DISCONNECTING` or `DISCONNECTED`. This operation is valid for all other `ConnectionState` values. + You requested the [UpdateCustomKeyStore](API_UpdateCustomKeyStore.md) or [DeleteCustomKeyStore](API_DeleteCustomKeyStore.md) operation on a custom key store that is not disconnected. `UpdateCustomKeyStore` can be called on a custom key store in the `CONNECTED` state only to update `NewCustomKeyStoreName`. For all other properties, the custom key store `ConnectionState` must be `DISCONNECTED`. + You requested the [GenerateRandom](API_GenerateRandom.md) operation in an Amazon CloudHSM key store that is not connected. This operation is valid only when the Amazon CloudHSM key store `ConnectionState` is `CONNECTED`. HTTP Status Code: 400 ** CustomKeyStoreNotFoundException ** The request was rejected because Amazon KMS cannot find a custom key store with the specified key store name or ID. HTTP Status Code: 400 ** KMSInternalException ** The request was rejected because an internal exception occurred. The request can be retried. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific Amazon SDKs, see the following: + [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/kms-2014-11-01/ConnectCustomKeyStore) + [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/kms-2014-11-01/ConnectCustomKeyStore) + [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/kms-2014-11-01/ConnectCustomKeyStore) + [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/kms-2014-11-01/ConnectCustomKeyStore) + [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/kms-2014-11-01/ConnectCustomKeyStore) + [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/kms-2014-11-01/ConnectCustomKeyStore) + [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/kms-2014-11-01/ConnectCustomKeyStore) + [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/kms-2014-11-01/ConnectCustomKeyStore) + [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/kms-2014-11-01/ConnectCustomKeyStore) + [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/kms-2014-11-01/ConnectCustomKeyStore)