AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::DocDB::Types::DescribeGlobalClustersMessage

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

Overview

Note:

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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns:



3568
3569
3570
3571
3572
3573
3574
3575
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3568

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

#global_cluster_identifierString

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

Returns:

  • (String)


3568
3569
3570
3571
3572
3573
3574
3575
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3568

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

#markerString

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.

Returns:

  • (String)


3568
3569
3570
3571
3572
3573
3574
3575
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3568

class DescribeGlobalClustersMessage < Struct.new(
  :global_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 called a marker is included in the response so that you can retrieve the remaining results.

Returns:

  • (Integer)


3568
3569
3570
3571
3572
3573
3574
3575
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3568

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