Package software.amazon.awscdk.services.elasticache

Class CfnCacheClusterProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.elasticache.CfnCacheClusterProps.Jsii$Proxy

All Implemented Interfaces:

CfnCacheClusterProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnCacheClusterProps

@Stability(Stable)
@Internal
public static final class CfnCacheClusterProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnCacheClusterProps

An implementation for CfnCacheClusterProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticache.CfnCacheClusterProps

CfnCacheClusterProps.Builder, CfnCacheClusterProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnCacheClusterProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnCacheClusterProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAutoMinorVersionUpgrade()	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.
final String	getAzMode()	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.
final String	getCacheNodeType()	The compute and memory capacity of the nodes in the node group (shard).
final String	getCacheParameterGroupName()	The name of the parameter group to associate with this cluster.
final List<String>	getCacheSecurityGroupNames()	A list of security group names to associate with this cluster.
final String	getCacheSubnetGroupName()	The name of the subnet group to be used for the cluster.
final String	getClusterName()	A name for the cache cluster.
final String	getEngine()	The name of the cache engine to be used for this cluster.
final String	getEngineVersion()	The version number of the cache engine to be used for this cluster.
final String	getIpDiscovery()	The network type you choose when modifying a cluster, either ipv4 | ipv6 .
final Object	getLogDeliveryConfigurations()	Specifies the destination, format and type of the logs.
final String	getNetworkType()	Must be either ipv4 | ipv6 | dual_stack .
final String	getNotificationTopicArn()	The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
final Number	getNumCacheNodes()	The number of cache nodes that the cache cluster should have.
final Number	getPort()	The port number on which each of the cache nodes accepts connections.
final String	getPreferredAvailabilityZone()	The EC2 Availability Zone in which the cluster is created.
final List<String>	getPreferredAvailabilityZones()	A list of the Availability Zones in which cache nodes are created.
final String	getPreferredMaintenanceWindow()	Specifies the weekly time range during which maintenance on the cluster is performed.
final List<String>	getSnapshotArns()	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.
final String	getSnapshotName()	The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).
final Number	getSnapshotRetentionLimit()	The number of days for which ElastiCache retains automatic snapshots before deleting them.
final String	getSnapshotWindow()	The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
final List<CfnTag>	getTags()	A list of tags to be added to this resource.
final Object	getTransitEncryptionEnabled()	A flag that enables in-transit encryption when set to true.
final List<String>	getVpcSecurityGroupIds()	One or more VPC security groups associated with the cluster.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnCacheClusterProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnCacheClusterProps.Builder.

Method Details

getCacheNodeType

public final String getCacheNodeType()

Description copied from interface: CfnCacheClusterProps

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.

Specified by:

getCacheNodeType in interface CfnCacheClusterProps

See Also:

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

getEngine

public final String getEngine()

Description copied from interface: CfnCacheClusterProps

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

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

Specified by:

getEngine in interface CfnCacheClusterProps

See Also:

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

getNumCacheNodes

public final Number getNumCacheNodes()

Description copied from interface: CfnCacheClusterProps

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 .

Specified by:

getNumCacheNodes in interface CfnCacheClusterProps

See Also:

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

getAutoMinorVersionUpgrade

public final Object getAutoMinorVersionUpgrade()

Description copied from interface: CfnCacheClusterProps

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.

Specified by:

getAutoMinorVersionUpgrade in interface CfnCacheClusterProps

See Also:

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

getAzMode

public final String getAzMode()

Description copied from interface: CfnCacheClusterProps

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.

Specified by:

getAzMode in interface CfnCacheClusterProps

See Also:

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

getCacheParameterGroupName

public final String getCacheParameterGroupName()

Description copied from interface: CfnCacheClusterProps

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.

Specified by:

getCacheParameterGroupName in interface CfnCacheClusterProps

See Also:

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

getCacheSecurityGroupNames

public final List<String> getCacheSecurityGroupNames()

Description copied from interface: CfnCacheClusterProps

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

Specified by:

