Class: AWSCDK::Elasticache::CfnCacheClusterProps

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

Overview

Properties for defining a CfnCacheCluster.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cache_node_type:, engine:, num_cache_nodes:, auto_minor_version_upgrade: nil, az_mode: nil, cache_parameter_group_name: nil, cache_security_group_names: nil, cache_subnet_group_name: nil, cluster_name: nil, engine_version: nil, ip_discovery: nil, log_delivery_configurations: nil, network_type: nil, notification_topic_arn: nil, port: nil, preferred_availability_zone: nil, preferred_availability_zones: nil, preferred_maintenance_window: nil, snapshot_arns: nil, snapshot_name: nil, snapshot_retention_limit: nil, snapshot_window: nil, tags: nil, transit_encryption_enabled: nil, vpc_security_group_ids: nil) ⇒ CfnCacheClusterProps

Returns a new instance of CfnCacheClusterProps.

Parameters:

  • cache_node_type (String) —

    The compute and memory capacity of the nodes in the node group (shard).

  • engine (String) —

    The name of the cache engine to be used for this cluster.

  • num_cache_nodes (Numeric) —

    The number of cache nodes that the cache cluster should have.

  • auto_minor_version_upgrade (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    If you are running Valkey 7.2 or later, or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.

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

    Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

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

    The name of the parameter group to associate with this cluster.

  • cache_security_group_names (Array<String>, nil) (defaults to: nil) —

    A list of security group names to associate with this cluster.

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

    The name of the subnet group to be used for the cluster.

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

    A name for the cache cluster.

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

    The version number of the cache engine to be used for this cluster.

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

    The network type you choose when modifying a cluster, either ipv4 | ipv6 .

  • log_delivery_configurations (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Elasticache::CfnCacheCluster::LogDeliveryConfigurationRequestProperty>, nil) (defaults to: nil) —

    Specifies the destination, format and type of the logs.

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

    Must be either ipv4 | ipv6 | dual_stack .

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

    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

  • port (Numeric, nil) (defaults to: nil) —

    The port number on which each of the cache nodes accepts connections.

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

    The EC2 Availability Zone in which the cluster is created.

  • preferred_availability_zones (Array<String>, nil) (defaults to: nil) —

    A list of the Availability Zones in which cache nodes are created.

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

    Specifies the weekly time range during which maintenance on the cluster is performed.

  • snapshot_arns (Array<String>, nil) (defaults to: nil) —

    A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3.

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

    The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).

  • snapshot_retention_limit (Numeric, nil) (defaults to: nil) —

    The number of days for which ElastiCache retains automatic snapshots before deleting them.

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

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

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

    A list of tags to be added to this resource.

  • transit_encryption_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A flag that enables in-transit encryption when set to true.

  • vpc_security_group_ids (Array<String>, nil) (defaults to: nil) —

    One or more VPC security groups associated with the cluster.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 34

