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
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#db_cluster_identifier ⇒ String
The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster.
-
#filters ⇒ Array<Types::Filter>
A filter that specifies one or more DB clusters to describe.
-
#include_shared ⇒ Boolean
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 or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
- If supplied, must match an existing DB cluster identifier.
^
12337 12338 12339 12340 12341 12342 12343 12344 12345 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12337 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.db-cluster-resource-id
- Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.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.
12337 12338 12339 12340 12341 12342 12343 12344 12345 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12337 class DescribeDBClustersMessage < Struct.new( :db_cluster_identifier, :filters, :max_records, :marker, :include_shared) SENSITIVE = [] include Aws::Structure end |
#include_shared ⇒ Boolean
Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
12337 12338 12339 12340 12341 12342 12343 12344 12345 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12337 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
.
12337 12338 12339 12340 12341 12342 12343 12344 12345 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12337 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
12337 12338 12339 12340 12341 12342 12343 12344 12345 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12337 class DescribeDBClustersMessage < Struct.new( :db_cluster_identifier, :filters, :max_records, :marker, :include_shared) SENSITIVE = [] include Aws::Structure end |