Class: AWSCDK::Elasticache::CfnParameterGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
elasticache/cfn_parameter_group_props.rb

Overview

Properties for defining a CfnParameterGroup.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cache_parameter_group_family:, description:, properties: nil, tags: nil) ⇒ CfnParameterGroupProps

Returns a new instance of CfnParameterGroupProps.

Parameters:

  • cache_parameter_group_family (String)

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

  • description (String)

    The description for this cache parameter group.

  • properties (AWSCDK::IResolvable, Hash{String => String}, nil) (defaults to: nil)

    A comma-delimited list of parameter name/value pairs.

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

    A tag that can be added to an ElastiCache parameter group.



13
14
15
16
17
18
19
20
21
22
# File 'elasticache/cfn_parameter_group_props.rb', line 13

def initialize(cache_parameter_group_family:, description:, properties: nil, tags: nil)
  @cache_parameter_group_family = cache_parameter_group_family
  Jsii::Type.check_type(@cache_parameter_group_family, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cacheParameterGroupFamily")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description")
  @properties = properties
  Jsii::Type.check_type(@properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "properties") unless @properties.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

#cache_parameter_group_familyString (readonly)

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

Valid values are: valkey8 | valkey7 | memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7



30
31
32
# File 'elasticache/cfn_parameter_group_props.rb', line 30

def cache_parameter_group_family
  @cache_parameter_group_family
end

#descriptionString (readonly)

The description for this cache parameter group.



35
36
37
# File 'elasticache/cfn_parameter_group_props.rb', line 35

def description
  @description
end

#propertiesAWSCDK::IResolvable, ... (readonly)

A comma-delimited list of parameter name/value pairs.

For example:

"Properties" : { "cas_disabled" : "1", "chunk_size_growth_factor" : "1.02"
}


47
48
49
# File 'elasticache/cfn_parameter_group_props.rb', line 47

def properties
  @properties
end

#tagsArray<AWSCDK::CfnTag>? (readonly)

A tag that can be added to an ElastiCache parameter group.

Tags are composed of a Key/Value pair. You can use tags to categorize and track all your parameter groups. A tag with a null Value is permitted.



54
55
56
# File 'elasticache/cfn_parameter_group_props.rb', line 54

def tags
  @tags
end

Class Method Details

.jsii_propertiesObject



56
57
58
59
60
61
62
63
# File 'elasticache/cfn_parameter_group_props.rb', line 56

def self.jsii_properties
  {
    :cache_parameter_group_family => "cacheParameterGroupFamily",
    :description => "description",
    :properties => "properties",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsiiObject



65
66
67
68
69
70
71
72
73
74
# File 'elasticache/cfn_parameter_group_props.rb', line 65

def to_jsii
  result = {}
  result.merge!({
    "cacheParameterGroupFamily" => @cache_parameter_group_family,
    "description" => @description,
    "properties" => @properties,
    "tags" => @tags,
  })
  result.compact
end