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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb

Overview

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",
}

Represents the input to DescribeDBInstances.

Instance Attribute Summary collapse

Instance Attribute Details

#db_instance_identifierString

The user-provided instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case sensitive.

Constraints:

  • If provided, must match the identifier of an existing DBInstance.

^

Returns:

  • (String)


2664
2665
2666
2667
2668
2669
2670
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2664

class DescribeDBInstancesMessage < Struct.new(
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#filtersArray<Types::Filter>

A filter that specifies one or more DB instances to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list includes only the information about the DB instances that are associated with the DB clusters that are identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list includes only the information about the DB instances that are identified by these ARNs.

Returns:



2664
2665
2666
2667
2668
2669
2670
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2664

class DescribeDBInstancesMessage < Struct.new(
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#markerString

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)


2664
2665
2666
2667
2668
2669
2670
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2664

class DescribeDBInstancesMessage < Struct.new(
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#max_recordsInteger

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)


2664
2665
2666
2667
2668
2669
2670
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2664

class DescribeDBInstancesMessage < Struct.new(
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end