class Aws::DocDB::Types::DescribeDBInstancesMessage
Represents the input to DescribeDBInstances.
@note When making an API call, you may pass DescribeDBInstancesMessage
data as a hash: { db_instance_identifier: "String", filters: [ { name: "String", # required values: ["String"], # required }, ], max_records: 1, marker: "String", }
@!attribute [rw] db_instance_identifier
The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive. Constraints: * If provided, must match the identifier of an existing `DBInstance`. ^ @return [String]
@!attribute [rw] filters
A filter that specifies one or more instances to describe. Supported filters: * `db-cluster-id` - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs. * `db-instance-id` - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs. @return [Array<Types::Filter>]
@!attribute [rw] max_records
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. @return [Integer]
@!attribute [rw] marker
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBInstancesMessage AWS API Documentation
Constants
- SENSITIVE