Class: AWSCDK::RDS::OptionGroupProps

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

Overview

Construction properties for an OptionGroup.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configurations:, engine:, description: nil, option_group_name: nil) ⇒ OptionGroupProps

Returns a new instance of OptionGroupProps.

Parameters:

  • configurations (Array<AWSCDK::RDS::OptionConfiguration>) —

    The configurations for this option group.

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

    The database engine that this option group is associated with.

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

    A description of the option group.

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

    The name of the option group.



11
12
13
14
15
16
17
18
19
20
 
# File 'rds/option_group_props.rb', line 11

def initialize(configurations:, engine:, description: nil, option_group_name: nil)
  @configurations = configurations.is_a?(Array) ? configurations.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::RDS::OptionConfiguration.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : configurations
  Jsii::Type.check_type(@configurations, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZHMuT3B0aW9uQ29uZmlndXJhdGlvbiJ9LCJraW5kIjoiYXJyYXkifX0=")), "configurations")
  @engine = engine
  Jsii::Type.check_type(@engine, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLklJbnN0YW5jZUVuZ2luZSJ9")), "engine")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @option_group_name = option_group_name
  Jsii::Type.check_type(@option_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "optionGroupName") unless @option_group_name.nil?
end

Instance Attribute Details

#configurations ⇒ Array<AWSCDK::RDS::OptionConfiguration> (readonly)

The configurations for this option group.

Returns:



25
26
27
 
# File 'rds/option_group_props.rb', line 25

def configurations
  @configurations
end

#description ⇒ String? (readonly)

Note:

Default: a CDK generated description

A description of the option group.

Returns:

  • (String, nil) 


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

def description
  @description
end

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

The database engine that this option group is associated with.

Returns:



29
30
31
 
# File 'rds/option_group_props.rb', line 29

def engine
  @engine
end

#option_group_name ⇒ String? (readonly)

Note:

Default: - a CDK generated name

The name of the option group.

Returns:

  • (String, nil) 


39
40
41
 
# File 'rds/option_group_props.rb', line 39

def option_group_name
  @option_group_name
end

Class Method Details

.jsii_properties ⇒ Object 



41
42
43
44
45
46
47
48
 
# File 'rds/option_group_props.rb', line 41

def self.jsii_properties
  {
    :configurations => "configurations",
    :engine => "engine",
    :description => "description",
    :option_group_name => "optionGroupName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "configurations" => @configurations,
    "engine" => @engine,
    "description" => @description,
    "optionGroupName" => @option_group_name,
  })
  result.compact
end