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

Class: Aws::RDS::DBParameterGroupFamily

Inherits:
Aws::Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Aws::Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Aws::Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Aws::Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(name, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

  • #initialize(name, options = {}) ⇒ Object

    Parameters:

    • name (String)

    Options Hash (options):

    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :name (required, String)
    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#nameString (readonly)

Returns:

  • (String)

Instance Method Details

#engine_default_cluster_parameters(options = {}) ⇒ Collection<Parameter>

Returns a Collection of Parameter resources. No API requests are made until you call an enumerable method on the collection. Client#describe_engine_default_cluster_parameters will be called multiple times until every Parameter has been yielded.

Examples:

Request syntax example with placeholder values


dbparametergroupfamily.engine_default_cluster_parameters({
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

Enumerating Parameter resources.

dbparametergroupfamily.engine_default_cluster_parameters.each do |parameter|
  # yields each parameter
end

Enumerating Parameter resources with a limit.

dbparametergroupfamily.engine_default_cluster_parameters.limit(10).each do |parameter|
  # yields at most 10 engine_default_cluster_parameters
end

Options Hash (options):

  • :filters (Array<Types::Filter>)

    This parameter is not currently supported.

  • :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.

  • :marker (String)

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

Returns:

See Also:

#engine_default_parameters(options = {}) ⇒ Collection<Parameter>

Returns a Collection of Parameter resources. No API requests are made until you call an enumerable method on the collection. Client#describe_engine_default_parameters will be called multiple times until every Parameter has been yielded.

Examples:

Request syntax example with placeholder values


dbparametergroupfamily.engine_default_parameters({
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

Enumerating Parameter resources.

dbparametergroupfamily.engine_default_parameters.each do |parameter|
  # yields each parameter
end

Enumerating Parameter resources with a limit.

dbparametergroupfamily.engine_default_parameters.limit(10).each do |parameter|
  # yields at most 10 engine_default_parameters
end

Options Hash (options):

  • :filters (Array<Types::Filter>)

    Not currently supported.

  • :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.

  • :marker (String)

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

Returns:

See Also: