Class: AWSCDK::RDS::CfnDBClusterParameterGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
rds/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:, db_cluster_parameter_group_name: nil, tags: nil) ⇒ CfnDBClusterParameterGroupProps

Returns a new instance of CfnDBClusterParameterGroupProps.

Parameters:

  • description (String) —

    The description for the DB cluster parameter group.

  • family (String) —

    The DB cluster parameter group family name.

  • parameters (Object) —

    Provides a list of parameters for the DB cluster parameter group.

  • db_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) —

    Tags to assign to the DB cluster parameter group.



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

def initialize(description:, family:, parameters:, db_cluster_parameter_group_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")
  @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?
  @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

#db_cluster_parameter_group_name ⇒ String? (readonly)

The name of the DB cluster parameter group.

Constraints:

  • Must not match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

Returns:

  • (String, nil)

See Also:



87
88
89
 
# File 'rds/cfn_db_cluster_parameter_group_props.rb', line 87

def db_cluster_parameter_group_name
  @db_cluster_parameter_group_name
end

#description ⇒ String (readonly)

The description for the DB cluster parameter group.

Returns:

  • (String)

See Also:



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

def description
  @description
end

#family ⇒ String (readonly)

The DB cluster parameter group family name.

A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

Aurora MySQL

Example: aurora-mysql5.7 , aurora-mysql8.0

Aurora PostgreSQL

Example: aurora-postgresql14

RDS for MySQL

Example: mysql8.0

RDS for PostgreSQL

Example: postgres13

To list all of the available parameter group families for a DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql

The output contains duplicates.

The following are the valid DB engine values:

  • aurora-mysql
  • aurora-postgresql
  • mysql
  • postgres

Returns:

  • (String)

See Also:



71
72
73
 
# File 'rds/cfn_db_cluster_parameter_group_props.rb', line 71

def family
  @family
end

#parameters ⇒ Object (readonly)

Provides a list of parameters for the DB cluster parameter group.

Returns:

  • (Object)

See Also:



76
77
78
 
# File 'rds/cfn_db_cluster_parameter_group_props.rb', line 76

def parameters
  @parameters
end

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

Tags to assign to the DB cluster parameter group.

Returns:

See Also:



92
93
94
 
# File 'rds/cfn_db_cluster_parameter_group_props.rb', line 92

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



94
95
96
97
98
99
100
101
102
 
# File 'rds/cfn_db_cluster_parameter_group_props.rb', line 94

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

Instance Method Details

#to_jsii ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
 
# File 'rds/cfn_db_cluster_parameter_group_props.rb', line 104

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