Class: AWSCDK::DocDB::ClusterParameterGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
doc_db/cluster_parameter_group_props.rb

Overview

Properties for a cluster parameter group.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(family:, parameters:, db_cluster_parameter_group_name: nil, description: nil) ⇒ ClusterParameterGroupProps

Returns a new instance of ClusterParameterGroupProps.

Parameters:

  • family (String) —

    Database family of this parameter group.

  • parameters (Hash{String => String}) —

    The parameters in this parameter group.

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

    The name of the cluster parameter group.

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

    Description for this parameter group.



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

def initialize(family:, parameters:, db_cluster_parameter_group_name: nil, description: nil)
  @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("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "parameters")
  @db_cluster_parameter_group_name = db_cluster_parameter_group_name
  Jsii::Type.check_type(@db_cluster_parameter_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbClusterParameterGroupName") unless @db_cluster_parameter_group_name.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
end

Instance Attribute Details

#db_cluster_parameter_group_name ⇒ String? (readonly)

Note:

Default: A CDK generated name for the cluster parameter group

The name of the cluster parameter group.

Returns:

  • (String, nil) 


34
35
36
 
# File 'doc_db/cluster_parameter_group_props.rb', line 34

def db_cluster_parameter_group_name
  @db_cluster_parameter_group_name
end

#description ⇒ String? (readonly)

Note:

Default: a CDK generated description

Description for this parameter group.

Returns:

  • (String, nil) 


39
40
41
 
# File 'doc_db/cluster_parameter_group_props.rb', line 39

def description
  @description
end

#family ⇒ String (readonly)

Database family of this parameter group.

Returns:

  • (String) 


25
26
27
 
# File 'doc_db/cluster_parameter_group_props.rb', line 25

def family
  @family
end

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

The parameters in this parameter group.

Returns:

  • (Hash{String => String}) 


29
30
31
 
# File 'doc_db/cluster_parameter_group_props.rb', line 29

def parameters
  @parameters
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :family => "family",
    :parameters => "parameters",
    :db_cluster_parameter_group_name => "dbClusterParameterGroupName",
    :description => "description",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

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