Class: AWSCDK::Neptune::CfnDBParameterGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
neptune/cfn_db_parameter_group_props.rb

Overview

Properties for defining a CfnDBParameterGroup.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description:, family:, parameters:, name: nil, tags: nil) ⇒ CfnDBParameterGroupProps

Returns a new instance of CfnDBParameterGroupProps.

Parameters:

  • description (String) —

    Provides the customer-specified description for this DB parameter group.

  • family (String) —

    Must be neptune1 for engine versions prior to 1.2.0.0 , or neptune1.2 for engine version 1.2.0.0 and higher.

  • parameters (Object) —

    The parameters to set for this DB parameter group.

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

    Provides the name of the DB parameter group.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    The tags that you want to attach to this parameter group.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'neptune/cfn_db_parameter_group_props.rb', line 14

def initialize(description:, family:, parameters:, name: nil, tags: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description")
  @family = family
  Jsii::Type.check_type(@family, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "family")
  @parameters = parameters
  Jsii::Type.check_type(@parameters, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "parameters")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#description ⇒ String (readonly)

Provides the customer-specified description for this DB parameter group.

Returns:

  • (String)

See Also:



31
32
33
 
# File 'neptune/cfn_db_parameter_group_props.rb', line 31

def description
  @description
end

#family ⇒ String (readonly)

Must be neptune1 for engine versions prior to 1.2.0.0 , or neptune1.2 for engine version 1.2.0.0 and higher.

Returns:

  • (String)

See Also:



36
37
38
 
# File 'neptune/cfn_db_parameter_group_props.rb', line 36

def family
  @family
end

#name ⇒ String? (readonly)

Provides the name of the DB parameter group.

Returns:

  • (String, nil)

See Also:



50
51
52
 
# File 'neptune/cfn_db_parameter_group_props.rb', line 50

def name
  @name
end

#parameters ⇒ Object (readonly)

The parameters to set for this DB parameter group.

The parameters are expressed as a JSON object consisting of key-value pairs.

Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers CloudFormation to reboot the associated DB instance without failover.

Returns:

  • (Object)

See Also:



45
46
47
 
# File 'neptune/cfn_db_parameter_group_props.rb', line 45

def parameters
  @parameters
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags that you want to attach to this parameter group.

Returns:

See Also:



55
56
57
 
# File 'neptune/cfn_db_parameter_group_props.rb', line 55

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



57
58
59
60
61
62
63
64
65
 
# File 'neptune/cfn_db_parameter_group_props.rb', line 57

def self.jsii_properties
  {
    :description => "description",
    :family => "family",
    :parameters => "parameters",
    :name => "name",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
 
# File 'neptune/cfn_db_parameter_group_props.rb', line 67

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