class Aws::KMS::Types::UpdateCustomKeyStoreRequest

@see docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateCustomKeyStoreRequest AWS API Documentation
@return [String]
To change this value, the external key store must be disconnected.
empty string for the ‘XksProxyVpcEndpointServiceName` value.
must also change the `XksProxyUriEndpoint` and specify a null or
If you change the `XksProxyConnectivity` to `PUBLIC_ENDPOINT`, you
`XksProxyVpcEndpointServiceName` value.
you must also change the `XksProxyUriEndpoint` and add an
If you change the `XksProxyConnectivity` to `VPC_ENDPOINT_SERVICE`,
`VPC_ENDPOINT_SERVICE`. Otherwise, specify `PUBLIC_ENDPOINT`.
endpoint service to communicate with KMS, specify
indicate that the external key store proxy uses a Amazon VPC
Changes the connectivity setting for the external key store. To
@!attribute [rw] xks_proxy_connectivity
@return [Types::XksProxyAuthenticationCredentialType]
or disconnected.
You can change this value when the external key store is connected
this parameter to update the credential in KMS.
rotate the credential on your external key store proxy, you can use
established with your external key store proxy. For example, if you
credentials on the proxy. It just tells KMS the credential that you
This parameter doesn’t establish or change your authentication
value.
in the authentication credential, even if you are only updating one
You must specify both the ‘AccessKeyId` and `SecretAccessKey` value
`EXTERNAL_KEY_STORE`.
for custom key stores with a `CustomKeyStoreType` of
external key store proxy (XKS proxy). This parameter is valid only
Changes the credentials that KMS uses to sign requests to the
@!attribute [rw] xks_proxy_authentication_credential
@return [String]
To change this value, the external key store must be disconnected.
`VPC_ENDPOINT_SERVICE`.
`EXTERNAL_KEY_STORE` and the `XksProxyConnectivity` is
parameter is valid when the `CustomKeyStoreType` is
service for your external key store proxy (XKS proxy). This
Changes the name that KMS uses to identify the Amazon VPC endpoint
@!attribute [rw] xks_proxy_vpc_endpoint_service_name
@return [String]
or disconnected.
You can change this value when the external key store is connected
be unique in the Amazon Web Services account and Region.
The combined `XksProxyUriEndpoint` and `XksProxyUriPath` values must
such as `/example/kms/xks/v1`.
You can include an optional prefix between the required elements
`v1` represents the version of the KMS external key store proxy API.
The value must start with `/` and must end with `/kms/xks/v1`, where
`EXTERNAL_KEY_STORE`.
valid only for custom key stores with a `CustomKeyStoreType` of
manager and external key store proxy (XKS proxy). This parameter is
To find this value, see the documentation for your external key
Changes the base path to the proxy APIs for this external key store.
@!attribute [rw] xks_proxy_uri_path
@return [String]
To change this value, the external key store must be disconnected.
be unique in the Amazon Web Services account and Region.
The combined `XksProxyUriEndpoint` and `XksProxyUriPath` values must
store must use a different private DNS name.
DNS name associated with the VPC endpoint service. Each external key
`VPC_ENDPOINT_SERVICE`, specify `https://` followed by the private
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
key stores with a `CustomKeyStoreType` of `EXTERNAL_KEY_STORE`.
key store proxy (XKS proxy). This parameter is valid only for custom
Changes the URI endpoint that KMS uses to connect to your external
@!attribute [rw] xks_proxy_uri_endpoint
@return [String]<br>: docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html<br>[1]: docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore<br><br><br><br>To change this value, the CloudHSM key store must be disconnected.<br><br>[2] operation.
To view the cluster certificate of a cluster, use the<br>requirements] for a cluster associated with a custom key store.
cluster. In addition, the replacement cluster must [fulfill the
this parameter to associate a custom key store with an unrelated
the same cluster certificate as the original cluster. You cannot use
custom key store or a cluster that shares a backup history and has
Enter the cluster ID of the cluster that you used to create the
`CustomKeyStoreType` of `AWS_CLOUDHSM`.
This parameter is valid only for custom key stores with a
Associates the custom key store with a related CloudHSM cluster.
@!attribute [rw] cloud_hsm_cluster_id
@return [String]
To change this value, the CloudHSM key store must be disconnected.
users in the CloudHSM cluster.
crypto user (CU). It does not set or change the password of any
This parameter tells KMS the current password of the `kmsuser`
`CustomKeyStoreType` of `AWS_CLOUDHSM`.
parameter is valid only for custom key stores with a
CloudHSM cluster that is associated with the custom key store. This
Enter the current password of the `kmsuser` crypto user (CU) in the
@!attribute [rw] key_store_password
@return [String]
external key store can be connected or disconnected.
To change this value, an CloudHSM key store must be disconnected. An
other output.
This field may be displayed in plaintext in CloudTrail logs and
Do not include confidential or sensitive information in this field.
Web Services account.
you specify. The custom key store name must be unique in the Amazon
Changes the friendly name of the custom key store to the value that
@!attribute [rw] new_custom_key_store_name
@return [String]
use the DescribeCustomKeyStores operation.
ID of the custom key store. To find the ID of a custom key store,
Identifies the custom key store that you want to update. Enter the
@!attribute [rw] custom_key_store_id