Class: Aws::DocDB::Types::DescribeDBClustersMessage

Inherits:

Struct

• Object
• Struct
• Aws::DocDB::Types::DescribeDBClustersMessage

Includes:

Structure

Defined in:

lib/aws-sdk-docdb/types.rb

Overview

Note:

When making an API call, you may pass DescribeDBClustersMessage data as a hash:

{
  db_cluster_identifier: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
}

Represents the input to DescribeDBClusters.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #db_cluster_identifier ⇒ String

  The user-provided cluster identifier.

• #filters ⇒ Array<Types::Filter>

  A filter that specifies one or more clusters to describe.

• #marker ⇒ String

  An optional pagination token provided by a previous request.

• #max_records ⇒ Integer

  The maximum number of records to include in the response.

Instance Attribute Details

#db_cluster_identifier ⇒ 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`.

^

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 3023

class DescribeDBClustersMessage < Struct.new(
  :db_cluster_identifier,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::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.

^

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-docdb/types.rb', line 3023

class DescribeDBClustersMessage < Struct.new(
  :db_cluster_identifier,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#marker ⇒ 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`.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 3023

class DescribeDBClustersMessage < Struct.new(
  :db_cluster_identifier,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#max_records ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-docdb/types.rb', line 3023

class DescribeDBClustersMessage < Struct.new(
  :db_cluster_identifier,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end