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

Class: Aws::RDS::DBParameterGroupFamily

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

Defined Under Namespace

Classes: Collection

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DBParameterGroupFamily

Overloads:



19
20
21
22
23
24
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @name = extract_name(args, options)
  @data = Aws::EmptyStructure.new
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#clientClient

Returns:



36
37
38
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 36

def client
  @client
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



57
58
59
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 57

def data_loaded?
  !!@data
end

#engine_default_cluster_parameters(options = {}) ⇒ Parameter::Collection

Examples:

Request syntax with placeholder values


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

Parameters:

  • options (Hash) (defaults to: {})

    ({})

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:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 93

def engine_default_cluster_parameters(options = {})
  batches = Enumerator.new do |y|
    batch = []
    options = options.merge(db_parameter_group_family: @name)
    resp = @client.describe_engine_default_cluster_parameters(options)
    resp.data.engine_defaults.parameters.each do |p|
      batch << Parameter.new(
        name: p.parameter_name,
        data: p,
        client: @client
      )
    end
    y.yield(batch)
  end
  Parameter::Collection.new(batches)
end

#engine_default_parameters(options = {}) ⇒ Parameter::Collection

Examples:

Request syntax with placeholder values


engine_default_parameters = db_parameter_group_family.engine_default_parameters({
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 124

def engine_default_parameters(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(db_parameter_group_family: @name)
    resp = @client.describe_engine_default_parameters(options)
    resp.each_page do |page|
      batch = []
      page.data.engine_defaults.parameters.each do |p|
        batch << Parameter.new(
          name: p.parameter_name,
          data: p,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Parameter::Collection.new(batches)
end

#nameString

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 29

def name
  @name
end