Struct aws_sdk_docdb::operation::describe_global_clusters::DescribeGlobalClustersInput

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

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.

global_cluster_identifier: Option<String>

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

filters: Option<Vec<Filter>>

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.

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 called a marker is included in the response so that you can retrieve the remaining results.

marker: Option<String>

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.

Implementations

impl DescribeGlobalClustersInput

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

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) -> &[Filter]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .filters.is_none().

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 called a marker is included in the response so that you can retrieve the remaining results.

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

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.

impl DescribeGlobalClustersInput

pub fn builder() -> DescribeGlobalClustersInputBuilder

Creates a new builder-style object to manufacture DescribeGlobalClustersInput.

Trait Implementations

impl Clone for DescribeGlobalClustersInput

fn clone(&self) -> DescribeGlobalClustersInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeGlobalClustersInput

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

Formats the value using the given formatter.

impl PartialEq for DescribeGlobalClustersInput

fn eq(&self, other: &DescribeGlobalClustersInput) -> 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 DescribeGlobalClustersInput