Class: AWSCDK::RDS::OptionConfiguration

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

Overview

Configuration properties for an option.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, port: nil, security_groups: nil, settings: nil, version: nil, vpc: nil) ⇒ OptionConfiguration

Returns a new instance of OptionConfiguration.

Parameters:

  • name (String) —

    The name of the option.

  • port (Numeric, nil) (defaults to: nil) —

    The port number that this option uses.

  • security_groups (Array<AWSCDK::EC2::ISecurityGroup>, nil) (defaults to: nil) —

    Optional list of security groups to use for this option, if vpc is specified.

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

    The settings for the option.

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

    The version for the option.

  • vpc (AWSCDK::EC2::IVPC, nil) (defaults to: nil) —

    The VPC where a security group should be created for this option.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'rds/option_configuration.rb', line 13

def initialize(name:, port: nil, security_groups: nil, settings: nil, version: nil, vpc: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @port = port
  Jsii::Type.check_type(@port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port") unless @port.nil?
  @security_groups = security_groups
  Jsii::Type.check_type(@security_groups, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuSVNlY3VyaXR5R3JvdXAifSwia2luZCI6ImFycmF5In19")), "securityGroups") unless @security_groups.nil?
  @settings = settings
  Jsii::Type.check_type(@settings, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "settings") unless @settings.nil?
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version") unless @version.nil?
  @vpc = vpc
  Jsii::Type.check_type(@vpc, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklWcGMifQ==")), "vpc") unless @vpc.nil?
end

Instance Attribute Details

#name ⇒ String (readonly)

The name of the option.

Returns:

  • (String) 


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

def name
  @name
end

#port ⇒ Numeric? (readonly)

Note:

Default: - no port

The port number that this option uses.

If port is specified then vpc must also be specified.

Returns:

  • (Numeric, nil) 


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

def port
  @port
end

#security_groups ⇒ Array<AWSCDK::EC2::ISecurityGroup>? (readonly)

Note:

Default: - a default group will be created if port or vpc are specified.

Optional list of security groups to use for this option, if vpc is specified.

If no groups are provided, a default one will be created.

Returns:



46
47
48
 
# File 'rds/option_configuration.rb', line 46

def security_groups
  @security_groups
end

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

Note:

Default: - no settings

The settings for the option.

Returns:

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


51
52
53
 
# File 'rds/option_configuration.rb', line 51

def settings
  @settings
end

#version ⇒ String? (readonly)

Note:

Default: - no version

The version for the option.

Returns:

  • (String, nil) 


56
57
58
 
# File 'rds/option_configuration.rb', line 56

def version
  @version
end

#vpc ⇒ AWSCDK::EC2::IVPC? (readonly)

Note:

Default: - no VPC

The VPC where a security group should be created for this option.

If vpc is specified then port must also be specified.

Returns:



64
65
66
 
# File 'rds/option_configuration.rb', line 64

def vpc
  @vpc
end

Class Method Details

.jsii_properties ⇒ Object 



66
67
68
69
70
71
72
73
74
75
 
# File 'rds/option_configuration.rb', line 66

def self.jsii_properties
  {
    :name => "name",
    :port => "port",
    :security_groups => "securityGroups",
    :settings => "settings",
    :version => "version",
    :vpc => "vpc",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'rds/option_configuration.rb', line 77

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "port" => @port,
    "securityGroups" => @security_groups,
    "settings" => @settings,
    "version" => @version,
    "vpc" => @vpc,
  })
  result.compact
end