aws_sdk_rds/client/
describe_db_clusters.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeDBClusters`](crate::operation::describe_db_clusters::builders::DescribeDBClustersFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_db_clusters::builders::DescribeDBClustersFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`db_cluster_identifier(impl Into<String>)`](crate::operation::describe_db_clusters::builders::DescribeDBClustersFluentBuilder::db_cluster_identifier) / [`set_db_cluster_identifier(Option<String>)`](crate::operation::describe_db_clusters::builders::DescribeDBClustersFluentBuilder::set_db_cluster_identifier):<br>required: **false**<br><p>The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul>  <li>   <p>If supplied, must match an existing DB cluster identifier.</p></li> </ul><br>
    ///   - [`filters(Filter)`](crate::operation::describe_db_clusters::builders::DescribeDBClustersFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_db_clusters::builders::DescribeDBClustersFluentBuilder::set_filters):<br>required: **false**<br><p>A filter that specifies one or more DB clusters to describe.</p> <p>Supported Filters:</p> <ul>  <li>   <p><code>clone-group-id</code> - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.</p></li>  <li>   <p><code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.</p></li>  <li>   <p><code>db-cluster-resource-id</code> - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.</p></li>  <li>   <p><code>domain</code> - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.</p></li>  <li>   <p><code>engine</code> - Accepts engine names. The results list only includes information about the DB clusters for these engines.</p></li> </ul><br>
    ///   - [`max_records(i32)`](crate::operation::describe_db_clusters::builders::DescribeDBClustersFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_db_clusters::builders::DescribeDBClustersFluentBuilder::set_max_records):<br>required: **false**<br><p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100</p><br>
    ///   - [`marker(impl Into<String>)`](crate::operation::describe_db_clusters::builders::DescribeDBClustersFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_db_clusters::builders::DescribeDBClustersFluentBuilder::set_marker):<br>required: **false**<br><p>An optional pagination token provided by a previous <code>DescribeDBClusters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p><br>
    ///   - [`include_shared(bool)`](crate::operation::describe_db_clusters::builders::DescribeDBClustersFluentBuilder::include_shared) / [`set_include_shared(Option<bool>)`](crate::operation::describe_db_clusters::builders::DescribeDBClustersFluentBuilder::set_include_shared):<br>required: **false**<br><p>Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.</p><br>
    /// - On success, responds with [`DescribeDbClustersOutput`](crate::operation::describe_db_clusters::DescribeDbClustersOutput) with field(s):
    ///   - [`marker(Option<String>)`](crate::operation::describe_db_clusters::DescribeDbClustersOutput::marker): <p>A pagination token that can be used in a later <code>DescribeDBClusters</code> request.</p>
    ///   - [`db_clusters(Option<Vec::<DbCluster>>)`](crate::operation::describe_db_clusters::DescribeDbClustersOutput::db_clusters): <p>Contains a list of DB clusters for the user.</p>
    /// - On failure, responds with [`SdkError<DescribeDBClustersError>`](crate::operation::describe_db_clusters::DescribeDBClustersError)
    pub fn describe_db_clusters(&self) -> crate::operation::describe_db_clusters::builders::DescribeDBClustersFluentBuilder {
        crate::operation::describe_db_clusters::builders::DescribeDBClustersFluentBuilder::new(self.handle.clone())
    }
}