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

Class: Aws::RDS::Types::DescribeDBSubnetGroupsMessage

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

Overview

Note:

When making an API call, you may pass DescribeDBSubnetGroupsMessage data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#db_subnet_group_nameString

The name of the DB subnet group to return details for.

Returns:

  • (String)


6610
6611
6612
6613
6614
6615
6616
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6610

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

#filtersArray<Types::Filter>

This parameter is not currently supported.

Returns:



6610
6611
6612
6613
6614
6615
6616
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6610

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

#markerString

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

Returns:

  • (String)


6610
6611
6612
6613
6614
6615
6616
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6610

class DescribeDBSubnetGroupsMessage < Struct.new(
  :db_subnet_group_name,
  :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 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)


6610
6611
6612
6613
6614
6615
6616
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6610

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