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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb

Overview

Represents the input to DescribeDBClusters.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_cluster_identifierString

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)


2741
2742
2743
2744
2745
2746
2747
2748
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2741

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

#filtersArray<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:



2741
2742
2743
2744
2745
2746
2747
2748
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2741

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

#markerString

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)


2741
2742
2743
2744
2745
2746
2747
2748
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2741

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

#max_recordsInteger

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)


2741
2742
2743
2744
2745
2746
2747
2748
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2741

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