Class: Aws::RDS::Types::DescribeDBInstancesMessage

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DescribeDBInstancesMessage

Includes:

Structure

Defined in:

lib/aws-sdk-rds/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",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #db_instance_identifier ⇒ String

  The user-supplied instance identifier.

• #filters ⇒ Array<Types::Filter>

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

• #marker ⇒ String

  An optional pagination token provided by a previous ‘DescribeDBInstances` request.

• #max_records ⇒ Integer

  The maximum number of records to include in the response.

Instance Attribute Details

#db_instance_identifier ⇒ String

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

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 6092

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

#filters ⇒ Array<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 will only include information about the DB instances associated with the DB Clusters identified by these ARNs.

• ‘db-instance-id` - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-rds/types.rb', line 6092

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

#marker ⇒ String

An optional pagination token provided by a previous ‘DescribeDBInstances` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 6092

class DescribeDBInstancesMessage < Struct.new(
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker)
  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 that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

• (Integer)

# File 'lib/aws-sdk-rds/types.rb', line 6092

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