Struct aws_sdk_kms::operation::disconnect_custom_key_store::builders::DisconnectCustomKeyStoreFluentBuilder

pub struct DisconnectCustomKeyStoreFluentBuilder { /* private fields */ }

Fluent builder constructing a request to DisconnectCustomKeyStore.

Disconnects the custom key store from its backing key store. This operation disconnects an CloudHSM key store from its associated CloudHSM cluster or disconnects an external key store from the external key store proxy that communicates with your external key manager.

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.

While a custom key store is disconnected, you can manage the custom key store and its KMS keys, but you cannot create or use its KMS keys. You can reconnect the custom key store at any time.

While a custom key store is disconnected, all attempts to create KMS keys in the custom key store or to use existing KMS keys in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data.

When you disconnect a custom key store, its ConnectionState changes to Disconnected. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation.

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

Related operations:

• ConnectCustomKeyStore

• CreateCustomKeyStore

• DeleteCustomKeyStore

• DescribeCustomKeyStores

• UpdateCustomKeyStore

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

Implementations

impl DisconnectCustomKeyStoreFluentBuilder

pub fn as_input(&self) -> &DisconnectCustomKeyStoreInputBuilder

Access the DisconnectCustomKeyStore as a reference.

pub async fn send( self ) -> Result<DisconnectCustomKeyStoreOutput, SdkError<DisconnectCustomKeyStoreError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<DisconnectCustomKeyStoreOutput, DisconnectCustomKeyStoreError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn custom_key_store_id(self, input: impl Into<String>) -> Self

Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

pub fn set_custom_key_store_id(self, input: Option<String>) -> Self

Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

pub fn get_custom_key_store_id(&self) -> &Option<String>

Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Trait Implementations

impl Clone for DisconnectCustomKeyStoreFluentBuilder

fn clone(&self) -> DisconnectCustomKeyStoreFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DisconnectCustomKeyStoreFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.