Interface CacheCluster.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<CacheCluster.Builder,CacheCluster>
,SdkBuilder<CacheCluster.Builder,CacheCluster>
,SdkPojo
- Enclosing class:
- CacheCluster
public static interface CacheCluster.Builder extends SdkPojo, CopyableBuilder<CacheCluster.Builder,CacheCluster>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CacheCluster.Builder
arn(String arn)
The ARN (Amazon Resource Name) of the cache cluster.CacheCluster.Builder
atRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
A flag that enables encryption at-rest when set totrue
.CacheCluster.Builder
authTokenEnabled(Boolean authTokenEnabled)
A flag that enables using anAuthToken
(password) when issuing Valkey or Redis OSS commands.CacheCluster.Builder
authTokenLastModifiedDate(Instant authTokenLastModifiedDate)
The date the auth token was last modifiedCacheCluster.Builder
autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign.CacheCluster.Builder
cacheClusterCreateTime(Instant cacheClusterCreateTime)
The date and time when the cluster was created.CacheCluster.Builder
cacheClusterId(String cacheClusterId)
The user-supplied identifier of the cluster.CacheCluster.Builder
cacheClusterStatus(String cacheClusterStatus)
The current state of this cluster, one of the following values:available
,creating
,deleted
,deleting
,incompatible-network
,modifying
,rebooting cluster nodes
,restore-failed
, orsnapshotting
.CacheCluster.Builder
cacheNodes(Collection<CacheNode> cacheNodes)
A list of cache nodes that are members of the cluster.CacheCluster.Builder
cacheNodes(Consumer<CacheNode.Builder>... cacheNodes)
A list of cache nodes that are members of the cluster.CacheCluster.Builder
cacheNodes(CacheNode... cacheNodes)
A list of cache nodes that are members of the cluster.CacheCluster.Builder
cacheNodeType(String cacheNodeType)
The name of the compute and memory capacity node type for the cluster.default CacheCluster.Builder
cacheParameterGroup(Consumer<CacheParameterGroupStatus.Builder> cacheParameterGroup)
Status of the cache parameter group.CacheCluster.Builder
cacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)
Status of the cache parameter group.CacheCluster.Builder
cacheSecurityGroups(Collection<CacheSecurityGroupMembership> cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.CacheCluster.Builder
cacheSecurityGroups(Consumer<CacheSecurityGroupMembership.Builder>... cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.CacheCluster.Builder
cacheSecurityGroups(CacheSecurityGroupMembership... cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.CacheCluster.Builder
cacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group associated with the cluster.CacheCluster.Builder
clientDownloadLandingPage(String clientDownloadLandingPage)
The URL of the web page where you can download the latest ElastiCache client library.default CacheCluster.Builder
configurationEndpoint(Consumer<Endpoint.Builder> configurationEndpoint)
Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster.CacheCluster.Builder
configurationEndpoint(Endpoint configurationEndpoint)
Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster.CacheCluster.Builder
engine(String engine)
The name of the cache engine (memcached
orredis
) to be used for this cluster.CacheCluster.Builder
engineVersion(String engineVersion)
The version of the cache engine that is used in this cluster.CacheCluster.Builder
ipDiscovery(String ipDiscovery)
The network type associated with the cluster, eitheripv4
|ipv6
.CacheCluster.Builder
ipDiscovery(IpDiscovery ipDiscovery)
The network type associated with the cluster, eitheripv4
|ipv6
.CacheCluster.Builder
logDeliveryConfigurations(Collection<LogDeliveryConfiguration> logDeliveryConfigurations)
Returns the destination, format and type of the logs.CacheCluster.Builder
logDeliveryConfigurations(Consumer<LogDeliveryConfiguration.Builder>... logDeliveryConfigurations)
Returns the destination, format and type of the logs.CacheCluster.Builder
logDeliveryConfigurations(LogDeliveryConfiguration... logDeliveryConfigurations)
Returns the destination, format and type of the logs.CacheCluster.Builder
networkType(String networkType)
Must be eitheripv4
|ipv6
|dual_stack
.CacheCluster.Builder
networkType(NetworkType networkType)
Must be eitheripv4
|ipv6
|dual_stack
.default CacheCluster.Builder
notificationConfiguration(Consumer<NotificationConfiguration.Builder> notificationConfiguration)
Describes a notification topic and its status.CacheCluster.Builder
notificationConfiguration(NotificationConfiguration notificationConfiguration)
Describes a notification topic and its status.CacheCluster.Builder
numCacheNodes(Integer numCacheNodes)
The number of cache nodes in the cluster.default CacheCluster.Builder
pendingModifiedValues(Consumer<PendingModifiedValues.Builder> pendingModifiedValues)
Sets the value of the PendingModifiedValues property for this object.CacheCluster.Builder
pendingModifiedValues(PendingModifiedValues pendingModifiedValues)
Sets the value of the PendingModifiedValues property for this object.CacheCluster.Builder
preferredAvailabilityZone(String preferredAvailabilityZone)
The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.CacheCluster.Builder
preferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed.CacheCluster.Builder
preferredOutpostArn(String preferredOutpostArn)
The outpost ARN in which the cache cluster is created.CacheCluster.Builder
replicationGroupId(String replicationGroupId)
The replication group to which this cluster belongs.CacheCluster.Builder
replicationGroupLogDeliveryEnabled(Boolean replicationGroupLogDeliveryEnabled)
A boolean value indicating whether log delivery is enabled for the replication group.CacheCluster.Builder
securityGroups(Collection<SecurityGroupMembership> securityGroups)
A list of VPC Security Groups associated with the cluster.CacheCluster.Builder
securityGroups(Consumer<SecurityGroupMembership.Builder>... securityGroups)
A list of VPC Security Groups associated with the cluster.CacheCluster.Builder
securityGroups(SecurityGroupMembership... securityGroups)
A list of VPC Security Groups associated with the cluster.CacheCluster.Builder
snapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them.CacheCluster.Builder
snapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.CacheCluster.Builder
transitEncryptionEnabled(Boolean transitEncryptionEnabled)
A flag that enables in-transit encryption when set totrue
.CacheCluster.Builder
transitEncryptionMode(String transitEncryptionMode)
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.CacheCluster.Builder
transitEncryptionMode(TransitEncryptionMode transitEncryptionMode)
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
cacheClusterId
CacheCluster.Builder cacheClusterId(String cacheClusterId)
The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
- Parameters:
cacheClusterId
- The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
configurationEndpoint
CacheCluster.Builder configurationEndpoint(Endpoint configurationEndpoint)
Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have
.cfg
in it.Example:
mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
- Parameters:
configurationEndpoint
- Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have.cfg
in it.Example:
mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
configurationEndpoint
default CacheCluster.Builder configurationEndpoint(Consumer<Endpoint.Builder> configurationEndpoint)
Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have
.cfg
in it.Example:
This is a convenience method that creates an instance of themem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
Endpoint.Builder
avoiding the need to create one manually viaEndpoint.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconfigurationEndpoint(Endpoint)
.- Parameters:
configurationEndpoint
- a consumer that will call methods onEndpoint.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
configurationEndpoint(Endpoint)
-
clientDownloadLandingPage
CacheCluster.Builder clientDownloadLandingPage(String clientDownloadLandingPage)
The URL of the web page where you can download the latest ElastiCache client library.
- Parameters:
clientDownloadLandingPage
- The URL of the web page where you can download the latest ElastiCache client library.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheNodeType
CacheCluster.Builder cacheNodeType(String cacheNodeType)
The name of the compute and memory capacity node type for the cluster.
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.
-
General purpose:
-
Current generation:
M7g node types:
cache.m7g.large
,cache.m7g.xlarge
,cache.m7g.2xlarge
,cache.m7g.4xlarge
,cache.m7g.8xlarge
,cache.m7g.12xlarge
,cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):
cache.m6g.large
,cache.m6g.xlarge
,cache.m6g.2xlarge
,cache.m6g.4xlarge
,cache.m6g.8xlarge
,cache.m6g.12xlarge
,cache.m6g.16xlarge
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 (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
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. Existing clusters are still supported but creation of new clusters is not supported for these types.)
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. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types:
cache.c1.xlarge
-
-
Memory optimized:
-
Current generation:
R7g node types:
cache.r7g.large
,cache.r7g.xlarge
,cache.r7g.2xlarge
,cache.r7g.4xlarge
,cache.r7g.8xlarge
,cache.r7g.12xlarge
,cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):
cache.r6g.large
,cache.r6g.xlarge
,cache.r6g.2xlarge
,cache.r6g.4xlarge
,cache.r6g.8xlarge
,cache.r6g.12xlarge
,cache.r6g.16xlarge
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. Existing clusters are still supported but creation of new clusters is not supported for these types.)
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
-
Additional node type info
-
All current generation instance types are created in Amazon VPC by default.
-
Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
-
Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
-
The configuration variables
appendonly
andappendfsync
are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
- Parameters:
cacheNodeType
- The name of the compute and memory capacity node type for the cluster.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.
-
General purpose:
-
Current generation:
M7g node types:
cache.m7g.large
,cache.m7g.xlarge
,cache.m7g.2xlarge
,cache.m7g.4xlarge
,cache.m7g.8xlarge
,cache.m7g.12xlarge
,cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):
cache.m6g.large
,cache.m6g.xlarge
,cache.m6g.2xlarge
,cache.m6g.4xlarge
,cache.m6g.8xlarge
,cache.m6g.12xlarge
,cache.m6g.16xlarge
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 (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
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. Existing clusters are still supported but creation of new clusters is not supported for these types.)
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. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types:
cache.c1.xlarge
-
-
Memory optimized:
-
Current generation:
R7g node types:
cache.r7g.large
,cache.r7g.xlarge
,cache.r7g.2xlarge
,cache.r7g.4xlarge
,cache.r7g.8xlarge
,cache.r7g.12xlarge
,cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):
cache.r6g.large
,cache.r6g.xlarge
,cache.r6g.2xlarge
,cache.r6g.4xlarge
,cache.r6g.8xlarge
,cache.r6g.12xlarge
,cache.r6g.16xlarge
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. Existing clusters are still supported but creation of new clusters is not supported for these types.)
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
-
Additional node type info
-
All current generation instance types are created in Amazon VPC by default.
-
Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
-
Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
-
The configuration variables
appendonly
andappendfsync
are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
engine
CacheCluster.Builder engine(String engine)
The name of the cache engine (
memcached
orredis
) to be used for this cluster.- Parameters:
engine
- The name of the cache engine (memcached
orredis
) to be used for this cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineVersion
CacheCluster.Builder engineVersion(String engineVersion)
The version of the cache engine that is used in this cluster.
- Parameters:
engineVersion
- The version of the cache engine that is used in this cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheClusterStatus
CacheCluster.Builder cacheClusterStatus(String cacheClusterStatus)
The current state of this cluster, one of the following values:
available
,creating
,deleted
,deleting
,incompatible-network
,modifying
,rebooting cluster nodes
,restore-failed
, orsnapshotting
.- Parameters:
cacheClusterStatus
- The current state of this cluster, one of the following values:available
,creating
,deleted
,deleting
,incompatible-network
,modifying
,rebooting cluster nodes
,restore-failed
, orsnapshotting
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
numCacheNodes
CacheCluster.Builder numCacheNodes(Integer numCacheNodes)
The number of cache nodes in the cluster.
For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
- Parameters:
numCacheNodes
- The number of cache nodes in the cluster.For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
preferredAvailabilityZone
CacheCluster.Builder preferredAvailabilityZone(String preferredAvailabilityZone)
The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
- Parameters:
preferredAvailabilityZone
- The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
preferredOutpostArn
CacheCluster.Builder preferredOutpostArn(String preferredOutpostArn)
The outpost ARN in which the cache cluster is created.
- Parameters:
preferredOutpostArn
- The outpost ARN in which the cache cluster is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheClusterCreateTime
CacheCluster.Builder cacheClusterCreateTime(Instant cacheClusterCreateTime)
The date and time when the cluster was created.
- Parameters:
cacheClusterCreateTime
- The date and time when the cluster was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
preferredMaintenanceWindow
CacheCluster.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. 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:
- Returns a reference to this object so that method calls can be chained together.
-
-
pendingModifiedValues
CacheCluster.Builder pendingModifiedValues(PendingModifiedValues pendingModifiedValues)
Sets the value of the PendingModifiedValues property for this object.- Parameters:
pendingModifiedValues
- The new value for the PendingModifiedValues property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pendingModifiedValues
default CacheCluster.Builder pendingModifiedValues(Consumer<PendingModifiedValues.Builder> pendingModifiedValues)
Sets the value of the PendingModifiedValues property for this object. This is a convenience method that creates an instance of thePendingModifiedValues.Builder
avoiding the need to create one manually viaPendingModifiedValues.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topendingModifiedValues(PendingModifiedValues)
.- Parameters:
pendingModifiedValues
- a consumer that will call methods onPendingModifiedValues.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
pendingModifiedValues(PendingModifiedValues)
-
notificationConfiguration
CacheCluster.Builder notificationConfiguration(NotificationConfiguration notificationConfiguration)
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
- Parameters:
notificationConfiguration
- Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notificationConfiguration
default CacheCluster.Builder notificationConfiguration(Consumer<NotificationConfiguration.Builder> notificationConfiguration)
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
This is a convenience method that creates an instance of theNotificationConfiguration.Builder
avoiding the need to create one manually viaNotificationConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonotificationConfiguration(NotificationConfiguration)
.- Parameters:
notificationConfiguration
- a consumer that will call methods onNotificationConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
notificationConfiguration(NotificationConfiguration)
-
cacheSecurityGroups
CacheCluster.Builder cacheSecurityGroups(Collection<CacheSecurityGroupMembership> cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.
- Parameters:
cacheSecurityGroups
- A list of cache security group elements, composed of name and status sub-elements.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheSecurityGroups
CacheCluster.Builder cacheSecurityGroups(CacheSecurityGroupMembership... cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.
- Parameters:
cacheSecurityGroups
- A list of cache security group elements, composed of name and status sub-elements.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheSecurityGroups
CacheCluster.Builder cacheSecurityGroups(Consumer<CacheSecurityGroupMembership.Builder>... cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.
This is a convenience method that creates an instance of theCacheSecurityGroupMembership.Builder
avoiding the need to create one manually viaCacheSecurityGroupMembership.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#cacheSecurityGroups(List
.) - Parameters:
cacheSecurityGroups
- a consumer that will call methods onCacheSecurityGroupMembership.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#cacheSecurityGroups(java.util.Collection
)
-
cacheParameterGroup
CacheCluster.Builder cacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)
Status of the cache parameter group.
- Parameters:
cacheParameterGroup
- Status of the cache parameter group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheParameterGroup
default CacheCluster.Builder cacheParameterGroup(Consumer<CacheParameterGroupStatus.Builder> cacheParameterGroup)
Status of the cache parameter group.
This is a convenience method that creates an instance of theCacheParameterGroupStatus.Builder
avoiding the need to create one manually viaCacheParameterGroupStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocacheParameterGroup(CacheParameterGroupStatus)
.- Parameters:
cacheParameterGroup
- a consumer that will call methods onCacheParameterGroupStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
cacheParameterGroup(CacheParameterGroupStatus)
-
cacheSubnetGroupName
CacheCluster.Builder cacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group associated with the cluster.
- Parameters:
cacheSubnetGroupName
- The name of the cache subnet group associated with the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheNodes
CacheCluster.Builder cacheNodes(Collection<CacheNode> cacheNodes)
A list of cache nodes that are members of the cluster.
- Parameters:
cacheNodes
- A list of cache nodes that are members of the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheNodes
CacheCluster.Builder cacheNodes(CacheNode... cacheNodes)
A list of cache nodes that are members of the cluster.
- Parameters:
cacheNodes
- A list of cache nodes that are members of the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheNodes
CacheCluster.Builder cacheNodes(Consumer<CacheNode.Builder>... cacheNodes)
A list of cache nodes that are members of the cluster.
This is a convenience method that creates an instance of theCacheNode.Builder
avoiding the need to create one manually viaCacheNode.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#cacheNodes(List
.) - Parameters:
cacheNodes
- a consumer that will call methods onCacheNode.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#cacheNodes(java.util.Collection
)
-
autoMinorVersionUpgrade
CacheCluster.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
- Parameters:
autoMinorVersionUpgrade
- If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroups
CacheCluster.Builder securityGroups(Collection<SecurityGroupMembership> securityGroups)
A list of VPC Security Groups associated with the cluster.
- Parameters:
securityGroups
- A list of VPC Security Groups associated with the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroups
CacheCluster.Builder securityGroups(SecurityGroupMembership... securityGroups)
A list of VPC Security Groups associated with the cluster.
- Parameters:
securityGroups
- A list of VPC Security Groups associated with the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroups
CacheCluster.Builder securityGroups(Consumer<SecurityGroupMembership.Builder>... securityGroups)
A list of VPC Security Groups associated with the cluster.
This is a convenience method that creates an instance of theSecurityGroupMembership.Builder
avoiding the need to create one manually viaSecurityGroupMembership.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#securityGroups(List
.) - Parameters:
securityGroups
- a consumer that will call methods onSecurityGroupMembership.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#securityGroups(java.util.Collection
)
-
replicationGroupId
CacheCluster.Builder replicationGroupId(String replicationGroupId)
The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.
- Parameters:
replicationGroupId
- The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotRetentionLimit
CacheCluster.Builder snapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set
SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days before being deleted.If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
- Parameters:
snapshotRetentionLimit
- The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you setSnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days before being deleted.If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotWindow
CacheCluster.Builder snapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
Example:
05:00-09:00
- Parameters:
snapshotWindow
- The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.Example:
05:00-09:00
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authTokenEnabled
CacheCluster.Builder authTokenEnabled(Boolean authTokenEnabled)
A flag that enables using an
AuthToken
(password) when issuing Valkey or Redis OSS commands.Default:
false
- Parameters:
authTokenEnabled
- A flag that enables using anAuthToken
(password) when issuing Valkey or Redis OSS commands.Default:
false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authTokenLastModifiedDate
CacheCluster.Builder authTokenLastModifiedDate(Instant authTokenLastModifiedDate)
The date the auth token was last modified
- Parameters:
authTokenLastModifiedDate
- The date the auth token was last modified- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
transitEncryptionEnabled
CacheCluster.Builder transitEncryptionEnabled(Boolean transitEncryptionEnabled)
A flag that enables in-transit encryption when set to
true
.Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version
3.2.6
,4.x
or later.Default:
false
- Parameters:
transitEncryptionEnabled
- A flag that enables in-transit encryption when set totrue
.Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version
3.2.6
,4.x
or later.Default:
false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
atRestEncryptionEnabled
CacheCluster.Builder atRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
A flag that enables encryption at-rest when set to
true
.You cannot modify the value of
AtRestEncryptionEnabled
after the cluster is created. To enable at-rest encryption on a cluster you must setAtRestEncryptionEnabled
totrue
when you create a cluster.Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version
3.2.6
,4.x
or later.Default:
false
- Parameters:
atRestEncryptionEnabled
- A flag that enables encryption at-rest when set totrue
.You cannot modify the value of
AtRestEncryptionEnabled
after the cluster is created. To enable at-rest encryption on a cluster you must setAtRestEncryptionEnabled
totrue
when you create a cluster.Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version
3.2.6
,4.x
or later.Default:
false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
arn
CacheCluster.Builder arn(String arn)
The ARN (Amazon Resource Name) of the cache cluster.
- Parameters:
arn
- The ARN (Amazon Resource Name) of the cache cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
replicationGroupLogDeliveryEnabled
CacheCluster.Builder replicationGroupLogDeliveryEnabled(Boolean replicationGroupLogDeliveryEnabled)
A boolean value indicating whether log delivery is enabled for the replication group.
- Parameters:
replicationGroupLogDeliveryEnabled
- A boolean value indicating whether log delivery is enabled for the replication group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logDeliveryConfigurations
CacheCluster.Builder logDeliveryConfigurations(Collection<LogDeliveryConfiguration> logDeliveryConfigurations)
Returns the destination, format and type of the logs.
- Parameters:
logDeliveryConfigurations
- Returns the destination, format and type of the logs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logDeliveryConfigurations
CacheCluster.Builder logDeliveryConfigurations(LogDeliveryConfiguration... logDeliveryConfigurations)
Returns the destination, format and type of the logs.
- Parameters:
logDeliveryConfigurations
- Returns the destination, format and type of the logs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logDeliveryConfigurations
CacheCluster.Builder logDeliveryConfigurations(Consumer<LogDeliveryConfiguration.Builder>... logDeliveryConfigurations)
Returns the destination, format and type of the logs.
This is a convenience method that creates an instance of theLogDeliveryConfiguration.Builder
avoiding the need to create one manually viaLogDeliveryConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#logDeliveryConfigurations(List
.) - Parameters:
logDeliveryConfigurations
- a consumer that will call methods onLogDeliveryConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#logDeliveryConfigurations(java.util.Collection
)
-
networkType
CacheCluster.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 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.- Parameters:
networkType
- Must be eitheripv4
|ipv6
|dual_stack
. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
NetworkType
,NetworkType
-
networkType
CacheCluster.Builder networkType(NetworkType 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 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.- Parameters:
networkType
- Must be eitheripv4
|ipv6
|dual_stack
. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
NetworkType
,NetworkType
-
ipDiscovery
CacheCluster.Builder ipDiscovery(String ipDiscovery)
The network type associated with the cluster, either
ipv4
|ipv6
. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.- Parameters:
ipDiscovery
- The network type associated with the cluster, eitheripv4
|ipv6
. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
IpDiscovery
,IpDiscovery
-
ipDiscovery
CacheCluster.Builder ipDiscovery(IpDiscovery ipDiscovery)
The network type associated with the cluster, either
ipv4
|ipv6
. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.- Parameters:
ipDiscovery
- The network type associated with the cluster, eitheripv4
|ipv6
. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
IpDiscovery
,IpDiscovery
-
transitEncryptionMode
CacheCluster.Builder transitEncryptionMode(String transitEncryptionMode)
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
- Parameters:
transitEncryptionMode
- A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TransitEncryptionMode
,TransitEncryptionMode
-
transitEncryptionMode
CacheCluster.Builder transitEncryptionMode(TransitEncryptionMode transitEncryptionMode)
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
- Parameters:
transitEncryptionMode
- A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TransitEncryptionMode
,TransitEncryptionMode
-
-