Class: AWSCDK::Redshift::CfnClusterParameterGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
redshift/cfn_cluster_parameter_group_props.rb

Overview

Properties for defining a CfnClusterParameterGroup.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description:, parameter_group_family:, parameter_group_name: nil, parameters: nil, tags: nil) ⇒ CfnClusterParameterGroupProps

Returns a new instance of CfnClusterParameterGroupProps.

Parameters:

  • description (String) —

    The description of the parameter group.

  • parameter_group_family (String) —

    The name of the cluster parameter group family that this cluster parameter group is compatible with.

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

    The name of the cluster parameter group.

  • parameters (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Redshift::CfnClusterParameterGroup::ParameterProperty>, nil) (defaults to: nil) —

    An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.

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

    The list of tags for the cluster parameter group.



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

def initialize(description:, parameter_group_family:, parameter_group_name: nil, parameters: nil, tags: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description")
  @parameter_group_family = parameter_group_family
  Jsii::Type.check_type(@parameter_group_family, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterGroupFamily")
  @parameter_group_name = parameter_group_name
  Jsii::Type.check_type(@parameter_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterGroupName") unless @parameter_group_name.nil?
  @parameters = parameters
  Jsii::Type.check_type(@parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmVkc2hpZnQuQ2ZuQ2x1c3RlclBhcmFtZXRlckdyb3VwLlBhcmFtZXRlclByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "parameters") unless @parameters.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 of the parameter group.

Returns:

  • (String)

See Also:



31
32
33
 
# File 'redshift/cfn_cluster_parameter_group_props.rb', line 31

def description
  @description
end

#parameter_group_family ⇒ String (readonly)

The name of the cluster parameter group family that this cluster parameter group is compatible with.

You can create a custom parameter group and then associate your cluster with it. For more information, see Amazon Redshift parameter groups .

Returns:

  • (String)

See Also:



38
39
40
 
# File 'redshift/cfn_cluster_parameter_group_props.rb', line 38

def parameter_group_family
  @parameter_group_family
end

#parameter_group_name ⇒ String? (readonly)

The name of the cluster parameter group.

Returns:

  • (String, nil)

See Also:



43
44
45
 
# File 'redshift/cfn_cluster_parameter_group_props.rb', line 43

def parameter_group_name
  @parameter_group_name
end

#parameters ⇒ AWSCDK::IResolvable, ... (readonly)

An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.

For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.

For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

Returns:

See Also:



52
53
54
 
# File 'redshift/cfn_cluster_parameter_group_props.rb', line 52

def parameters
  @parameters
end

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

The list of tags for the cluster parameter group.

Returns:

See Also:



57
58
59
 
# File 'redshift/cfn_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 'redshift/cfn_cluster_parameter_group_props.rb', line 59

def self.jsii_properties
  {
    :description => "description",
    :parameter_group_family => "parameterGroupFamily",
    :parameter_group_name => "parameterGroupName",
    :parameters => "parameters",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "description" => @description,
    "parameterGroupFamily" => @parameter_group_family,
    "parameterGroupName" => @parameter_group_name,
    "parameters" => @parameters,
    "tags" => @tags,
  })
  result.compact
end