Package software.amazon.awscdk.cfnpropertymixins.services.elasticache

Class CfnCacheClusterPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.elasticache.CfnCacheClusterPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCacheClusterPropsMixin>

Enclosing class:

CfnCacheClusterPropsMixin

@Stability(Stable)
public static final class CfnCacheClusterPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCacheClusterPropsMixin>

A fluent builder for CfnCacheClusterPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnCacheClusterPropsMixin.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)	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.
CfnCacheClusterPropsMixin.Builder	autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)	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.
CfnCacheClusterPropsMixin.Builder	azMode(String azMode)	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.
CfnCacheClusterPropsMixin	build()
CfnCacheClusterPropsMixin.Builder	cacheNodeType(String cacheNodeType)	The compute and memory capacity of the nodes in the node group (shard).
CfnCacheClusterPropsMixin.Builder	cacheParameterGroupName(String cacheParameterGroupName)	The name of the parameter group to associate with this cluster.
CfnCacheClusterPropsMixin.Builder	cacheSecurityGroupNames(List<String> cacheSecurityGroupNames)	A list of security group names to associate with this cluster.
CfnCacheClusterPropsMixin.Builder	cacheSubnetGroupName(String cacheSubnetGroupName)	The name of the subnet group to be used for the cluster.
CfnCacheClusterPropsMixin.Builder	clusterName(String clusterName)	A name for the cache cluster.
static CfnCacheClusterPropsMixin.Builder	create()
static CfnCacheClusterPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnCacheClusterPropsMixin.Builder	engine(String engine)	The name of the cache engine to be used for this cluster.
CfnCacheClusterPropsMixin.Builder	engineVersion(String engineVersion)	The version number of the cache engine to be used for this cluster.
CfnCacheClusterPropsMixin.Builder	ipDiscovery(String ipDiscovery)	The network type you choose when modifying a cluster, either ipv4 | ipv6 .
CfnCacheClusterPropsMixin.Builder	logDeliveryConfigurations(List<? extends Object> logDeliveryConfigurations)	Specifies the destination, format and type of the logs.
CfnCacheClusterPropsMixin.Builder	logDeliveryConfigurations(IResolvable logDeliveryConfigurations)	Specifies the destination, format and type of the logs.
CfnCacheClusterPropsMixin.Builder	networkType(String networkType)	Must be either ipv4 | ipv6 | dual_stack .
CfnCacheClusterPropsMixin.Builder	notificationTopicArn(String notificationTopicArn)	The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
CfnCacheClusterPropsMixin.Builder	numCacheNodes(Number numCacheNodes)	The number of cache nodes that the cache cluster should have.
CfnCacheClusterPropsMixin.Builder	port(Number port)	The port number on which each of the cache nodes accepts connections.
CfnCacheClusterPropsMixin.Builder	preferredAvailabilityZone(String preferredAvailabilityZone)	The EC2 Availability Zone in which the cluster is created.
CfnCacheClusterPropsMixin.Builder	preferredAvailabilityZones(List<String> preferredAvailabilityZones)	A list of the Availability Zones in which cache nodes are created.
CfnCacheClusterPropsMixin.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	Specifies the weekly time range during which maintenance on the cluster is performed.
CfnCacheClusterPropsMixin.Builder	snapshotArns(List<String> snapshotArns)	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.
CfnCacheClusterPropsMixin.Builder	snapshotName(String snapshotName)	The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).
CfnCacheClusterPropsMixin.Builder	snapshotRetentionLimit(Number snapshotRetentionLimit)	The number of days for which ElastiCache retains automatic snapshots before deleting them.
CfnCacheClusterPropsMixin.Builder	snapshotWindow(String snapshotWindow)	The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
CfnCacheClusterPropsMixin.Builder	tags(List<? extends CfnTag> tags)	A list of tags to be added to this resource.
CfnCacheClusterPropsMixin.Builder	transitEncryptionEnabled(Boolean transitEncryptionEnabled)	A flag that enables in-transit encryption when set to true.
CfnCacheClusterPropsMixin.Builder	transitEncryptionEnabled(IResolvable transitEncryptionEnabled)	A flag that enables in-transit encryption when set to true.
CfnCacheClusterPropsMixin.Builder	vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)	One or more VPC security groups associated with the cluster.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnCacheClusterPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnCacheClusterPropsMixin.Builder.

create

@Stability(Stable)
public static CfnCacheClusterPropsMixin.Builder create()

Returns:

a new instance of CfnCacheClusterPropsMixin.Builder.

autoMinorVersionUpgrade

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

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.

Parameters:

autoMinorVersionUpgrade - 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-autominorversionupgrade

autoMinorVersionUpgrade

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)

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.

Parameters:

autoMinorVersionUpgrade - 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-autominorversionupgrade

azMode

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder azMode(String azMode)

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.

Parameters:

