Struct aws_sdk_rds::client::fluent_builders::DescribeDBClusters

pub struct DescribeDBClusters { /* private fields */ }

Fluent builder constructing a request to DescribeDBClusters.

Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

The Multi-AZ DB clusters feature is in preview and is subject to change.

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

Implementations

impl DescribeDBClusters

pub async fn send(
    self
) -> Result<DescribeDbClustersOutput, SdkError<DescribeDBClustersError>>

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 into_paginator(self) -> DescribeDbClustersPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

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

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match an existing DBClusterIdentifier.

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

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match an existing DBClusterIdentifier.

pub fn filters(self, input: Filter) -> Self

Appends an item to Filters.

To override the contents of this collection use set_filters.

A filter that specifies one or more DB clusters to describe.

Supported filters:

• clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

• db-cluster-id - 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.

• domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.

• engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self

A filter that specifies one or more DB clusters to describe.

Supported filters:

• clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

• db-cluster-id - 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.

• domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.

• engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

pub fn max_records(self, input: i32) -> Self

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

pub fn set_max_records(self, input: Option<i32>) -> Self

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

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

An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

pub fn include_shared(self, input: bool) -> Self

Optional Boolean parameter that specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

pub fn set_include_shared(self, input: Option<bool>) -> Self

Optional Boolean parameter that specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

Trait Implementations

impl Clone for DescribeDBClusters

fn clone(&self) -> DescribeDBClusters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeDBClusters

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

Formats the value using the given formatter.