Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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 any property of an CloudHSM key store, the ConnectionState
of
the CloudHSM key store must be DISCONNECTED
.
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:
- ConnectCustomKeyStore
- CreateCustomKeyStore
- DeleteCustomKeyStore
- DescribeCustomKeyStores
- DisconnectCustomKeyStore
Synopsis
- data UpdateCustomKeyStore = UpdateCustomKeyStore' {
- cloudHsmClusterId :: Maybe Text
- keyStorePassword :: Maybe (Sensitive Text)
- newCustomKeyStoreName' :: Maybe Text
- xksProxyAuthenticationCredential :: Maybe XksProxyAuthenticationCredentialType
- xksProxyConnectivity :: Maybe XksProxyConnectivityType
- xksProxyUriEndpoint :: Maybe Text
- xksProxyUriPath :: Maybe Text
- xksProxyVpcEndpointServiceName :: Maybe Text
- customKeyStoreId :: Text
- newUpdateCustomKeyStore :: Text -> UpdateCustomKeyStore
- updateCustomKeyStore_cloudHsmClusterId :: Lens' UpdateCustomKeyStore (Maybe Text)
- updateCustomKeyStore_keyStorePassword :: Lens' UpdateCustomKeyStore (Maybe Text)
- updateCustomKeyStore_newCustomKeyStoreName :: Lens' UpdateCustomKeyStore (Maybe Text)
- updateCustomKeyStore_xksProxyAuthenticationCredential :: Lens' UpdateCustomKeyStore (Maybe XksProxyAuthenticationCredentialType)
- updateCustomKeyStore_xksProxyConnectivity :: Lens' UpdateCustomKeyStore (Maybe XksProxyConnectivityType)
- updateCustomKeyStore_xksProxyUriEndpoint :: Lens' UpdateCustomKeyStore (Maybe Text)
- updateCustomKeyStore_xksProxyUriPath :: Lens' UpdateCustomKeyStore (Maybe Text)
- updateCustomKeyStore_xksProxyVpcEndpointServiceName :: Lens' UpdateCustomKeyStore (Maybe Text)
- updateCustomKeyStore_customKeyStoreId :: Lens' UpdateCustomKeyStore Text
- data UpdateCustomKeyStoreResponse = UpdateCustomKeyStoreResponse' {
- httpStatus :: Int
- newUpdateCustomKeyStoreResponse :: Int -> UpdateCustomKeyStoreResponse
- updateCustomKeyStoreResponse_httpStatus :: Lens' UpdateCustomKeyStoreResponse Int
Creating a Request
data UpdateCustomKeyStore Source #
See: newUpdateCustomKeyStore
smart constructor.
UpdateCustomKeyStore' | |
|
Instances
newUpdateCustomKeyStore Source #
Create a value of UpdateCustomKeyStore
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateCustomKeyStore
, updateCustomKeyStore_cloudHsmClusterId
- Associates the custom key store with a related CloudHSM cluster. This
parameter is valid only for custom key stores with a
CustomKeyStoreType
of AWS_CLOUDHSM
.
Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.
To change this value, the CloudHSM key store must be disconnected.
$sel:keyStorePassword:UpdateCustomKeyStore'
, updateCustomKeyStore_keyStorePassword
- Enter the current password of the kmsuser
crypto user (CU) in the
CloudHSM cluster that is associated with the custom key store. This
parameter is valid only for custom key stores with a
CustomKeyStoreType
of AWS_CLOUDHSM
.
This parameter tells KMS the current password of the kmsuser
crypto
user (CU). It does not set or change the password of any users in the
CloudHSM cluster.
To change this value, the CloudHSM key store must be disconnected.
$sel:newCustomKeyStoreName':UpdateCustomKeyStore'
, updateCustomKeyStore_newCustomKeyStoreName
- Changes the friendly name of the custom key store to the value that you
specify. The custom key store name must be unique in the Amazon Web
Services account.
To change this value, an CloudHSM key store must be disconnected. An external key store can be connected or disconnected.
$sel:xksProxyAuthenticationCredential:UpdateCustomKeyStore'
, updateCustomKeyStore_xksProxyAuthenticationCredential
- Changes the credentials that KMS uses to sign requests to the external
key store proxy (XKS proxy). This parameter is valid only for custom key
stores with a CustomKeyStoreType
of EXTERNAL_KEY_STORE
.
You must specify both the AccessKeyId
and SecretAccessKey
value in
the authentication credential, even if you are only updating one value.
This parameter doesn't establish or change your authentication credentials on the proxy. It just tells KMS the credential that you established with your external key store proxy. For example, if you rotate the credential on your external key store proxy, you can use this parameter to update the credential in KMS.
You can change this value when the external key store is connected or disconnected.
$sel:xksProxyConnectivity:UpdateCustomKeyStore'
, updateCustomKeyStore_xksProxyConnectivity
- Changes the connectivity setting for the external key store. To indicate
that the external key store proxy uses a Amazon VPC endpoint service to
communicate with KMS, specify VPC_ENDPOINT_SERVICE
. Otherwise, specify
PUBLIC_ENDPOINT
.
If you change the XksProxyConnectivity
to VPC_ENDPOINT_SERVICE
, you
must also change the XksProxyUriEndpoint
and add an
XksProxyVpcEndpointServiceName
value.
If you change the XksProxyConnectivity
to PUBLIC_ENDPOINT
, you must
also change the XksProxyUriEndpoint
and specify a null or empty string
for the XksProxyVpcEndpointServiceName
value.
To change this value, the external key store must be disconnected.
$sel:xksProxyUriEndpoint:UpdateCustomKeyStore'
, updateCustomKeyStore_xksProxyUriEndpoint
- Changes the URI endpoint that KMS uses to connect to your external key
store proxy (XKS proxy). This parameter is valid only for custom key
stores with a CustomKeyStoreType
of EXTERNAL_KEY_STORE
.
For external key stores with an XksProxyConnectivity
value of
PUBLIC_ENDPOINT
, the protocol must be HTTPS.
For external key stores with an XksProxyConnectivity
value of
VPC_ENDPOINT_SERVICE
, specify https://
followed by the private DNS
name associated with the VPC endpoint service. Each external key store
must use a different private DNS name.
The combined XksProxyUriEndpoint
and XksProxyUriPath
values must be
unique in the Amazon Web Services account and Region.
To change this value, the external key store must be disconnected.
$sel:xksProxyUriPath:UpdateCustomKeyStore'
, updateCustomKeyStore_xksProxyUriPath
- Changes the base path to the proxy APIs for this external key store. To
find this value, see the documentation for your external key manager and
external key store proxy (XKS proxy). This parameter is valid only for
custom key stores with a CustomKeyStoreType
of EXTERNAL_KEY_STORE
.
The value must start with /
and must end with /kms/xks/v1
, where
v1
represents the version of the KMS external key store proxy API. You
can include an optional prefix between the required elements such as
/
example
/kms/xks/v1
.
The combined XksProxyUriEndpoint
and XksProxyUriPath
values must be
unique in the Amazon Web Services account and Region.
You can change this value when the external key store is connected or disconnected.
$sel:xksProxyVpcEndpointServiceName:UpdateCustomKeyStore'
, updateCustomKeyStore_xksProxyVpcEndpointServiceName
- Changes the name that KMS uses to identify the Amazon VPC endpoint
service for your external key store proxy (XKS proxy). This parameter is
valid when the CustomKeyStoreType
is EXTERNAL_KEY_STORE
and the
XksProxyConnectivity
is VPC_ENDPOINT_SERVICE
.
To change this value, the external key store must be disconnected.
UpdateCustomKeyStore
, updateCustomKeyStore_customKeyStoreId
- Identifies the custom key store that you want to update. Enter the ID of
the custom key store. To find the ID of a custom key store, use the
DescribeCustomKeyStores operation.
Request Lenses
updateCustomKeyStore_cloudHsmClusterId :: Lens' UpdateCustomKeyStore (Maybe Text) Source #
Associates the custom key store with a related CloudHSM cluster. This
parameter is valid only for custom key stores with a
CustomKeyStoreType
of AWS_CLOUDHSM
.
Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.
To change this value, the CloudHSM key store must be disconnected.
updateCustomKeyStore_keyStorePassword :: Lens' UpdateCustomKeyStore (Maybe Text) Source #
Enter the current password of the kmsuser
crypto user (CU) in the
CloudHSM cluster that is associated with the custom key store. This
parameter is valid only for custom key stores with a
CustomKeyStoreType
of AWS_CLOUDHSM
.
This parameter tells KMS the current password of the kmsuser
crypto
user (CU). It does not set or change the password of any users in the
CloudHSM cluster.
To change this value, the CloudHSM key store must be disconnected.
updateCustomKeyStore_newCustomKeyStoreName :: Lens' UpdateCustomKeyStore (Maybe Text) Source #
Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the Amazon Web Services account.
To change this value, an CloudHSM key store must be disconnected. An external key store can be connected or disconnected.
updateCustomKeyStore_xksProxyAuthenticationCredential :: Lens' UpdateCustomKeyStore (Maybe XksProxyAuthenticationCredentialType) Source #
Changes the credentials that KMS uses to sign requests to the external
key store proxy (XKS proxy). This parameter is valid only for custom key
stores with a CustomKeyStoreType
of EXTERNAL_KEY_STORE
.
You must specify both the AccessKeyId
and SecretAccessKey
value in
the authentication credential, even if you are only updating one value.
This parameter doesn't establish or change your authentication credentials on the proxy. It just tells KMS the credential that you established with your external key store proxy. For example, if you rotate the credential on your external key store proxy, you can use this parameter to update the credential in KMS.
You can change this value when the external key store is connected or disconnected.
updateCustomKeyStore_xksProxyConnectivity :: Lens' UpdateCustomKeyStore (Maybe XksProxyConnectivityType) Source #
Changes the connectivity setting for the external key store. To indicate
that the external key store proxy uses a Amazon VPC endpoint service to
communicate with KMS, specify VPC_ENDPOINT_SERVICE
. Otherwise, specify
PUBLIC_ENDPOINT
.
If you change the XksProxyConnectivity
to VPC_ENDPOINT_SERVICE
, you
must also change the XksProxyUriEndpoint
and add an
XksProxyVpcEndpointServiceName
value.
If you change the XksProxyConnectivity
to PUBLIC_ENDPOINT
, you must
also change the XksProxyUriEndpoint
and specify a null or empty string
for the XksProxyVpcEndpointServiceName
value.
To change this value, the external key store must be disconnected.
updateCustomKeyStore_xksProxyUriEndpoint :: Lens' UpdateCustomKeyStore (Maybe Text) Source #
Changes the URI endpoint that KMS uses to connect to your external key
store proxy (XKS proxy). This parameter is valid only for custom key
stores with a CustomKeyStoreType
of EXTERNAL_KEY_STORE
.
For external key stores with an XksProxyConnectivity
value of
PUBLIC_ENDPOINT
, the protocol must be HTTPS.
For external key stores with an XksProxyConnectivity
value of
VPC_ENDPOINT_SERVICE
, specify https://
followed by the private DNS
name associated with the VPC endpoint service. Each external key store
must use a different private DNS name.
The combined XksProxyUriEndpoint
and XksProxyUriPath
values must be
unique in the Amazon Web Services account and Region.
To change this value, the external key store must be disconnected.
updateCustomKeyStore_xksProxyUriPath :: Lens' UpdateCustomKeyStore (Maybe Text) Source #
Changes the base path to the proxy APIs for this external key store. To
find this value, see the documentation for your external key manager and
external key store proxy (XKS proxy). This parameter is valid only for
custom key stores with a CustomKeyStoreType
of EXTERNAL_KEY_STORE
.
The value must start with /
and must end with /kms/xks/v1
, where
v1
represents the version of the KMS external key store proxy API. You
can include an optional prefix between the required elements such as
/
example
/kms/xks/v1
.
The combined XksProxyUriEndpoint
and XksProxyUriPath
values must be
unique in the Amazon Web Services account and Region.
You can change this value when the external key store is connected or disconnected.
updateCustomKeyStore_xksProxyVpcEndpointServiceName :: Lens' UpdateCustomKeyStore (Maybe Text) Source #
Changes the name that KMS uses to identify the Amazon VPC endpoint
service for your external key store proxy (XKS proxy). This parameter is
valid when the CustomKeyStoreType
is EXTERNAL_KEY_STORE
and the
XksProxyConnectivity
is VPC_ENDPOINT_SERVICE
.
To change this value, the external key store must be disconnected.
updateCustomKeyStore_customKeyStoreId :: Lens' UpdateCustomKeyStore Text Source #
Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
Destructuring the Response
data UpdateCustomKeyStoreResponse Source #
See: newUpdateCustomKeyStoreResponse
smart constructor.
UpdateCustomKeyStoreResponse' | |
|
Instances
newUpdateCustomKeyStoreResponse Source #
Create a value of UpdateCustomKeyStoreResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateCustomKeyStoreResponse'
, updateCustomKeyStoreResponse_httpStatus
- The response's http status code.
Response Lenses
updateCustomKeyStoreResponse_httpStatus :: Lens' UpdateCustomKeyStoreResponse Int Source #
The response's http status code.