Class: Aws::RDS::Types::DescribeDBParametersMessage

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DescribeDBParametersMessage

Includes:

Structure

Defined in:

lib/aws-sdk-rds/types.rb

Overview

Note:

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

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

See Also:

• AWS API Documentation

Instance Attribute Summary

• #db_parameter_group_name ⇒ String

  The name of a specific DB parameter group to return details for.

• #filters ⇒ Array<Types::Filter>

  This parameter is not currently supported.

• #marker ⇒ String

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

• #max_records ⇒ Integer

  The maximum number of records to include in the response.

• #source ⇒ String

  The parameter types to return.

Instance Attribute Details

#db_parameter_group_name ⇒ String

The name of a specific DB parameter group to return details for.

Constraints:

• If supplied, must match the name of an existing DBParameterGroup.

^

Returns:

• (String)

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

class DescribeDBParametersMessage < Struct.new(
  :db_parameter_group_name,
  :source,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

This parameter is not currently supported.

Returns:

• (Array<Types::Filter>)

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

class DescribeDBParametersMessage < Struct.new(
  :db_parameter_group_name,
  :source,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#marker ⇒ String

An optional pagination token provided by a previous ‘DescribeDBParameters` 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 7518

class DescribeDBParametersMessage < Struct.new(
  :db_parameter_group_name,
  :source,
  :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 7518

class DescribeDBParametersMessage < Struct.new(
  :db_parameter_group_name,
  :source,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#source ⇒ String

The parameter types to return.

Default: All parameter types returned

Valid Values: ‘user | system | engine-default`

Returns:

• (String)

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

class DescribeDBParametersMessage < Struct.new(
  :db_parameter_group_name,
  :source,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end