Class: Aws::RDS::DBClusterParameterGroup

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions 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 '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

#client ⇒ Client

Returns:



57
58
59
 
# File '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:



115
116
117
118
119
120
121
122
123
 
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 115

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

#data ⇒ Types::DBClusterParameterGroup

Returns the data for this Aws::RDS::DBClusterParameterGroup. Calls Client#describe_db_cluster_parameter_groups if #data_loaded? is ‘false`.

Returns:



77
78
79
80
 
# File '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 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 85

def data_loaded?
  !!@data
end

#db_cluster_parameter_group_arn ⇒ String

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

Returns:

  • (String) 


50
51
52
 
# File '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_family ⇒ String

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

Returns:

  • (String) 


37
38
39
 
# File '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) 


130
131
132
133
134
 
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 130

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

#description ⇒ String

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

Returns:

  • (String) 


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

def description
  data.description
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


208
209
210
 
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 208

def identifiers
  { name: @name }
end

#load ⇒ self 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 '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:



158
159
160
161
162
163
164
165
 
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 158

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

#name ⇒ String Also known as: db_cluster_parameter_group_name

Returns:

  • (String) 


29
30
31
 
# File '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:



197
198
199
200
201
202
203
204
 
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 197

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