Struct aws_sdk_docdb::client::fluent_builders::DescribeGlobalClusters

pub struct DescribeGlobalClusters { /* private fields */ }

Fluent builder constructing a request to DescribeGlobalClusters.

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

This action only applies to Amazon DocumentDB clusters.

Implementations

impl DescribeGlobalClusters

pub async fn send(
    self
) -> Result<DescribeGlobalClustersOutput, SdkError<DescribeGlobalClustersError>>

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) -> DescribeGlobalClustersPaginator

Create a paginator for this request

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

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

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

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

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

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 global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

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

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

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

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 that you can retrieve the remaining results.

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 that you can retrieve the remaining results.

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

An optional pagination token provided by a previous DescribeGlobalClusters 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 DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Trait Implementations

impl Clone for DescribeGlobalClusters

fn clone(&self) -> DescribeGlobalClusters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeGlobalClusters

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

Formats the value using the given formatter.