Module: AWSCDK::RDS::IOptionGroup

Includes:
IResource, Interfaces::AWSRDS::IOptionGroupRef
Included in:
OptionGroup
Defined in:
rds/i_option_group.rb

Overview

An option group.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'rds/i_option_group.rb', line 95

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 },
    :option_group_ref => { kind: :property, name: "optionGroupRef", is_optional: false },
    :option_group_name => { kind: :property, name: "optionGroupName", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :add_configuration => { kind: :method, name: "addConfiguration", is_optional: false },
  }
end

Instance Method Details

#add_configuration(configuration) ⇒ Boolean

Adds a configuration to this OptionGroup.

This method is a no-op for an imported OptionGroup.

Parameters:

Returns:

  • (Boolean) —

    true if the OptionConfiguration was successfully added.



89
90
91
92
93
 
# File 'rds/i_option_group.rb', line 89

def add_configuration(configuration)
  configuration = configuration.is_a?(Hash) ? ::AWSCDK::RDS::OptionConfiguration.new(**configuration.transform_keys(&:to_sym)) : configuration
  Jsii::Type.check_type(configuration, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLk9wdGlvbkNvbmZpZ3VyYXRpb24ifQ==")), "configuration")
  jsii_call_method("addConfiguration", [configuration])
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:



78
79
80
81
 
# File 'rds/i_option_group.rb', line 78

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
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:



27
28
29
 
# File 'rds/i_option_group.rb', line 27

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'rds/i_option_group.rb', line 12

def node()
  jsii_get_property("node")
end

#option_group_name ⇒ String

The name of the option group.

Returns:

  • (String) 


48
49
50
 
# File 'rds/i_option_group.rb', line 48

def option_group_name()
  jsii_get_property("optionGroupName")
end

#option_group_ref ⇒ AWSCDK::Interfaces::AWSRDS::OptionGroupReference

A reference to a OptionGroup resource.

Returns:



41
42
43
 
# File 'rds/i_option_group.rb', line 41

def option_group_ref()
  jsii_get_property("optionGroupRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'rds/i_option_group.rb', line 34

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



59
60
61
62
63
64
 
# File 'rds/i_option_group.rb', line 59

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