Class: AWSCDK::RDS::ParameterGroup

Inherits:
AWSCDK::Resource
  • Object
show all
Includes:
IParameterGroup
Defined in:
rds/parameter_group.rb

Overview

A parameter group.

Represents both a cluster parameter group (AWS::RDS::DBClusterParameterGroup), and an instance parameter group (AWS::RDS::DBParameterGroup).

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ ParameterGroup

Returns a new instance of ParameterGroup.

Parameters:



15
16
17
18
19
20
21
 
# File 'rds/parameter_group.rb', line 15

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::RDS::ParameterGroupProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLlBhcmFtZXRlckdyb3VwUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.for_cluster(scope, id, props) ⇒ AWSCDK::RDS::IParameterGroup

Creates a standalone cluster parameter group.

This method allows you to explicitly create a parameter group without binding it to a database cluster.

Parameters:

Returns:



53
54
55
56
57
58
59
 
# File 'rds/parameter_group.rb', line 53

def self.for_cluster(scope, id, props)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::RDS::ParameterGroupProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLlBhcmFtZXRlckdyb3VwUHJvcHMifQ==")), "props")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_rds.ParameterGroup", "forCluster", [scope, id, props])
end

.for_instance(scope, id, props) ⇒ AWSCDK::RDS::IParameterGroup

Creates a standalone instance parameter group.

This method allows you to explicitly create a parameter group without binding it to a database instance.

Parameters:

Returns:



70
71
72
73
74
75
76
 
# File 'rds/parameter_group.rb', line 70

def self.for_instance(scope, id, props)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::RDS::ParameterGroupProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLlBhcmFtZXRlckdyb3VwUHJvcHMifQ==")), "props")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_rds.ParameterGroup", "forInstance", [scope, id, props])
end

.from_parameter_group_name(scope, id, parameter_group_name) ⇒ AWSCDK::RDS::IParameterGroup

Imports a parameter group.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • parameter_group_name (String)

Returns:



84
85
86
87
88
89
 
# File 'rds/parameter_group.rb', line 84

def self.from_parameter_group_name(scope, id, parameter_group_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(parameter_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterGroupName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_rds.ParameterGroup", "fromParameterGroupName", [scope, id, parameter_group_name])
end

.jsii_overridable_methods ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'rds/parameter_group.rb', line 23

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :db_cluster_parameter_group_ref => { kind: :property, name: "dbClusterParameterGroupRef", is_optional: false },
    :db_parameter_group_ref => { kind: :property, name: "dbParameterGroupRef", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_parameter => { kind: :method, name: "addParameter", is_optional: false },
    :bind_to_cluster => { kind: :method, name: "bindToCluster", is_optional: false },
    :bind_to_instance => { kind: :method, name: "bindToInstance", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


137
138
139
 
# File 'rds/parameter_group.rb', line 137

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_rds.ParameterGroup", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_parameter(key, value) ⇒ Boolean

Add a parameter to this parameter group.

Parameters:

  • key (String) —

    The key of the parameter to be added.

  • value (String) —

    The value of the parameter to be added.

Returns:

  • (Boolean) 


250
251
252
253
254
 
# File 'rds/parameter_group.rb', line 250

def add_parameter(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  jsii_call_method("addParameter", [key, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



188
189
190
191
 
# File 'rds/parameter_group.rb', line 188

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



205
206
207
208
 
# File 'rds/parameter_group.rb', line 205

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#bind_to_cluster(_options) ⇒ AWSCDK::RDS::ParameterGroupClusterConfig

Method called when this Parameter Group is used when defining a database cluster.

Parameters:

Returns:



260
261
262
263
264
 
# File 'rds/parameter_group.rb', line 260

def bind_to_cluster(_options)
  _options = _options.is_a?(Hash) ? ::AWSCDK::RDS::ParameterGroupClusterBindOptions.new(**_options.transform_keys(&:to_sym)) : _options
  Jsii::Type.check_type(_options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLlBhcmFtZXRlckdyb3VwQ2x1c3RlckJpbmRPcHRpb25zIn0=")), "_options")
  jsii_call_method("bindToCluster", [_options])
end

#bind_to_instance(_options) ⇒ AWSCDK::RDS::ParameterGroupInstanceConfig

Method called when this Parameter Group is used when defining a database instance.

Parameters:

Returns:



270
271
272
273
274
 
# File 'rds/parameter_group.rb', line 270

def bind_to_instance(_options)
  _options = _options.is_a?(Hash) ? ::AWSCDK::RDS::ParameterGroupInstanceBindOptions.new(**_options.transform_keys(&:to_sym)) : _options
  Jsii::Type.check_type(_options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLlBhcmFtZXRlckdyb3VwSW5zdGFuY2VCaW5kT3B0aW9ucyJ9")), "_options")
  jsii_call_method("bindToInstance", [_options])
end

#db_cluster_parameter_group_ref ⇒ AWSCDK::Interfaces::AWSRDS::DBClusterParameterGroupReference

A reference to this parameter group as a DB cluster parameter group.

Returns:



144
145
146
 
# File 'rds/parameter_group.rb', line 144

def db_cluster_parameter_group_ref()
  jsii_get_property("dbClusterParameterGroupRef")
end

#db_parameter_group_ref ⇒ AWSCDK::Interfaces::AWSRDS::DBParameterGroupReference

A reference to this parameter group as a DB parameter group.

Returns:



151
152
153
 
# File 'rds/parameter_group.rb', line 151

def db_parameter_group_ref()
  jsii_get_property("dbParameterGroupRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



109
110
111
 
# File 'rds/parameter_group.rb', line 109

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


211
212
213
 
# File 'rds/parameter_group.rb', line 211

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


225
226
227
228
229
230
 
# File 'rds/parameter_group.rb', line 225

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


240
241
242
243
 
# File 'rds/parameter_group.rb', line 240

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


94
95
96
 
# File 'rds/parameter_group.rb', line 94

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


123
124
125
 
# File 'rds/parameter_group.rb', line 123

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



130
131
132
 
# File 'rds/parameter_group.rb', line 130

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


158
159
160
 
# File 'rds/parameter_group.rb', line 158

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


171
172
173
174
175
176
 
# File 'rds/parameter_group.rb', line 171

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end