|
23 | 23 | * <p> |
24 | 24 | * Connects or reconnects a <a href= |
25 | 25 | * "https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html" |
26 | | - * >custom key store</a> to its associated CloudHSM cluster. |
| 26 | + * >custom key store</a> to its backing key store. For an CloudHSM key store, |
| 27 | + * <code>ConnectCustomKeyStore</code> connects the key store to its associated |
| 28 | + * CloudHSM cluster. For an external key store, |
| 29 | + * <code>ConnectCustomKeyStore</code> connects the key store to the external key |
| 30 | + * store proxy that communicates with your external key manager. |
27 | 31 | * </p> |
28 | 32 | * <p> |
29 | 33 | * The custom key store must be connected before you can create KMS keys in the |
30 | 34 | * key store or use the KMS keys it contains. You can disconnect and reconnect a |
31 | 35 | * custom key store at any time. |
32 | 36 | * </p> |
33 | 37 | * <p> |
34 | | - * To connect a custom key store, its associated CloudHSM cluster must have at |
35 | | - * least one active HSM. To get the number of active HSMs in a cluster, use the |
36 | | - * <a href= |
37 | | - * "https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html" |
38 | | - * >DescribeClusters</a> operation. To add HSMs to the cluster, use the <a href= |
39 | | - * "https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html" |
40 | | - * >CreateHsm</a> operation. Also, the <a href= |
41 | | - * "https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser" |
42 | | - * > <code>kmsuser</code> crypto user</a> (CU) must not be logged into the |
43 | | - * cluster. This prevents KMS from using this account to log in. |
44 | | - * </p> |
45 | | - * <p> |
46 | | - * The connection process can take an extended amount of time to complete; up to |
47 | | - * 20 minutes. This operation starts the connection process, but it does not |
48 | | - * wait for it to complete. When it succeeds, this operation quickly returns an |
49 | | - * HTTP 200 response and a JSON object with no properties. However, this |
| 38 | + * The connection process for a custom key store can take an extended amount of |
| 39 | + * time to complete. This operation starts the connection process, but it does |
| 40 | + * not wait for it to complete. When it succeeds, this operation quickly returns |
| 41 | + * an HTTP 200 response and a JSON object with no properties. However, this |
50 | 42 | * response does not indicate that the custom key store is connected. To get the |
51 | 43 | * connection state of the custom key store, use the |
52 | 44 | * <a>DescribeCustomKeyStores</a> operation. |
53 | 45 | * </p> |
54 | 46 | * <p> |
55 | | - * During the connection process, KMS finds the CloudHSM cluster that is |
56 | | - * associated with the custom key store, creates the connection infrastructure, |
57 | | - * connects to the cluster, logs into the CloudHSM client as the |
58 | | - * <code>kmsuser</code> CU, and rotates its password. |
| 47 | + * This operation is part of the <a href= |
| 48 | + * "https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html" |
| 49 | + * >custom key stores</a> feature in KMS, which combines the convenience and |
| 50 | + * extensive integration of KMS with the isolation and control of a key store |
| 51 | + * that you own and manage. |
59 | 52 | * </p> |
60 | 53 | * <p> |
61 | 54 | * The <code>ConnectCustomKeyStore</code> operation might fail for various |
|
71 | 64 | * <code>ConnectCustomKeyStore</code> again. |
72 | 65 | * </p> |
73 | 66 | * <p> |
74 | | - * If you are having trouble connecting or disconnecting a custom key store, see |
75 | | - * <a href= |
| 67 | + * <b>CloudHSM key store</b> |
| 68 | + * </p> |
| 69 | + * <p> |
| 70 | + * During the connection process for an CloudHSM key store, KMS finds the |
| 71 | + * CloudHSM cluster that is associated with the custom key store, creates the |
| 72 | + * connection infrastructure, connects to the cluster, logs into the CloudHSM |
| 73 | + * client as the <code>kmsuser</code> CU, and rotates its password. |
| 74 | + * </p> |
| 75 | + * <p> |
| 76 | + * To connect an CloudHSM key store, its associated CloudHSM cluster must have |
| 77 | + * at least one active HSM. To get the number of active HSMs in a cluster, use |
| 78 | + * the <a href= |
| 79 | + * "https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html" |
| 80 | + * >DescribeClusters</a> operation. To add HSMs to the cluster, use the <a href= |
| 81 | + * "https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html" |
| 82 | + * >CreateHsm</a> operation. Also, the <a href= |
| 83 | + * "https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser" |
| 84 | + * > <code>kmsuser</code> crypto user</a> (CU) must not be logged into the |
| 85 | + * cluster. This prevents KMS from using this account to log in. |
| 86 | + * </p> |
| 87 | + * <p> |
| 88 | + * If you are having trouble connecting or disconnecting a CloudHSM key store, |
| 89 | + * see <a href= |
76 | 90 | * "https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html" |
77 | | - * >Troubleshooting a Custom Key Store</a> in the <i>Key Management Service |
| 91 | + * >Troubleshooting an CloudHSM key store</a> in the <i>Key Management Service |
| 92 | + * Developer Guide</i>. |
| 93 | + * </p> |
| 94 | + * <p> |
| 95 | + * <b>External key store</b> |
| 96 | + * </p> |
| 97 | + * <p> |
| 98 | + * When you connect an external key store that uses public endpoint |
| 99 | + * connectivity, KMS tests its ability to communicate with your external key |
| 100 | + * manager by sending a request via the external key store proxy. |
| 101 | + * </p> |
| 102 | + * <p> |
| 103 | + * When you connect to an external key store that uses VPC endpoint service |
| 104 | + * connectivity, KMS establishes the networking elements that it needs to |
| 105 | + * communicate with your external key manager via the external key store proxy. |
| 106 | + * This includes creating an interface endpoint to the VPC endpoint service and |
| 107 | + * a private hosted zone for traffic between KMS and the VPC endpoint service. |
| 108 | + * </p> |
| 109 | + * <p> |
| 110 | + * To connect an external key store, KMS must be able to connect to the external |
| 111 | + * key store proxy, the external key store proxy must be able to communicate |
| 112 | + * with your external key manager, and the external key manager must be |
| 113 | + * available for cryptographic operations. |
| 114 | + * </p> |
| 115 | + * <p> |
| 116 | + * If you are having trouble connecting or disconnecting an external key store, |
| 117 | + * see <a href= |
| 118 | + * "https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html" |
| 119 | + * >Troubleshooting an external key store</a> in the <i>Key Management Service |
78 | 120 | * Developer Guide</i>. |
79 | 121 | * </p> |
80 | 122 | * <p> |
|
0 commit comments