Struct aws_sdk_cloudhsm::client::fluent_builders::ModifyHsm

pub struct ModifyHsm<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to ModifyHsm.

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.

Modifies an HSM.

This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.

Implementations

impl<C, M, R> ModifyHsm<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<ModifyHsmOutput, SdkError<ModifyHsmError>> where
    R::Policy: SmithyRetryPolicy<ModifyHsmInputOperationOutputAlias, ModifyHsmOutput, ModifyHsmError, ModifyHsmInputOperationRetryAlias>, 

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

The ARN of the HSM to modify.

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

The ARN of the HSM to modify.

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

The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.

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

The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.

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

The new IP address for the elastic network interface (ENI) attached to the HSM.

If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.

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

The new IP address for the elastic network interface (ENI) attached to the HSM.

If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.

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

The new IAM role ARN.

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

The new IAM role ARN.

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

The new external ID.

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

The new external ID.

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

The new 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 new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for ModifyHsm<C, M, R>

fn clone(&self) -> ModifyHsm<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for ModifyHsm<C, M, R>

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

Formats the value using the given formatter.