Class CfnCacheClusterProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCacheClusterProps>
- Enclosing interface:
- CfnCacheClusterProps
CfnCacheClusterProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionautoMinorVersionUpgrade
(Boolean autoMinorVersionUpgrade) Sets the value ofCfnCacheClusterProps.getAutoMinorVersionUpgrade()
autoMinorVersionUpgrade
(IResolvable autoMinorVersionUpgrade) Sets the value ofCfnCacheClusterProps.getAutoMinorVersionUpgrade()
Sets the value ofCfnCacheClusterProps.getAzMode()
build()
Builds the configured instance.cacheNodeType
(String cacheNodeType) Sets the value ofCfnCacheClusterProps.getCacheNodeType()
cacheParameterGroupName
(String cacheParameterGroupName) Sets the value ofCfnCacheClusterProps.getCacheParameterGroupName()
cacheSecurityGroupNames
(List<String> cacheSecurityGroupNames) Sets the value ofCfnCacheClusterProps.getCacheSecurityGroupNames()
cacheSubnetGroupName
(String cacheSubnetGroupName) Sets the value ofCfnCacheClusterProps.getCacheSubnetGroupName()
clusterName
(String clusterName) Sets the value ofCfnCacheClusterProps.getClusterName()
Sets the value ofCfnCacheClusterProps.getEngine()
engineVersion
(String engineVersion) Sets the value ofCfnCacheClusterProps.getEngineVersion()
ipDiscovery
(String ipDiscovery) Sets the value ofCfnCacheClusterProps.getIpDiscovery()
logDeliveryConfigurations
(List<? extends Object> logDeliveryConfigurations) Sets the value ofCfnCacheClusterProps.getLogDeliveryConfigurations()
logDeliveryConfigurations
(IResolvable logDeliveryConfigurations) Sets the value ofCfnCacheClusterProps.getLogDeliveryConfigurations()
networkType
(String networkType) Sets the value ofCfnCacheClusterProps.getNetworkType()
notificationTopicArn
(String notificationTopicArn) Sets the value ofCfnCacheClusterProps.getNotificationTopicArn()
numCacheNodes
(Number numCacheNodes) Sets the value ofCfnCacheClusterProps.getNumCacheNodes()
Sets the value ofCfnCacheClusterProps.getPort()
preferredAvailabilityZone
(String preferredAvailabilityZone) Sets the value ofCfnCacheClusterProps.getPreferredAvailabilityZone()
preferredAvailabilityZones
(List<String> preferredAvailabilityZones) Sets the value ofCfnCacheClusterProps.getPreferredAvailabilityZones()
preferredMaintenanceWindow
(String preferredMaintenanceWindow) Sets the value ofCfnCacheClusterProps.getPreferredMaintenanceWindow()
snapshotArns
(List<String> snapshotArns) Sets the value ofCfnCacheClusterProps.getSnapshotArns()
snapshotName
(String snapshotName) Sets the value ofCfnCacheClusterProps.getSnapshotName()
snapshotRetentionLimit
(Number snapshotRetentionLimit) Sets the value ofCfnCacheClusterProps.getSnapshotRetentionLimit()
snapshotWindow
(String snapshotWindow) Sets the value ofCfnCacheClusterProps.getSnapshotWindow()
Sets the value ofCfnCacheClusterProps.getTags()
transitEncryptionEnabled
(Boolean transitEncryptionEnabled) Sets the value ofCfnCacheClusterProps.getTransitEncryptionEnabled()
transitEncryptionEnabled
(IResolvable transitEncryptionEnabled) Sets the value ofCfnCacheClusterProps.getTransitEncryptionEnabled()
vpcSecurityGroupIds
(List<String> vpcSecurityGroupIds) Sets the value ofCfnCacheClusterProps.getVpcSecurityGroupIds()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
cacheNodeType
Sets the value ofCfnCacheClusterProps.getCacheNodeType()
- Parameters:
cacheNodeType
- The compute and memory capacity of the nodes in the node group (shard). This parameter is required. 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 theLogicalResourceId
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.
- Redis append-only files (AOF) are not supported for T1 or T2 instances.
- Redis Multi-AZ with automatic failover is not supported on T1 instances.
- Redis configuration variables
appendonly
andappendfsync
are not supported on Redis version 2.8.22 and later.
- Returns:
this
-
engine
Sets the value ofCfnCacheClusterProps.getEngine()
- Parameters:
engine
- The name of the cache engine to be used for this cluster. This parameter is required. Valid values for this parameter are:memcached
|redis
- Returns:
this
-
numCacheNodes
Sets the value ofCfnCacheClusterProps.getNumCacheNodes()
- Parameters:
numCacheNodes
- The number of cache nodes that the cache cluster should have. This parameter is required.However, if the
PreferredAvailabilityZone
andPreferredAvailabilityZones
properties were not previously specified and you don't specify any new values, an update requires replacement .- Returns:
this
-
autoMinorVersionUpgrade
@Stability(Stable) public CfnCacheClusterProps.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Sets the value ofCfnCacheClusterProps.getAutoMinorVersionUpgrade()
- Parameters:
autoMinorVersionUpgrade
- If you are running Redis 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:
this
-
autoMinorVersionUpgrade
@Stability(Stable) public CfnCacheClusterProps.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade) Sets the value ofCfnCacheClusterProps.getAutoMinorVersionUpgrade()
- Parameters:
autoMinorVersionUpgrade
- If you are running Redis 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:
this
-
azMode
Sets the value ofCfnCacheClusterProps.getAzMode()
- 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 only supported for Memcached clusters.If the
AZMode
andPreferredAvailabilityZones
are not specified, ElastiCache assumessingle-az
mode.- Returns:
this
-
cacheParameterGroupName
@Stability(Stable) public CfnCacheClusterProps.Builder cacheParameterGroupName(String cacheParameterGroupName) Sets the value ofCfnCacheClusterProps.getCacheParameterGroupName()
- Parameters:
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 hascluster-enabled='yes'
when creating a cluster.- Returns:
this
-
cacheSecurityGroupNames
@Stability(Stable) public CfnCacheClusterProps.Builder cacheSecurityGroupNames(List<String> cacheSecurityGroupNames) Sets the value ofCfnCacheClusterProps.getCacheSecurityGroupNames()
- Parameters:
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).- Returns:
this
-
cacheSubnetGroupName
@Stability(Stable) public CfnCacheClusterProps.Builder cacheSubnetGroupName(String cacheSubnetGroupName) Sets the value ofCfnCacheClusterProps.getCacheSubnetGroupName()
- Parameters:
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 .
- Returns:
this
-
clusterName
Sets the value ofCfnCacheClusterProps.getClusterName()
- Parameters:
clusterName
- A name for the cache cluster. If you don't specify a name, AWSCloudFormation 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:
this
-
engineVersion
Sets the value ofCfnCacheClusterProps.getEngineVersion()
- Parameters:
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.
- Returns:
this
-
ipDiscovery
Sets the value ofCfnCacheClusterProps.getIpDiscovery()
- Parameters:
ipDiscovery
- The network type you choose when modifying a cluster, eitheripv4
|ipv6
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system .- Returns:
this
-
logDeliveryConfigurations
@Stability(Stable) public CfnCacheClusterProps.Builder logDeliveryConfigurations(IResolvable logDeliveryConfigurations) Sets the value ofCfnCacheClusterProps.getLogDeliveryConfigurations()
- Parameters:
logDeliveryConfigurations
- Specifies the destination, format and type of the logs.- Returns:
this
-
logDeliveryConfigurations
@Stability(Stable) public CfnCacheClusterProps.Builder logDeliveryConfigurations(List<? extends Object> logDeliveryConfigurations) Sets the value ofCfnCacheClusterProps.getLogDeliveryConfigurations()
- Parameters:
logDeliveryConfigurations
- Specifies the destination, format and type of the logs.- Returns:
this
-
networkType
Sets the value ofCfnCacheClusterProps.getNetworkType()
- Parameters:
networkType
- Must be eitheripv4
|ipv6
|dual_stack
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system .- Returns:
this
-
notificationTopicArn
@Stability(Stable) public CfnCacheClusterProps.Builder notificationTopicArn(String notificationTopicArn) Sets the value ofCfnCacheClusterProps.getNotificationTopicArn()
- Parameters:
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.
- Returns:
this
-
port
Sets the value ofCfnCacheClusterProps.getPort()
- Parameters:
port
- The port number on which each of the cache nodes accepts connections.- Returns:
this
-
preferredAvailabilityZone
@Stability(Stable) public CfnCacheClusterProps.Builder preferredAvailabilityZone(String preferredAvailabilityZone) Sets the value ofCfnCacheClusterProps.getPreferredAvailabilityZone()
- Parameters:
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, usePreferredAvailabilityZones
.Default: System chosen Availability Zone.
- Returns:
this
-
preferredAvailabilityZones
@Stability(Stable) public CfnCacheClusterProps.Builder preferredAvailabilityZones(List<String> preferredAvailabilityZones) Sets the value ofCfnCacheClusterProps.getPreferredAvailabilityZones()
- Parameters:
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.
- Returns:
this
-
preferredMaintenanceWindow
@Stability(Stable) public CfnCacheClusterProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow) Sets the value ofCfnCacheClusterProps.getPreferredMaintenanceWindow()
- Parameters:
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 forddd
are: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:
this
-
snapshotArns
Sets the value ofCfnCacheClusterProps.getSnapshotArns()
- Parameters:
snapshotArns
- A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis 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 isredis
.Example of an Amazon S3 ARN:
arn:aws:s3:::my_bucket/snapshot1.rdb
- Returns:
this
-
snapshotName
Sets the value ofCfnCacheClusterProps.getSnapshotName()
- Parameters:
snapshotName
- The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes torestoring
while the new node group (shard) is being created.This parameter is only valid if the
Engine
parameter isredis
.- Returns:
this
-
snapshotRetentionLimit
@Stability(Stable) public CfnCacheClusterProps.Builder snapshotRetentionLimit(Number snapshotRetentionLimit) Sets the value ofCfnCacheClusterProps.getSnapshotRetentionLimit()
- Parameters:
snapshotRetentionLimit
- The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you setSnapshotRetentionLimit
to 5, a snapshot taken today is retained for 5 days before being deleted.This parameter is only valid if the
Engine
parameter isredis
.Default: 0 (i.e., automatic backups are disabled for this cache cluster).
- Returns:
this
-
snapshotWindow
Sets the value ofCfnCacheClusterProps.getSnapshotWindow()
- Parameters:
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 isredis
.- Returns:
this
-
tags
Sets the value ofCfnCacheClusterProps.getTags()
- Parameters:
tags
- A list of tags to be added to this resource.- Returns:
this
-
transitEncryptionEnabled
@Stability(Stable) public CfnCacheClusterProps.Builder transitEncryptionEnabled(Boolean transitEncryptionEnabled) Sets the value ofCfnCacheClusterProps.getTransitEncryptionEnabled()
- Parameters:
transitEncryptionEnabled
- A flag that enables in-transit encryption when set to true.- Returns:
this
-
transitEncryptionEnabled
@Stability(Stable) public CfnCacheClusterProps.Builder transitEncryptionEnabled(IResolvable transitEncryptionEnabled) Sets the value ofCfnCacheClusterProps.getTransitEncryptionEnabled()
- Parameters:
transitEncryptionEnabled
- A flag that enables in-transit encryption when set to true.- Returns:
this
-
vpcSecurityGroupIds
@Stability(Stable) public CfnCacheClusterProps.Builder vpcSecurityGroupIds(List<String> vpcSecurityGroupIds) Sets the value ofCfnCacheClusterProps.getVpcSecurityGroupIds()
- Parameters:
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).- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnCacheClusterProps>
- Returns:
- a new instance of
CfnCacheClusterProps
- Throws:
NullPointerException
- if any required attribute was not provided
-