Class: Aws::RDS::Types::DescribeDBProxiesRequest

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 DescribeDBProxiesRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_proxy_nameString

The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.

Returns:

  • (String)

11219
11220
11221
11222
11223
11224
11225
11226
# File 'lib/aws-sdk-rds/types.rb', line 11219

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

#filtersArray<Types::Filter>

This parameter is not currently supported.

Returns:


11219
11220
11221
11222
11223
11224
11225
11226
# File 'lib/aws-sdk-rds/types.rb', line 11219

class DescribeDBProxiesRequest < Struct.new(
  :db_proxy_name,
  :filters,
  :marker,
  :max_records)
  SENSITIVE = []
  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)

11219
11220
11221
11222
11223
11224
11225
11226
# File 'lib/aws-sdk-rds/types.rb', line 11219

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

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer)

11219
11220
11221
11222
11223
11224
11225
11226
# File 'lib/aws-sdk-rds/types.rb', line 11219

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