Class: Aws::RDS::Types::DescribeDBProxyEndpointsRequest

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

{
  db_proxy_name: "DBProxyName",
  db_proxy_endpoint_name: "DBProxyEndpointName",
  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_endpoint_nameString

The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.

Returns:

  • (String)


11389
11390
11391
11392
11393
11394
11395
11396
11397
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11389

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

#db_proxy_nameString

The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.

Returns:

  • (String)


11389
11390
11391
11392
11393
11394
11395
11396
11397
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11389

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

#filtersArray<Types::Filter>

This parameter is not currently supported.

Returns:



11389
11390
11391
11392
11393
11394
11395
11396
11397
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11389

class DescribeDBProxyEndpointsRequest < Struct.new(
  :db_proxy_name,
  :db_proxy_endpoint_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)


11389
11390
11391
11392
11393
11394
11395
11396
11397
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11389

class DescribeDBProxyEndpointsRequest < Struct.new(
  :db_proxy_name,
  :db_proxy_endpoint_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)


11389
11390
11391
11392
11393
11394
11395
11396
11397
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11389

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