Class: Aws::RDS::DBClusterParameterGroup
- Inherits:
-
Object
- Object
- Aws::RDS::DBClusterParameterGroup
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-rds/db_cluster_parameter_group.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#db_cluster_parameter_group_arn ⇒ String
The Amazon Resource Name (ARN) for the DB cluster parameter group.
-
#db_parameter_group_family ⇒ String
Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.
-
#description ⇒ String
Provides the customer-specified description for this DB cluster parameter group.
- #name ⇒ String (also: #db_cluster_parameter_group_name)
Actions collapse
- #create(options = {}) ⇒ DBClusterParameterGroup
- #delete(options = {}) ⇒ EmptyStructure
- #identifiers ⇒ Object deprecated private Deprecated.
- #modify(options = {}) ⇒ DBClusterParameterGroup
- #reset(options = {}) ⇒ DBClusterParameterGroup
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::DBClusterParameterGroup
Returns the data for this DBClusterParameterGroup.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ DBClusterParameterGroup
constructor
A new instance of DBClusterParameterGroup.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current DBClusterParameterGroup.
Constructor Details
#initialize(name, options = {}) ⇒ DBClusterParameterGroup #initialize(options = {}) ⇒ DBClusterParameterGroup
Returns a new instance of DBClusterParameterGroup.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#client ⇒ Client
57 58 59 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 57 def client @client end |
#create(options = {}) ⇒ DBClusterParameterGroup
115 116 117 118 119 120 121 122 123 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 115 def create( = {}) = .merge(db_cluster_parameter_group_name: @name) resp = @client.create_db_cluster_parameter_group() 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`.
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
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.
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.
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
130 131 132 133 134 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 130 def delete( = {}) = .merge(db_cluster_parameter_group_name: @name) resp = @client.delete_db_cluster_parameter_group() resp.data end |
#description ⇒ String
Provides the customer-specified description for this DB cluster parameter group.
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.
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
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
158 159 160 161 162 163 164 165 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 158 def modify( = {}) = .merge(db_cluster_parameter_group_name: @name) resp = @client.modify_db_cluster_parameter_group() DBClusterParameterGroup.new( name: resp.data.db_cluster_parameter_group_name, client: @client ) end |
#name ⇒ String Also known as: db_cluster_parameter_group_name
29 30 31 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 29 def name @name end |
#reset(options = {}) ⇒ DBClusterParameterGroup
197 198 199 200 201 202 203 204 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 197 def reset( = {}) = .merge(db_cluster_parameter_group_name: @name) resp = @client.reset_db_cluster_parameter_group() DBClusterParameterGroup.new( name: resp.data.db_cluster_parameter_group_name, client: @client ) end |