Struct aws_sdk_cloudhsm::operation::create_hsm::builders::CreateHsmFluentBuilder

pub struct CreateHsmFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateHsm.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Creates an uninitialized HSM instance.

There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support.

It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.

Implementations

impl CreateHsmFluentBuilder

pub fn as_input(&self) -> &CreateHsmInputBuilder

Access the CreateHsm as a reference.

pub async fn send( self ) -> Result<CreateHsmOutput, SdkError<CreateHsmError, 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 async fn customize( self ) -> Result<CustomizableOperation<CreateHsmOutput, CreateHsmError>, SdkError<CreateHsmError>>

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

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

The identifier of the subnet in your VPC in which to place the HSM.

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

The identifier of the subnet in your VPC in which to place the HSM.

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

The identifier of the subnet in your VPC in which to place the HSM.

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

The SSH public key to install on the HSM.

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

The SSH public key to install on the HSM.

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

The SSH public key to install on the HSM.

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

The IP address to assign to the HSM's ENI.

If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.

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

The IP address to assign to the HSM's ENI.

If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.

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

The IP address to assign to the HSM's ENI.

If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.

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

The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

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

The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

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

The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

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

The external ID from IamRoleArn, if present.

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

The external ID from IamRoleArn, if present.

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

The external ID from IamRoleArn, if present.

pub fn subscription_type(self, input: SubscriptionType) -> Self

Specifies the type of subscription for the HSM.

• PRODUCTION - The HSM is being used in a production environment.

• TRIAL - The HSM is being used in a product trial.

pub fn set_subscription_type(self, input: Option<SubscriptionType>) -> Self

Specifies the type of subscription for the HSM.

• PRODUCTION - The HSM is being used in a production environment.

• TRIAL - The HSM is being used in a product trial.

pub fn get_subscription_type(&self) -> &Option<SubscriptionType>

Specifies the type of subscription for the HSM.

• PRODUCTION - The HSM is being used in a production environment.

• TRIAL - The HSM is being used in a product trial.

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

A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

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

A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

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

A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

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

The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

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

The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

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

The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

Trait Implementations

impl Clone for CreateHsmFluentBuilder

fn clone(&self) -> CreateHsmFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateHsmFluentBuilder

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

Formats the value using the given formatter.