azMode - 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 required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-azmode

cacheNodeType

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder cacheNodeType(String cacheNodeType)

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.

Parameters:

cacheNodeType - The compute and memory capacity of the nodes in the node group (shard). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-cachenodetype

cacheParameterGroupName

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder cacheParameterGroupName(String cacheParameterGroupName)

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.

Parameters:

cacheParameterGroupName - The name of the parameter group to associate with this cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-cacheparametergroupname

cacheSecurityGroupNames

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder cacheSecurityGroupNames(List<String> cacheSecurityGroupNames)

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).

Parameters:

cacheSecurityGroupNames - A list of security group names to associate with this cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-cachesecuritygroupnames

cacheSubnetGroupName

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder cacheSubnetGroupName(String cacheSubnetGroupName)

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) .

Parameters:

cacheSubnetGroupName - The name of the subnet group to be used for the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-cachesubnetgroupname

clusterName

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder clusterName(String clusterName)

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.

Parameters:

clusterName - A name for the cache cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-clustername

engine

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder engine(String engine)

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

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

Parameters:

engine - The name of the cache engine to be used for this cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-engine

engineVersion

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder engineVersion(String engineVersion)

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.

Parameters:

engineVersion - The version number of the cache engine to be used for this cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-engineversion

ipDiscovery

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder ipDiscovery(String ipDiscovery)

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 .

Parameters:

ipDiscovery - The network type you choose when modifying a cluster, either ipv4 | ipv6 . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-ipdiscovery

logDeliveryConfigurations

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder logDeliveryConfigurations(IResolvable logDeliveryConfigurations)

Specifies the destination, format and type of the logs.

Parameters:

logDeliveryConfigurations - Specifies the destination, format and type of the logs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-logdeliveryconfigurations

logDeliveryConfigurations

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder logDeliveryConfigurations(List<? extends Object> logDeliveryConfigurations)

Specifies the destination, format and type of the logs.

Parameters:

logDeliveryConfigurations - Specifies the destination, format and type of the logs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-logdeliveryconfigurations

networkType

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder networkType(String networkType)

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 .

Parameters:

networkType - Must be either ipv4 | ipv6 | dual_stack . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-networktype

notificationTopicArn

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder notificationTopicArn(String notificationTopicArn)

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.

Parameters:

notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-notificationtopicarn

numCacheNodes

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder numCacheNodes(Number numCacheNodes)

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 .

Parameters:

numCacheNodes - The number of cache nodes that the cache cluster should have. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-numcachenodes

port

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder port(Number port)

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

Parameters:

port - The port number on which each of the cache nodes accepts connections. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-port

preferredAvailabilityZone

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder preferredAvailabilityZone(String preferredAvailabilityZone)

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.

Parameters:

preferredAvailabilityZone - The EC2 Availability Zone in which the cluster is created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-preferredavailabilityzone

preferredAvailabilityZones

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder preferredAvailabilityZones(List<String> preferredAvailabilityZones)

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.

Parameters:

preferredAvailabilityZones - A list of the Availability Zones in which cache nodes are created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-preferredavailabilityzones

preferredMaintenanceWindow

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

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

Parameters:

preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cluster is performed. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-preferredmaintenancewindow

snapshotArns

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder snapshotArns(List<String> snapshotArns)

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

Parameters:

snapshotArns - 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-snapshotarns

snapshotName

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder snapshotName(String snapshotName)

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 .

Parameters:

snapshotName - The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-snapshotname

snapshotRetentionLimit

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder snapshotRetentionLimit(Number snapshotRetentionLimit)

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).

Parameters:

snapshotRetentionLimit - The number of days for which ElastiCache retains automatic snapshots before deleting them. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-snapshotretentionlimit

snapshotWindow

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder snapshotWindow(String snapshotWindow)

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 .

Parameters:

snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-snapshotwindow

tags

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder tags(List<? extends CfnTag> tags)

A list of tags to be added to this resource.

Parameters:

tags - A list of tags to be added to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-tags

transitEncryptionEnabled

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder transitEncryptionEnabled(Boolean transitEncryptionEnabled)

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

Parameters:

transitEncryptionEnabled - A flag that enables in-transit encryption when set to true. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-transitencryptionenabled

transitEncryptionEnabled

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder transitEncryptionEnabled(IResolvable transitEncryptionEnabled)

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

Parameters:

transitEncryptionEnabled - A flag that enables in-transit encryption when set to true. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-transitencryptionenabled

vpcSecurityGroupIds

@Stability(Stable)
public CfnCacheClusterPropsMixin.Builder vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)

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).

Parameters:

vpcSecurityGroupIds - One or more VPC security groups associated with the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-vpcsecuritygroupids

build

@Stability(Stable)
public CfnCacheClusterPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCacheClusterPropsMixin>

Returns:

a newly built instance of CfnCacheClusterPropsMixin.