Class: Aws::DocDB::Types::DescribeGlobalClustersMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::DocDB::Types::DescribeGlobalClustersMessage
- Defined in:
- gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#filters ⇒ Array<Types::Filter>
A filter that specifies one or more global DB clusters to describe.
-
#global_cluster_identifier ⇒ String
The user-supplied cluster identifier.
-
#marker ⇒ String
An optional pagination token provided by a previous
DescribeGlobalClusters
request. -
#max_records ⇒ Integer
The maximum number of records to include in the response.
Instance Attribute Details
#filters ⇒ Array<Types::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.
3287 3288 3289 3290 3291 3292 3293 3294 |
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3287 class DescribeGlobalClustersMessage < Struct.new( :global_cluster_identifier, :filters, :max_records, :marker) SENSITIVE = [] include Aws::Structure end |
#global_cluster_identifier ⇒ 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.
3287 3288 3289 3290 3291 3292 3293 3294 |
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3287 class DescribeGlobalClustersMessage < Struct.new( :global_cluster_identifier, :filters, :max_records, :marker) SENSITIVE = [] include Aws::Structure end |
#marker ⇒ 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
.
3287 3288 3289 3290 3291 3292 3293 3294 |
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3287 class DescribeGlobalClustersMessage < Struct.new( :global_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 called a marker is included in the response so that you can
retrieve the remaining results.
3287 3288 3289 3290 3291 3292 3293 3294 |
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3287 class DescribeGlobalClustersMessage < Struct.new( :global_cluster_identifier, :filters, :max_records, :marker) SENSITIVE = [] include Aws::Structure end |