import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient"; import type { UpdateCustomKeyStoreRequest, UpdateCustomKeyStoreResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link UpdateCustomKeyStoreCommand}. */ export interface UpdateCustomKeyStoreCommandInput extends UpdateCustomKeyStoreRequest { } /** * @public * * The output of {@link UpdateCustomKeyStoreCommand}. */ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreResponse, __MetadataBearer { } declare const UpdateCustomKeyStoreCommand_base: { new (input: UpdateCustomKeyStoreCommandInput): import("@smithy/core/client").CommandImpl; new (input: UpdateCustomKeyStoreCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Changes the properties of a custom key store. You can use this operation to change the * properties of an CloudHSM key store or an external key store.

*

Use the required CustomKeyStoreId parameter to identify the custom key store. * Use the remaining optional parameters to change its properties. This operation does not return * any property values. To verify the updated property values, use the DescribeCustomKeyStores operation.

*

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.

* *

When updating the properties of an external key store, verify that the updated settings * connect your key store, via the external key store proxy, to the same external key manager * as the previous settings, or to a backup or snapshot of the external key manager with the * same cryptographic keys. If the updated connection settings fail, you can fix them and * retry, although an extended delay might disrupt Amazon Web Services services. However, if KMS * permanently loses its access to cryptographic keys, ciphertext encrypted under those keys is * unrecoverable.

* * *

For external key stores:

*

Some external key managers provide a simpler method for updating an external key store. * For details, see your external key manager documentation.

*

When updating an external key store in the KMS console, you can upload a JSON-based * proxy configuration file with the desired values. You cannot upload the proxy configuration * file to the UpdateCustomKeyStore operation. However, you can use the file to * help you determine the correct values for the UpdateCustomKeyStore * parameters.

* *

For an CloudHSM key store, you can use this operation to change the custom key store friendly * name (NewCustomKeyStoreName), to tell KMS about a change to the * kmsuser crypto user password (KeyStorePassword), or to associate * the custom key store with a different, but related, CloudHSM cluster * (CloudHsmClusterId). To update most properties of an CloudHSM key store, the * ConnectionState of the CloudHSM key store must be DISCONNECTED. * However, you can update the CustomKeyStoreName of an AWS CloudHSM key store * when it is in the CONNECTED or DISCONNECTED state.

*

For an external key store, you can use this operation to change the custom key store * friendly name (NewCustomKeyStoreName), or to tell KMS about a change to the * external key store proxy authentication credentials * (XksProxyAuthenticationCredential), connection method * (XksProxyConnectivity), external proxy endpoint * (XksProxyUriEndpoint) and path (XksProxyUriPath). For external key * stores with an XksProxyConnectivity of VPC_ENDPOINT_SERVICE, you can * also update the Amazon VPC endpoint service name (XksProxyVpcEndpointServiceName). To * update most properties of an external key store, the ConnectionState of the * external key store must be DISCONNECTED. However, you can update the * CustomKeyStoreName, XksProxyAuthenticationCredential, and * XksProxyUriPath of an external key store when it is in the CONNECTED or * DISCONNECTED state.

*

If your update requires a DISCONNECTED state, before using * UpdateCustomKeyStore, use the DisconnectCustomKeyStore * operation to disconnect the custom key store. After the UpdateCustomKeyStore * operation completes, use the ConnectCustomKeyStore to reconnect the custom * key store. To find the ConnectionState of the custom key store, use the DescribeCustomKeyStores operation.

*

*

*

Before updating the custom key store, verify that the new values allow KMS to connect * the custom key store to its backing key store. For example, before you change the * XksProxyUriPath value, verify that the external key store proxy is reachable at * the new path.

*

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

*

* Related operations: *

* *

