Class: AWSCDK::DocDB::CfnDBClusterParameterGroupProps

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

Overview

Properties for defining a CfnDBClusterParameterGroup.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of CfnDBClusterParameterGroupProps.

Parameters:

  • description (String) —

    The description for the cluster parameter group.

  • family (String) —

    The cluster parameter group family name.

  • parameters (Object) —

    Provides a list of parameters for the cluster parameter group.

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

    The name of the DB cluster parameter group.

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

    The tags to be assigned to the cluster parameter group.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'doc_db/cfn_db_cluster_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)

The description for the cluster parameter group.

Returns:

  • (String)

See Also:



31
32
33
 
# File 'doc_db/cfn_db_cluster_parameter_group_props.rb', line 31

def description
  @description
end

#family ⇒ String (readonly)

The cluster parameter group family name.

Returns:

  • (String)

See Also:



36
37
38
 
# File 'doc_db/cfn_db_cluster_parameter_group_props.rb', line 36

def family
  @family
end

#name ⇒ String? (readonly)

The name of the DB cluster parameter group.

Constraints:

  • Must not match the name of an existing DBClusterParameterGroup .

This value is stored as a lowercase string.

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'doc_db/cfn_db_cluster_parameter_group_props.rb', line 52

def name
  @name
end

#parameters ⇒ Object (readonly)

Provides a list of parameters for the cluster parameter group.

Returns:

  • (Object)

See Also:



41
42
43
 
# File 'doc_db/cfn_db_cluster_parameter_group_props.rb', line 41

def parameters
  @parameters
end

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

The tags to be assigned to the cluster parameter group.

Returns:

See Also:



57
58
59
 
# File 'doc_db/cfn_db_cluster_parameter_group_props.rb', line 57

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



59
60
61
62
63
64
65
66
67
 
# File 'doc_db/cfn_db_cluster_parameter_group_props.rb', line 59

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

Instance Method Details

#to_jsii ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
 
# File 'doc_db/cfn_db_cluster_parameter_group_props.rb', line 69

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