Class: Aws::RDS::Types::DescribeDBClustersMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::DescribeDBClustersMessage
- Defined in:
- gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb
Overview
When making an API call, you may pass DescribeDBClustersMessage data as a hash:
{
db_cluster_identifier: "String",
filters: [
{
name: "String", # required
values: ["String"], # required
},
],
max_records: 1,
marker: "String",
include_shared: false,
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#db_cluster_identifier ⇒ String
The user-supplied DB cluster identifier.
-
#filters ⇒ Array<Types::Filter>
A filter that specifies one or more DB clusters to describe.
-
#include_shared ⇒ Boolean
Optional Boolean parameter that specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
-
#marker ⇒ String
An optional pagination token provided by a previous
DescribeDBClusters
request. -
#max_records ⇒ Integer
The maximum number of records to include in the response.
Instance Attribute Details
#db_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.
^
10718 10719 10720 10721 10722 10723 10724 10725 10726 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10718 class DescribeDBClustersMessage < Struct.new( :db_cluster_identifier, :filters, :max_records, :marker, :include_shared) SENSITIVE = [] include Aws::Structure end |
#filters ⇒ Array<Types::Filter>
A filter that specifies one or more DB clusters to describe.
Supported filters:
clone-group-id
- Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.domain
- Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.engine
- Accepts engine names. The results list only includes information about the DB clusters for these engines.
10718 10719 10720 10721 10722 10723 10724 10725 10726 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10718 class DescribeDBClustersMessage < Struct.new( :db_cluster_identifier, :filters, :max_records, :marker, :include_shared) SENSITIVE = [] include Aws::Structure end |
#include_shared ⇒ Boolean
Optional Boolean parameter that specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
10718 10719 10720 10721 10722 10723 10724 10725 10726 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10718 class DescribeDBClustersMessage < Struct.new( :db_cluster_identifier, :filters, :max_records, :marker, :include_shared) SENSITIVE = [] include Aws::Structure end |
#marker ⇒ String
An optional pagination token provided by a previous
DescribeDBClusters
request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords
.
10718 10719 10720 10721 10722 10723 10724 10725 10726 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10718 class DescribeDBClustersMessage < Struct.new( :db_cluster_identifier, :filters, :max_records, :marker, :include_shared) 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 you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
10718 10719 10720 10721 10722 10723 10724 10725 10726 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10718 class DescribeDBClustersMessage < Struct.new( :db_cluster_identifier, :filters, :max_records, :marker, :include_shared) SENSITIVE = [] include Aws::Structure end |