Struct aws_sdk_kms::client::fluent_builders::CreateCustomKeyStore

pub struct CreateCustomKeyStore { /* private fields */ }

Fluent builder constructing a request to CreateCustomKeyStore.

Creates a custom key store that is associated with an CloudHSM cluster that you own and manage.

This operation is part of the custom key store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store.

Before you create the custom key store, you must assemble the required elements, including an CloudHSM cluster that fulfills the requirements for a custom key store. For details about the required elements, see Assemble the Prerequisites in the Key Management Service Developer Guide.

When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.

For help with failures, see Troubleshooting a Custom Key Store in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

Required permissions: kms:CreateCustomKeyStore (IAM policy).

Related operations:

• ConnectCustomKeyStore

• DeleteCustomKeyStore

• DescribeCustomKeyStores

• DisconnectCustomKeyStore

• UpdateCustomKeyStore

Implementations

impl CreateCustomKeyStore

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateCustomKeyStore, AwsResponseRetryClassifier>, SdkError<CreateCustomKeyStoreError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateCustomKeyStoreOutput, SdkError<CreateCustomKeyStoreError>>

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 custom_key_store_name(self, input: impl Into<String>) -> Self

Specifies a friendly name for the custom key store. The name must be unique in your Amazon Web Services account.

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

Specifies a friendly name for the custom key store. The name must be unique in your Amazon Web Services account.

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

Identifies the CloudHSM cluster for the custom key store. Enter the cluster ID of any active CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

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

Identifies the CloudHSM cluster for the custom key store. Enter the cluster ID of any active CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

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

Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

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

Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

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

Enter the password of the kmsuser crypto user (CU) account in the specified CloudHSM cluster. KMS logs into the cluster as this user to manage key material on your behalf.

The password must be a string of 7 to 32 characters. Its value is case sensitive.

This parameter tells KMS the kmsuser account password; it does not change the password in the CloudHSM cluster.

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

Enter the password of the kmsuser crypto user (CU) account in the specified CloudHSM cluster. KMS logs into the cluster as this user to manage key material on your behalf.

The password must be a string of 7 to 32 characters. Its value is case sensitive.

This parameter tells KMS the kmsuser account password; it does not change the password in the CloudHSM cluster.

Trait Implementations

impl Clone for CreateCustomKeyStore

fn clone(&self) -> CreateCustomKeyStore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCustomKeyStore

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

Formats the value using the given formatter.