Class: AWSCDK::RDS::ParameterGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
rds/parameter_group_props.rb

Overview

Properties for a parameter group.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(engine:, description: nil, name: nil, parameters: nil, removal_policy: nil) ⇒ ParameterGroupProps

Returns a new instance of ParameterGroupProps.

Parameters:

  • engine (AWSCDK::RDS::IEngine) —

    The database engine for this parameter group.

  • description (String, nil) (defaults to: nil) —

    Description for this parameter group.

  • name (String, nil) (defaults to: nil) —

    The name of this parameter group.

  • parameters (Hash{String => String}, nil) (defaults to: nil) —

    The parameters in this parameter group.

  • removal_policy (AWSCDK::RemovalPolicy, nil) (defaults to: nil) —

    The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'rds/parameter_group_props.rb', line 12

def initialize(engine:, description: nil, name: nil, parameters: nil, removal_policy: nil)
  @engine = engine
  Jsii::Type.check_type(@engine, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLklFbmdpbmUifQ==")), "engine")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @parameters = parameters
  Jsii::Type.check_type(@parameters, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "parameters") unless @parameters.nil?
  @removal_policy = removal_policy
  Jsii::Type.check_type(@removal_policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "removalPolicy") unless @removal_policy.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

Note:

Default: a CDK generated description

Description for this parameter group.

Returns:

  • (String, nil) 


33
34
35
 
# File 'rds/parameter_group_props.rb', line 33

def description
  @description
end

#engine ⇒ AWSCDK::RDS::IEngine (readonly)

The database engine for this parameter group.

Returns:



28
29
30
 
# File 'rds/parameter_group_props.rb', line 28

def engine
  @engine
end

#name ⇒ String? (readonly)

Note:

Default: - CloudFormation-generated name

The name of this parameter group.

Returns:

  • (String, nil) 


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

def name
  @name
end

#parameters ⇒ Hash{String => String}? (readonly)

Note:

Default: - None

The parameters in this parameter group.

Returns:

  • (Hash{String => String}, nil) 


43
44
45
 
# File 'rds/parameter_group_props.rb', line 43

def parameters
  @parameters
end

#removal_policy ⇒ AWSCDK::RemovalPolicy? (readonly)

Note:

Default: - RemovalPolicy.DESTROY

The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

Returns:



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

def removal_policy
  @removal_policy
end

Class Method Details

.jsii_properties ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 'rds/parameter_group_props.rb', line 50

def self.jsii_properties
  {
    :engine => "engine",
    :description => "description",
    :name => "name",
    :parameters => "parameters",
    :removal_policy => "removalPolicy",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
 
# File 'rds/parameter_group_props.rb', line 60

def to_jsii
  result = {}
  result.merge!({
    "engine" => @engine,
    "description" => @description,
    "name" => @name,
    "parameters" => @parameters,
    "removalPolicy" => @removal_policy,
  })
  result.compact
end