* Eventual consistency: The KMS API follows an eventual consistency model. * For more information, see KMS eventual consistency.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { KMSClient, UpdateCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import * // const { KMSClient, UpdateCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import * // import type { KMSClientConfig } from "@aws-sdk/client-kms"; * const config = {}; // type is KMSClientConfig * const client = new KMSClient(config); * const input = { // UpdateCustomKeyStoreRequest * CustomKeyStoreId: "STRING_VALUE", // required * NewCustomKeyStoreName: "STRING_VALUE", * KeyStorePassword: "STRING_VALUE", * CloudHsmClusterId: "STRING_VALUE", * XksProxyUriEndpoint: "STRING_VALUE", * XksProxyUriPath: "STRING_VALUE", * XksProxyVpcEndpointServiceName: "STRING_VALUE", * XksProxyVpcEndpointServiceOwner: "STRING_VALUE", * XksProxyAuthenticationCredential: { // XksProxyAuthenticationCredentialType * AccessKeyId: "STRING_VALUE", // required * RawSecretAccessKey: "STRING_VALUE", // required * }, * XksProxyConnectivity: "PUBLIC_ENDPOINT" || "VPC_ENDPOINT_SERVICE", * }; * const command = new UpdateCustomKeyStoreCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param UpdateCustomKeyStoreCommandInput - {@link UpdateCustomKeyStoreCommandInput} * @returns {@link UpdateCustomKeyStoreCommandOutput} * @see {@link UpdateCustomKeyStoreCommandInput} for command's `input` shape. * @see {@link UpdateCustomKeyStoreCommandOutput} for command's `response` shape. * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape. * * @throws {@link CloudHsmClusterInvalidConfigurationException} (client fault) *

The request was rejected because the associated CloudHSM cluster did not meet the * configuration requirements for an CloudHSM key store.

* *

For information about the requirements for an CloudHSM cluster that is associated with an * CloudHSM key store, see Assemble the Prerequisites * in the Key Management Service Developer Guide. For information about creating a private subnet for an CloudHSM cluster, * see Create a Private * Subnet in the CloudHSM User Guide. For information about cluster security groups, see * Configure a Default Security * Group in the * CloudHSM User Guide * .

* * @throws {@link CloudHsmClusterNotActiveException} (client fault) *

The request was rejected because the CloudHSM cluster associated with the CloudHSM key store is * not active. Initialize and activate the cluster and try the command again. For detailed * instructions, see Getting * Started in the CloudHSM User Guide.

* * @throws {@link CloudHsmClusterNotFoundException} (client fault) *

The request was rejected because KMS cannot find the CloudHSM cluster with the specified * cluster ID. Retry the request with a different cluster ID.

* * @throws {@link CloudHsmClusterNotRelatedException} (client fault) *

The request was rejected because the specified CloudHSM cluster has a different cluster * certificate than the original cluster. You cannot use the operation to specify an unrelated * cluster for an CloudHSM key store.

*

Specify an CloudHSM cluster that shares a backup history with the original cluster. This * includes clusters that were created from a backup of the current cluster, and clusters that * were created from the same backup that produced the current cluster.

*

CloudHSM clusters that share a backup history have the same cluster certificate. To view the * cluster certificate of an CloudHSM cluster, use the DescribeClusters operation.

* * @throws {@link CustomKeyStoreInvalidStateException} (client fault) *

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

*

This exception is thrown under the following conditions:

* * * @throws {@link CustomKeyStoreNameInUseException} (client fault) *

The request was rejected because the specified custom key store name is already assigned * to another custom key store in the account. Try again with a custom key store name that is * unique in the account.

* * @throws {@link CustomKeyStoreNotFoundException} (client fault) *

The request was rejected because KMS cannot find a custom key store with the specified * key store name or ID.

* * @throws {@link KMSInternalException} (server fault) *

The request was rejected because an internal exception occurred. The request can be * retried.

* * @throws {@link XksProxyIncorrectAuthenticationCredentialException} (client fault) *

The request was rejected because the proxy credentials failed to authenticate to the * specified external key store proxy. The specified external key store proxy rejected a status * request from KMS due to invalid credentials. This can indicate an error in the credentials * or in the identification of the external key store proxy.

* * @throws {@link XksProxyInvalidConfigurationException} (client fault) *

The request was rejected because the external key store proxy is not configured correctly. * To identify the cause, see the error message that accompanies the exception.

* * @throws {@link XksProxyInvalidResponseException} (client fault) *

*

KMS cannot interpret the response it received from the external key store proxy. The * problem might be a poorly constructed response, but it could also be a transient network * issue. If you see this error repeatedly, report it to the proxy vendor.

* * @throws {@link XksProxyUriEndpointInUseException} (client fault) *

The request was rejected because the XksProxyUriEndpoint is already * associated with another external key store in this Amazon Web Services Region. To identify the cause, see * the error message that accompanies the exception.

* * @throws {@link XksProxyUriInUseException} (client fault) *

The request was rejected because the concatenation of the XksProxyUriEndpoint * and XksProxyUriPath is already associated with another external key store in this * Amazon Web Services Region. Each external key store in a Region must use a unique external key store proxy * API address.

* * @throws {@link XksProxyUriUnreachableException} (client fault) *

KMS was unable to reach the specified XksProxyUriPath. The path must be * reachable before you create the external key store or update its settings.

*

This exception is also thrown when the external key store proxy response to a * GetHealthStatus request indicates that all external key manager instances are * unavailable.

* * @throws {@link XksProxyVpcEndpointServiceInUseException} (client fault) *

The request was rejected because the specified Amazon VPC endpoint service is already * associated with another external key store in this Amazon Web Services Region. Each external key store in a * Region must use a different Amazon VPC endpoint service.

* * @throws {@link XksProxyVpcEndpointServiceInvalidConfigurationException} (client fault) *

The request was rejected because the Amazon VPC endpoint service configuration does not fulfill * the requirements for an external key store. To identify the cause, see the error message that * accompanies the exception and review the * requirements for Amazon VPC endpoint service connectivity for an external key * store.

* * @throws {@link XksProxyVpcEndpointServiceNotFoundException} (client fault) *

The request was rejected because KMS could not find the specified VPC endpoint service. * Use DescribeCustomKeyStores to verify the VPC endpoint service name for the * external key store. Also, confirm that the Allow principals list for the VPC * endpoint service includes the KMS service principal for the Region, such as * cks.kms.us-east-1.amazonaws.com.

* * @throws {@link KMSServiceException} *

Base exception class for all service exceptions from KMS service.

* * * @example To edit the friendly name of a custom key store * ```javascript * // This example changes the friendly name of the AWS KMS custom key store to the name that you specify. This operation does not return any data. To verify that the operation worked, use the DescribeCustomKeyStores operation. * const input = { * CustomKeyStoreId: "cks-1234567890abcdef0", * NewCustomKeyStoreName: "DevelopmentKeys" * }; * const command = new UpdateCustomKeyStoreCommand(input); * const response = await client.send(command); * /* response is * { /* empty *\/ } * *\/ * ``` * * @example To edit the password of an AWS CloudHSM key store * ```javascript * // This example tells AWS KMS the password for the kmsuser crypto user in the AWS CloudHSM cluster that is associated with the AWS KMS custom key store. (It does not change the password in the CloudHSM cluster.) This operation does not return any data. * const input = { * CustomKeyStoreId: "cks-1234567890abcdef0", * KeyStorePassword: "ExamplePassword" * }; * const command = new UpdateCustomKeyStoreCommand(input); * const response = await client.send(command); * /* response is * { /* empty *\/ } * *\/ * ``` * * @example To update the proxy connectivity of an external key store to VPC_ENDPOINT_SERVICE * ```javascript * // To change the external key store proxy connectivity option from public endpoint connectivity to VPC endpoint service connectivity, in addition to changing the XksProxyConnectivity value, you must change the XksProxyUriEndpoint value to reflect the private DNS name associated with the VPC endpoint service. You must also add an XksProxyVpcEndpointServiceName value. * const input = { * CustomKeyStoreId: "cks-1234567890abcdef0", * XksProxyConnectivity: "VPC_ENDPOINT_SERVICE", * XksProxyUriEndpoint: "https://myproxy-private.xks.example.com", * XksProxyVpcEndpointServiceName: "com.amazonaws.vpce.us-east-1.vpce-svc-example" * }; * const command = new UpdateCustomKeyStoreCommand(input); * const response = await client.send(command); * /* response is * { /* empty *\/ } * *\/ * ``` * * @example To edit the proxy URI path of an external key store. * ```javascript * // This example updates the proxy URI path for an external key store * const input = { * CustomKeyStoreId: "cks-1234567890abcdef0", * XksProxyUriPath: "/new-path/kms/xks/v1" * }; * const command = new UpdateCustomKeyStoreCommand(input); * const response = await client.send(command); * /* response is * { /* empty *\/ } * *\/ * ``` * * @example To associate the custom key store with a different, but related, AWS CloudHSM cluster. * ```javascript * // This example changes the AWS CloudHSM cluster that is associated with an AWS CloudHSM key store to a related cluster, such as a different backup of the same cluster. This operation does not return any data. To verify that the operation worked, use the DescribeCustomKeyStores operation. * const input = { * CloudHsmClusterId: "cluster-234abcdefABC", * CustomKeyStoreId: "cks-1234567890abcdef0" * }; * const command = new UpdateCustomKeyStoreCommand(input); * const response = await client.send(command); * /* response is * { /* empty *\/ } * *\/ * ``` * * @public */ export declare class UpdateCustomKeyStoreCommand extends UpdateCustomKeyStoreCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateCustomKeyStoreRequest; output: {}; }; sdk: { input: UpdateCustomKeyStoreCommandInput; output: UpdateCustomKeyStoreCommandOutput; }; }; }