You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Neptune::Types::DescribeDBClustersMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::Neptune::Types::DescribeDBClustersMessage
- Defined in:
- (unknown)
Overview
When passing DescribeDBClustersMessage as input to an Aws::Client method, you can use a vanilla Hash:
{
db_cluster_identifier: "String",
filters: [
{
name: "String", # required
values: ["String"], # required
},
],
max_records: 1,
marker: "String",
}
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.
-
#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.
^
#filters ⇒ Array<Types::Filter>
A filter that specifies one or more 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.engine
- Accepts an engine name (such asneptune
), and restricts the results list to DB clusters created by that engine.
For example, to invoke this API from the AWS CLI and filter so that only Neptune DB clusters are returned, you could use the following command:
#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
.
#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.