Class: Aws::RDS::Types::DescribeGlobalClustersMessage

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::Filter>

A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.

Currently, the only supported filter is region.

If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.

Returns:



14140
14141
14142
14143
14144
14145
14146
14147
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14140

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

#global_cluster_identifierString

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

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

^

Returns:

  • (String)


14140
14141
14142
14143
14144
14145
14146
14147
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14140

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)


14140
14141
14142
14143
14144
14145
14146
14147
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14140

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.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer)


14140
14141
14142
14143
14144
14145
14146
14147
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14140

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