getCacheSecurityGroupNames in interface CfnCacheClusterProps

See Also:

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

getCacheSubnetGroupName

public final String getCacheSubnetGroupName()

Description copied from interface: CfnCacheClusterProps

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

Specified by:

getCacheSubnetGroupName in interface CfnCacheClusterProps

See Also:

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

getClusterName

public final String getClusterName()

Description copied from interface: CfnCacheClusterProps

A name for the cache cluster.

If you don't specify a name, AWS 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.

Specified by:

getClusterName in interface CfnCacheClusterProps

See Also:

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

getEngineVersion

public final String getEngineVersion()

Description copied from interface: CfnCacheClusterProps

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.

Specified by:

getEngineVersion in interface CfnCacheClusterProps

See Also:

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

getIpDiscovery

public final String getIpDiscovery()

Description copied from interface: CfnCacheClusterProps

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 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system .

Specified by:

getIpDiscovery in interface CfnCacheClusterProps

See Also:

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

getLogDeliveryConfigurations

public final Object getLogDeliveryConfigurations()

Description copied from interface: CfnCacheClusterProps

Specifies the destination, format and type of the logs.

Specified by:

getLogDeliveryConfigurations in interface CfnCacheClusterProps

See Also:

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

getNetworkType

public final String getNetworkType()

Description copied from interface: CfnCacheClusterProps

Must be either ipv4 | ipv6 | dual_stack .

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

Specified by:

getNetworkType in interface CfnCacheClusterProps

See Also:

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

getNotificationTopicArn

public final String getNotificationTopicArn()

Description copied from interface: CfnCacheClusterProps

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.

Specified by:

getNotificationTopicArn in interface CfnCacheClusterProps

See Also:

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

getPort

public final Number getPort()

Description copied from interface: CfnCacheClusterProps

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

Specified by:

getPort in interface CfnCacheClusterProps

See Also:

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

getPreferredAvailabilityZone

public final String getPreferredAvailabilityZone()

Description copied from interface: CfnCacheClusterProps

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.

Specified by:

getPreferredAvailabilityZone in interface CfnCacheClusterProps

See Also:

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

getPreferredAvailabilityZones

public final List<String> getPreferredAvailabilityZones()

Description copied from interface: CfnCacheClusterProps

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.

Specified by:

getPreferredAvailabilityZones in interface CfnCacheClusterProps

See Also:

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

getPreferredMaintenanceWindow

public final String getPreferredMaintenanceWindow()

Description copied from interface: CfnCacheClusterProps

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

Specified by:

getPreferredMaintenanceWindow in interface CfnCacheClusterProps

See Also:

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

getSnapshotArns

public final List<String> getSnapshotArns()

Description copied from interface: CfnCacheClusterProps

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

Specified by:

getSnapshotArns in interface CfnCacheClusterProps

See Also:

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

getSnapshotName

public final String getSnapshotName()

Description copied from interface: CfnCacheClusterProps

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 .

Specified by:

getSnapshotName in interface CfnCacheClusterProps

See Also:

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

getSnapshotRetentionLimit

public final Number getSnapshotRetentionLimit()

Description copied from interface: CfnCacheClusterProps

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

Specified by:

getSnapshotRetentionLimit in interface CfnCacheClusterProps

See Also:

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

getSnapshotWindow

public final String getSnapshotWindow()

Description copied from interface: CfnCacheClusterProps

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 .

Specified by:

getSnapshotWindow in interface CfnCacheClusterProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnCacheClusterProps

A list of tags to be added to this resource.

Specified by:

getTags in interface CfnCacheClusterProps

See Also:

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

getTransitEncryptionEnabled

public final Object getTransitEncryptionEnabled()

Description copied from interface: CfnCacheClusterProps

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

Specified by:

getTransitEncryptionEnabled in interface CfnCacheClusterProps

See Also:

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

getVpcSecurityGroupIds

public final List<String> getVpcSecurityGroupIds()

Description copied from interface: CfnCacheClusterProps

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

Specified by:

getVpcSecurityGroupIds in interface CfnCacheClusterProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object