aws_sdk_cloudhsmv2/client/
modify_cluster.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ModifyCluster`](crate::operation::modify_cluster::builders::ModifyClusterFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`hsm_type(impl Into<String>)`](crate::operation::modify_cluster::builders::ModifyClusterFluentBuilder::hsm_type) / [`set_hsm_type(Option<String>)`](crate::operation::modify_cluster::builders::ModifyClusterFluentBuilder::set_hsm_type):<br>required: **false**<br><p>The desired HSM type of the cluster.</p><br>
7    ///   - [`backup_retention_policy(BackupRetentionPolicy)`](crate::operation::modify_cluster::builders::ModifyClusterFluentBuilder::backup_retention_policy) / [`set_backup_retention_policy(Option<BackupRetentionPolicy>)`](crate::operation::modify_cluster::builders::ModifyClusterFluentBuilder::set_backup_retention_policy):<br>required: **false**<br><p>A policy that defines how the service retains backups.</p><br>
8    ///   - [`cluster_id(impl Into<String>)`](crate::operation::modify_cluster::builders::ModifyClusterFluentBuilder::cluster_id) / [`set_cluster_id(Option<String>)`](crate::operation::modify_cluster::builders::ModifyClusterFluentBuilder::set_cluster_id):<br>required: **true**<br><p>The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use <code>DescribeClusters</code>.</p><br>
9    /// - On success, responds with [`ModifyClusterOutput`](crate::operation::modify_cluster::ModifyClusterOutput) with field(s):
10    ///   - [`cluster(Option<Cluster>)`](crate::operation::modify_cluster::ModifyClusterOutput::cluster): <p>Contains information about an CloudHSM cluster.</p>
11    /// - On failure, responds with [`SdkError<ModifyClusterError>`](crate::operation::modify_cluster::ModifyClusterError)
12    pub fn modify_cluster(&self) -> crate::operation::modify_cluster::builders::ModifyClusterFluentBuilder {
13        crate::operation::modify_cluster::builders::ModifyClusterFluentBuilder::new(self.handle.clone())
14    }
15}