Class: Aws::RDS::Types::DescribeGlobalClustersMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::DescribeGlobalClustersMessage
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-rds/types.rb
Overview
When making an API call, you may pass DescribeGlobalClustersMessage data as a hash:
{
global_cluster_identifier: "String",
filters: [
{
name: "String", # required
values: ["String"], # required
},
],
max_records: 1,
marker: "String",
}
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 DB 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 DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.
^
8188 8189 8190 8191 8192 8193 8194 |
# File 'lib/aws-sdk-rds/types.rb', line 8188 class DescribeGlobalClustersMessage < Struct.new( :global_cluster_identifier, :filters, :max_records, :marker) include Aws::Structure end |
#global_cluster_identifier ⇒ String
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.
^
8188 8189 8190 8191 8192 8193 8194 |
# File 'lib/aws-sdk-rds/types.rb', line 8188 class DescribeGlobalClustersMessage < Struct.new( :global_cluster_identifier, :filters, :max_records, :marker) 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`.
8188 8189 8190 8191 8192 8193 8194 |
# File 'lib/aws-sdk-rds/types.rb', line 8188 class DescribeGlobalClustersMessage < Struct.new( :global_cluster_identifier, :filters, :max_records, :marker) 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 the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
8188 8189 8190 8191 8192 8193 8194 |
# File 'lib/aws-sdk-rds/types.rb', line 8188 class DescribeGlobalClustersMessage < Struct.new( :global_cluster_identifier, :filters, :max_records, :marker) include Aws::Structure end |