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

Class: Aws::RDS::DBClusterParameterGroup

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

Defined Under Namespace

Classes: Collection

Actions collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DBClusterParameterGroup

Overloads:



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

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

Instance Method Details

#clientClient

Returns:



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

def client
  @client
end

#create(options = {}) ⇒ DBClusterParameterGroup

Examples:

Request syntax with placeholder values


dbclusterparametergroup = db_cluster_parameter_group.create({
  db_parameter_group_family: "String", # required
  description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :db_parameter_group_family (required, String)

    The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

  • :description (required, String)

    The description for the DB cluster parameter group.

  • :tags (Array<Types::Tag>)

    A list of tags.

Returns:



210
211
212
213
214
215
216
217
218
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 210

def create(options = {})
  options = options.merge(db_cluster_parameter_group_name: @name)
  resp = @client.create_db_cluster_parameter_group(options)
  DBClusterParameterGroup.new(
    name: resp.data.db_cluster_parameter_group.db_cluster_parameter_group_name,
    data: resp.data.db_cluster_parameter_group,
    client: @client
  )
end

#dataTypes::DBClusterParameterGroup



77
78
79
80
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 77

def data
  load unless @data
  @data
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.



85
86
87
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 85

def data_loaded?
  !!@data
end

#db_cluster_parameter_group_arnString

The Amazon Resource Name (ARN) for the DB cluster parameter group.

Returns:

  • (String)


50
51
52
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 50

def db_cluster_parameter_group_arn
  data[:db_cluster_parameter_group_arn]
end

#db_parameter_group_familyString

Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.

Returns:

  • (String)


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

def db_parameter_group_family
  data[:db_parameter_group_family]
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


db_cluster_parameter_group.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


225
226
227
228
229
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 225

def delete(options = {})
  options = options.merge(db_cluster_parameter_group_name: @name)
  resp = @client.delete_db_cluster_parameter_group(options)
  resp.data
end

#descriptionString

Provides the customer-specified description for this DB cluster parameter group.

Returns:

  • (String)


44
45
46
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 44

def description
  data[:description]
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::RDS::DBClusterParameterGroup. Returns self making it possible to chain methods.

db_cluster_parameter_group.reload.data

Returns:

  • (self)


67
68
69
70
71
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 67

def load
  resp = @client.describe_db_cluster_parameter_groups(db_cluster_parameter_group_name: @name)
  @data = resp.db_cluster_parameter_groups[0]
  self
end

#modify(options = {}) ⇒ DBClusterParameterGroup

Examples:

Request syntax with placeholder values


dbclusterparametergroup = db_cluster_parameter_group.modify({
  parameters: [ # required
    {
      parameter_name: "String",
      parameter_value: "String",
      description: "String",
      source: "String",
      apply_type: "String",
      data_type: "String",
      allowed_values: "String",
      is_modifiable: false,
      minimum_engine_version: "String",
      apply_method: "immediate", # accepts immediate, pending-reboot
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :parameters (required, Array<Types::Parameter>)

    A list of parameters in the DB cluster parameter group to modify.

Returns:



253
254
255
256
257
258
259
260
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 253

def modify(options = {})
  options = options.merge(db_cluster_parameter_group_name: @name)
  resp = @client.modify_db_cluster_parameter_group(options)
  DBClusterParameterGroup.new(
    name: resp.data.db_cluster_parameter_group_name,
    client: @client
  )
end

#nameString Also known as: db_cluster_parameter_group_name

Returns:

  • (String)


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

def name
  @name
end

#reset(options = {}) ⇒ DBClusterParameterGroup

Examples:

Request syntax with placeholder values


dbclusterparametergroup = db_cluster_parameter_group.reset({
  reset_all_parameters: false,
  parameters: [
    {
      parameter_name: "String",
      parameter_value: "String",
      description: "String",
      source: "String",
      apply_type: "String",
      data_type: "String",
      allowed_values: "String",
      is_modifiable: false,
      minimum_engine_version: "String",
      apply_method: "immediate", # accepts immediate, pending-reboot
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :reset_all_parameters (Boolean)

    A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You cannot use this parameter if there is a list of parameter names specified for the Parameters parameter.

  • :parameters (Array<Types::Parameter>)

    A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this parameter if the ResetAllParameters parameter is set to true.

Returns:



292
293
294
295
296
297
298
299
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 292

def reset(options = {})
  options = options.merge(db_cluster_parameter_group_name: @name)
  resp = @client.reset_db_cluster_parameter_group(options)
  DBClusterParameterGroup.new(
    name: resp.data.db_cluster_parameter_group_name,
    client: @client
  )
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::RDS::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 167

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end