You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DocDB::Types::DescribeDBInstancesMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeDBInstancesMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  db_instance_identifier: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
}

Represents the input to DescribeDBInstances.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#db_instance_identifier ⇒ String

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.

^

Returns:

  • (String) —

    The user-provided instance identifier.

#filters ⇒ Array<Types::Filter>

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.

Returns:

  • (Array<Types::Filter>) —

    A filter that specifies one or more instances to describe.

#marker ⇒ String

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.

Returns:

  • (String) —

    An optional pagination token provided by a previous request.

#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 (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer) —

    The maximum number of records to include in the response.