Module: AWSCDK::RDS::IParameterGroup

Includes:
IResource, Interfaces::AWSRDS::IDBClusterParameterGroupRef, Interfaces::AWSRDS::IDBParameterGroupRef
Included in:
ParameterGroup
Defined in:
rds/i_parameter_group.rb

Overview

A parameter group.

Represents both a cluster parameter group, and an instance parameter group.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'rds/i_parameter_group.rb', line 121

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :db_parameter_group_ref => { kind: :property, name: "dbParameterGroupRef", is_optional: false },
    :db_cluster_parameter_group_ref => { kind: :property, name: "dbClusterParameterGroupRef", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", 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

Instance Method Details

#add_parameter(key, value) ⇒ Boolean

Adds a parameter to this group.

If this is an imported parameter group, this method does nothing.

Parameters:

  • key (String)
  • value (String)

Returns:

  • (Boolean) —

    true if the parameter was actually added (i.e., this ParameterGroup is not imported), false otherwise



95
96
97
98
99
 
# File 'rds/i_parameter_group.rb', line 95

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_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:



82
83
84
85
 
# File 'rds/i_parameter_group.rb', line 82

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:



105
106
107
108
109
 
# File 'rds/i_parameter_group.rb', line 105

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:



115
116
117
118
119
 
# File 'rds/i_parameter_group.rb', line 115

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 a DBClusterParameterGroup resource.

Returns:



52
53
54
 
# File 'rds/i_parameter_group.rb', line 52

def db_cluster_parameter_group_ref()
  jsii_get_property("dbClusterParameterGroupRef")
end

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

A reference to a DBParameterGroup resource.

Returns:



45
46
47
 
# File 'rds/i_parameter_group.rb', line 45

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:



31
32
33
 
# File 'rds/i_parameter_group.rb', line 31

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


16
17
18
 
# File 'rds/i_parameter_group.rb', line 16

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



38
39
40
 
# File 'rds/i_parameter_group.rb', line 38

def stack()
  jsii_get_property("stack")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



63
64
65
66
67
68
 
# File 'rds/i_parameter_group.rb', line 63

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