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

Inherits:
Struct
  • Object
show all
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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_instance_identifierString

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:

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

^

Returns:

  • (String)

10920
10921
10922
10923
10924
10925
10926
10927
# File 'lib/aws-sdk-rds/types.rb', line 10920

class DescribeDBInstancesMessage < Struct.new(
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  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 only includes 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 only includes information about the DB instances identified by these ARNs.

  • `dbi-resource-id` - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

  • `domain` - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.

  • `engine` - Accepts engine names. The results list only includes information about the DB instances for these engines.

Returns:


10920
10921
10922
10923
10924
10925
10926
10927
# File 'lib/aws-sdk-rds/types.rb', line 10920

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

#markerString

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)

10920
10921
10922
10923
10924
10925
10926
10927
# File 'lib/aws-sdk-rds/types.rb', line 10920

class DescribeDBInstancesMessage < Struct.new(
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  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 called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer)

10920
10921
10922
10923
10924
10925
10926
10927
# File 'lib/aws-sdk-rds/types.rb', line 10920

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