aws_sdk_dsql/client/
get_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 [`GetCluster`](crate::operation::get_cluster::builders::GetClusterFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`identifier(impl Into<String>)`](crate::operation::get_cluster::builders::GetClusterFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::get_cluster::builders::GetClusterFluentBuilder::set_identifier):<br>required: **true**<br><p>The ID of the cluster to retrieve.</p><br>
7    /// - On success, responds with [`GetClusterOutput`](crate::operation::get_cluster::GetClusterOutput) with field(s):
8    ///   - [`identifier(String)`](crate::operation::get_cluster::GetClusterOutput::identifier): <p>The ID of the retrieved cluster.</p>
9    ///   - [`arn(String)`](crate::operation::get_cluster::GetClusterOutput::arn): <p>The ARN of the retrieved cluster.</p>
10    ///   - [`status(ClusterStatus)`](crate::operation::get_cluster::GetClusterOutput::status): <p>The status of the retrieved cluster.</p>
11    ///   - [`creation_time(DateTime)`](crate::operation::get_cluster::GetClusterOutput::creation_time): <p>The time of when the cluster was created.</p>
12    ///   - [`witness_region(Option<String>)`](crate::operation::get_cluster::GetClusterOutput::witness_region): <p>The witness Region of the cluster. Applicable only for multi-Region clusters.</p>
13    ///   - [`linked_cluster_arns(Option<Vec::<String>>)`](crate::operation::get_cluster::GetClusterOutput::linked_cluster_arns): <p>The ARNs of the clusters linked to the retrieved cluster.</p>
14    ///   - [`deletion_protection_enabled(bool)`](crate::operation::get_cluster::GetClusterOutput::deletion_protection_enabled): <p>Whether deletion protection is enabled in this cluster.</p>
15    ///   - [`multi_region_properties(Option<MultiRegionProperties>)`](crate::operation::get_cluster::GetClusterOutput::multi_region_properties): <p>Returns the current multi-Region cluster configuration, including witness region and linked cluster information.</p>
16    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_cluster::GetClusterOutput::tags): <p>Map of tags.</p>
17    /// - On failure, responds with [`SdkError<GetClusterError>`](crate::operation::get_cluster::GetClusterError)
18    pub fn get_cluster(&self) -> crate::operation::get_cluster::builders::GetClusterFluentBuilder {
19        crate::operation::get_cluster::builders::GetClusterFluentBuilder::new(self.handle.clone())
20    }
21}
aws_sdk_dsql/client/get_cluster.rs

aws_sdk_dsql/client/
get_cluster.rs
