Struct aws_sdk_docdb::operation::describe_db_clusters::DescribeDbClustersInput

#[non_exhaustive]
pub struct DescribeDbClustersInput {
    pub db_cluster_identifier: Option<String>,
    pub filters: Option<Vec<Filter>>,
    pub max_records: Option<i32>,
    pub marker: Option<String>,
}

Represents the input to DescribeDBClusters.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

db_cluster_identifier: Option<String>

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

Constraints:

• If provided, must match an existing DBClusterIdentifier.

filters: Option<Vec<Filter>>

A filter that specifies one or more clusters to describe.

Supported filters:

• db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

max_records: Option<i32>

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

marker: Option<String>

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

Implementations

impl DescribeDbClustersInput

pub fn db_cluster_identifier(&self) -> Option<&str>

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

Constraints:

• If provided, must match an existing DBClusterIdentifier.

pub fn filters(&self) -> Option<&[Filter]>

A filter that specifies one or more clusters to describe.

Supported filters:

• db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

pub fn max_records(&self) -> Option<i32>

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

pub fn marker(&self) -> Option<&str>

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

impl DescribeDbClustersInput

pub fn builder() -> DescribeDbClustersInputBuilder

Creates a new builder-style object to manufacture DescribeDbClustersInput.

Trait Implementations

impl Clone for DescribeDbClustersInput

fn clone(&self) -> DescribeDbClustersInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeDbClustersInput

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

Formats the value using the given formatter.

impl PartialEq for DescribeDbClustersInput

fn eq(&self, other: &DescribeDbClustersInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DescribeDbClustersInput