def initialize(cache_node_type:, engine:, num_cache_nodes:, auto_minor_version_upgrade: nil, az_mode: nil, cache_parameter_group_name: nil, cache_security_group_names: nil, cache_subnet_group_name: nil, cluster_name: nil, engine_version: nil, ip_discovery: nil, log_delivery_configurations: nil, network_type: nil, notification_topic_arn: nil, port: nil, preferred_availability_zone: nil, preferred_availability_zones: nil, preferred_maintenance_window: nil, snapshot_arns: nil, snapshot_name: nil, snapshot_retention_limit: nil, snapshot_window: nil, tags: nil, transit_encryption_enabled: nil, vpc_security_group_ids: nil)
  @cache_node_type = cache_node_type
  Jsii::Type.check_type(@cache_node_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cacheNodeType")
  @engine = engine
  Jsii::Type.check_type(@engine, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engine")
  @num_cache_nodes = num_cache_nodes
  Jsii::Type.check_type(@num_cache_nodes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "numCacheNodes")
  @auto_minor_version_upgrade = auto_minor_version_upgrade
  Jsii::Type.check_type(@auto_minor_version_upgrade, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "autoMinorVersionUpgrade") unless @auto_minor_version_upgrade.nil?
  @az_mode = az_mode
  Jsii::Type.check_type(@az_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "azMode") unless @az_mode.nil?
  @cache_parameter_group_name = cache_parameter_group_name
  Jsii::Type.check_type(@cache_parameter_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cacheParameterGroupName") unless @cache_parameter_group_name.nil?
  @cache_security_group_names = cache_security_group_names
  Jsii::Type.check_type(@cache_security_group_names, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "cacheSecurityGroupNames") unless @cache_security_group_names.nil?
  @cache_subnet_group_name = cache_subnet_group_name
  Jsii::Type.check_type(@cache_subnet_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cacheSubnetGroupName") unless @cache_subnet_group_name.nil?
  @cluster_name = cluster_name
  Jsii::Type.check_type(@cluster_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterName") unless @cluster_name.nil?
  @engine_version = engine_version
  Jsii::Type.check_type(@engine_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineVersion") unless @engine_version.nil?
  @ip_discovery = ip_discovery
  Jsii::Type.check_type(@ip_discovery, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipDiscovery") unless @ip_discovery.nil?
  @log_delivery_configurations = log_delivery_configurations
  Jsii::Type.check_type(@log_delivery_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2FjaGUuQ2ZuQ2FjaGVDbHVzdGVyLkxvZ0RlbGl2ZXJ5Q29uZmlndXJhdGlvblJlcXVlc3RQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "logDeliveryConfigurations") unless @log_delivery_configurations.nil?
  @network_type = network_type
  Jsii::Type.check_type(@network_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "networkType") unless @network_type.nil?
  @notification_topic_arn = notification_topic_arn
  Jsii::Type.check_type(@notification_topic_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "notificationTopicArn") unless @notification_topic_arn.nil?
  @port = port
  Jsii::Type.check_type(@port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port") unless @port.nil?
  @preferred_availability_zone = preferred_availability_zone
  Jsii::Type.check_type(@preferred_availability_zone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preferredAvailabilityZone") unless @preferred_availability_zone.nil?
  @preferred_availability_zones = preferred_availability_zones
  Jsii::Type.check_type(@preferred_availability_zones, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "preferredAvailabilityZones") unless @preferred_availability_zones.nil?
  @preferred_maintenance_window = preferred_maintenance_window
  Jsii::Type.check_type(@preferred_maintenance_window, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preferredMaintenanceWindow") unless @preferred_maintenance_window.nil?
  @snapshot_arns = snapshot_arns
  Jsii::Type.check_type(@snapshot_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "snapshotArns") unless @snapshot_arns.nil?
  @snapshot_name = snapshot_name
  Jsii::Type.check_type(@snapshot_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snapshotName") unless @snapshot_name.nil?
  @snapshot_retention_limit = snapshot_retention_limit
  Jsii::Type.check_type(@snapshot_retention_limit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "snapshotRetentionLimit") unless @snapshot_retention_limit.nil?
  @snapshot_window = snapshot_window
  Jsii::Type.check_type(@snapshot_window, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snapshotWindow") unless @snapshot_window.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?
  @transit_encryption_enabled = transit_encryption_enabled
  Jsii::Type.check_type(@transit_encryption_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "transitEncryptionEnabled") unless @transit_encryption_enabled.nil?
  @vpc_security_group_ids = vpc_security_group_ids
  Jsii::Type.check_type(@vpc_security_group_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "vpcSecurityGroupIds") unless @vpc_security_group_ids.nil?
end

Instance Attribute Details

#auto_minor_version_upgrade ⇒ Boolean, ... (readonly)

If you are running Valkey 7.2 or later, or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.

Returns:

See Also:



168
169
170
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 168

def auto_minor_version_upgrade
  @auto_minor_version_upgrade
end

#az_mode ⇒ String? (readonly)

Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

This parameter is only supported for Memcached clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

Returns:

  • (String, nil)

See Also:



177
178
179
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 177

def az_mode
  @az_mode
end

#cache_node_type ⇒ String (readonly)

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. Changing the CacheNodeType of a Memcached instance is currently not supported. If you need to scale using Memcached, we recommend forcing a replacement update by changing the LogicalResourceId of the resource.

  • General purpose:
  • Current generation:

M6g node types: cache.m6g.large , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge , cache.m6g.12xlarge , cache.m6g.16xlarge , cache.m6g.24xlarge

M5 node types: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge

M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge

T4g node types: cache.t4g.micro , cache.t4g.small , cache.t4g.medium

T3 node types: cache.t3.micro , cache.t3.small , cache.t3.medium

T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium

  • Previous generation: (not recommended)

T1 node types: cache.t1.micro

M1 node types: cache.m1.small , cache.m1.medium , cache.m1.large , cache.m1.xlarge

M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge

  • Compute optimized:
  • Previous generation: (not recommended)

C1 node types: cache.c1.xlarge

  • Memory optimized:
  • Current generation:

R6gd node types: cache.r6gd.xlarge , cache.r6gd.2xlarge , cache.r6gd.4xlarge , cache.r6gd.8xlarge , cache.r6gd.12xlarge , cache.r6gd.16xlarge

The r6gd family is available in the following regions: us-east-2 , us-east-1 , us-west-2 , us-west-1 , eu-west-1 , eu-central-1 , ap-northeast-1 , ap-southeast-1 , ap-southeast-2 .

R6g node types: cache.r6g.large , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge , cache.r6g.12xlarge , cache.r6g.16xlarge , cache.r6g.24xlarge

R5 node types: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge

R4 node types: cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , cache.r4.8xlarge , cache.r4.16xlarge

  • Previous generation: (not recommended)

M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge

R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge

For region availability, see Supported Node Types by Region

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.
  • Valkey and Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
  • Valkey and Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
  • Redis OSS configuration variables appendonly and appendfsync are not supported on Redis OSS version 2.8.22 and later.

Returns:

  • (String)

See Also:



149
150
151
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 149

def cache_node_type
  @cache_node_type
end

#cache_parameter_group_name ⇒ String? (readonly)

The name of the parameter group to associate with this cluster.

If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

Returns:

  • (String, nil)

See Also:



184
185
186
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 184

def cache_parameter_group_name
  @cache_parameter_group_name
end

#cache_security_group_names ⇒ Array<String>? (readonly)

Deprecated.

this property has been deprecated

A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

Returns:

  • (Array<String>, nil)

See Also:



192
193
194
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 192

def cache_security_group_names
  @cache_security_group_names
end

#cache_subnet_group_name ⇒ String? (readonly)

The name of the subnet group to be used for the cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see [AWS::ElastiCache::SubnetGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html) .

Returns:

  • (String, nil)

See Also:



201
202
203
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 201

def cache_subnet_group_name
  @cache_subnet_group_name
end

#cluster_name ⇒ String? (readonly)

A name for the cache cluster.

If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the cache cluster. For more information, see Name Type .

The name must contain 1 to 50 alphanumeric characters or hyphens. The name must start with a letter and cannot end with a hyphen or contain two consecutive hyphens.

Returns:

  • (String, nil)

See Also:



210
211
212
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 210

def cluster_name
  @cluster_name
end

#engine ⇒ String (readonly)

The name of the cache engine to be used for this cluster.

Valid values for this parameter are: memcached | valkey | redis

Returns:

  • (String)

See Also:



156
157
158
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 156

def engine
  @engine
end

#engine_version ⇒ String? (readonly)

The version number of the cache engine to be used for this cluster.

To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version ), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

Returns:

  • (String, nil)

See Also:



219
220
221
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 219

def engine_version
  @engine_version
end

#ip_discovery ⇒ String? (readonly)

The network type you choose when modifying a cluster, either ipv4 | ipv6 .

IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system .

Returns:

  • (String, nil)

See Also:



226
227
228
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 226

def ip_discovery
  @ip_discovery
end

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

Specifies the destination, format and type of the logs.

Returns:

See Also:



231
232
233
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 231

def log_delivery_configurations
  @log_delivery_configurations
end

#network_type ⇒ String? (readonly)

Must be either ipv4 | ipv6 | dual_stack .

IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system .

Returns:

  • (String, nil)

See Also:



238
239
240
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 238

def network_type
  @network_type
end

#notification_topic_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

Returns:

  • (String, nil)

See Also:



245
246
247
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 245

def notification_topic_arn
  @notification_topic_arn
end

#num_cache_nodes ⇒ Numeric (readonly)

The number of cache nodes that the cache cluster should have.

However, if the PreferredAvailabilityZone and PreferredAvailabilityZones properties were not previously specified and you don't specify any new values, an update requires replacement .

Returns:

  • (Numeric)

See Also:



163
164
165
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 163

def num_cache_nodes
  @num_cache_nodes
end

#port ⇒ Numeric? (readonly)

The port number on which each of the cache nodes accepts connections.

Returns:

  • (Numeric, nil)

See Also:



250
251
252
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 250

def port
  @port
end

#preferred_availability_zone ⇒ String? (readonly)

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones .

Default: System chosen Availability Zone.

Returns:

  • (String, nil)

See Also:



259
260
261
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 259

def preferred_availability_zone
  @preferred_availability_zone
end

#preferred_availability_zones ⇒ Array<String>? (readonly)

A list of the Availability Zones in which cache nodes are created.

The order of the zones in the list is not important.

This option is only supported on Memcached.

If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheNodes .

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

Returns:

  • (Array<String>, nil)

See Also:



276
277
278
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 276

def preferred_availability_zones
  @preferred_availability_zones
end

#preferred_maintenance_window ⇒ String? (readonly)

Specifies the weekly time range during which maintenance on the cluster is performed.

It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun
  • mon
  • tue
  • wed
  • thu
  • fri
  • sat

Example: sun:23:00-mon:01:30

Returns:

  • (String, nil)

See Also:



295
296
297
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 295

def preferred_maintenance_window
  @preferred_maintenance_window
end

#snapshot_arns ⇒ Array<String>? (readonly)

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3.

The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis .

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

Returns:

  • (Array<String>, nil)

See Also:



306
307
308
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 306

def snapshot_arns
  @snapshot_arns
end

#snapshot_name ⇒ String? (readonly)

The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).

The snapshot status changes to restoring while the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis .

Returns:

  • (String, nil)

See Also:



315
316
317
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 315

def snapshot_name
  @snapshot_name
end

#snapshot_retention_limit ⇒ Numeric? (readonly)

The number of days for which ElastiCache retains automatic snapshots before deleting them.

For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted.

This parameter is only valid if the Engine parameter is redis .

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

Returns:

  • (Numeric, nil)

See Also:



326
327
328
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 326

def snapshot_retention_limit
  @snapshot_retention_limit
end

#snapshot_window ⇒ String? (readonly)

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

This parameter is only valid if the Engine parameter is redis .

Returns:

  • (String, nil)

See Also:



337
338
339
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 337

def snapshot_window
  @snapshot_window
end

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

A list of tags to be added to this resource.

Returns:

See Also:



342
343
344
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 342

def tags
  @tags
end

#transit_encryption_enabled ⇒ Boolean, ... (readonly)

A flag that enables in-transit encryption when set to true.

Returns:

See Also:



347
348
349
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 347

def transit_encryption_enabled
  @transit_encryption_enabled
end

#vpc_security_group_ids ⇒ Array<String>? (readonly)

One or more VPC security groups associated with the cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

Returns:

  • (Array<String>, nil)

See Also:



354
355
356
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 354

def vpc_security_group_ids
  @vpc_security_group_ids
end

Class Method Details

.jsii_properties ⇒ Object 



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 356

def self.jsii_properties
  {
    :cache_node_type => "cacheNodeType",
    :engine => "engine",
    :num_cache_nodes => "numCacheNodes",
    :auto_minor_version_upgrade => "autoMinorVersionUpgrade",
    :az_mode => "azMode",
    :cache_parameter_group_name => "cacheParameterGroupName",
    :cache_security_group_names => "cacheSecurityGroupNames",
    :cache_subnet_group_name => "cacheSubnetGroupName",
    :cluster_name => "clusterName",
    :engine_version => "engineVersion",
    :ip_discovery => "ipDiscovery",
    :log_delivery_configurations => "logDeliveryConfigurations",
    :network_type => "networkType",
    :notification_topic_arn => "notificationTopicArn",
    :port => "port",
    :preferred_availability_zone => "preferredAvailabilityZone",
    :preferred_availability_zones => "preferredAvailabilityZones",
    :preferred_maintenance_window => "preferredMaintenanceWindow",
    :snapshot_arns => "snapshotArns",
    :snapshot_name => "snapshotName",
    :snapshot_retention_limit => "snapshotRetentionLimit",
    :snapshot_window => "snapshotWindow",
    :tags => "tags",
    :transit_encryption_enabled => "transitEncryptionEnabled",
    :vpc_security_group_ids => "vpcSecurityGroupIds",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'elasticache/cfn_cache_cluster_props.rb', line 386

def to_jsii
  result = {}
  result.merge!({
    "cacheNodeType" => @cache_node_type,
    "engine" => @engine,
    "numCacheNodes" => @num_cache_nodes,
    "autoMinorVersionUpgrade" => @auto_minor_version_upgrade,
    "azMode" => @az_mode,
    "cacheParameterGroupName" => @cache_parameter_group_name,
    "cacheSecurityGroupNames" => @cache_security_group_names,
    "cacheSubnetGroupName" => @cache_subnet_group_name,
    "clusterName" => @cluster_name,
    "engineVersion" => @engine_version,
    "ipDiscovery" => @ip_discovery,
    "logDeliveryConfigurations" => @log_delivery_configurations,
    "networkType" => @network_type,
    "notificationTopicArn" => @notification_topic_arn,
    "port" => @port,
    "preferredAvailabilityZone" => @preferred_availability_zone,
    "preferredAvailabilityZones" => @preferred_availability_zones,
    "preferredMaintenanceWindow" => @preferred_maintenance_window,
    "snapshotArns" => @snapshot_arns,
    "snapshotName" => @snapshot_name,
    "snapshotRetentionLimit" => @snapshot_retention_limit,
    "snapshotWindow" => @snapshot_window,
    "tags" => @tags,
    "transitEncryptionEnabled" => @transit_encryption_enabled,
    "vpcSecurityGroupIds" => @vpc_security_group_ids,
  })
  result.compact
end