Package software.amazon.awssdk.services.elasticache.model

Interface CacheCluster.Builder

All Superinterfaces:

CopyableBuilder<CacheCluster.Builder,CacheCluster>, SdkBuilder<CacheCluster.Builder,CacheCluster>

Enclosing class:

CacheCluster

public static interface CacheCluster.Builder
extends CopyableBuilder<CacheCluster.Builder,CacheCluster>

Method Summary

Modifier and Type	Method	Description
CacheCluster.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)	This parameter is currently disabled.
CacheCluster.Builder	cacheClusterCreateTime(Date cacheClusterCreateTime)	The date and time when the cache cluster was created.
CacheCluster.Builder	cacheClusterId(String cacheClusterId)	The user-supplied identifier of the cache cluster.
CacheCluster.Builder	cacheClusterStatus(String cacheClusterStatus)	The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.
CacheCluster.Builder	cacheNodes(Collection<CacheNode> cacheNodes)	A list of cache nodes that are members of the cache cluster.
CacheCluster.Builder	cacheNodes(CacheNode... cacheNodes)	A list of cache nodes that are members of the cache cluster.
CacheCluster.Builder	cacheNodeType(String cacheNodeType)	The name of the compute and memory capacity node type for the cache cluster.
CacheCluster.Builder	cacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)
CacheCluster.Builder	cacheSecurityGroups(Collection<CacheSecurityGroupMembership> 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 cache cluster.
CacheCluster.Builder	clientDownloadLandingPage(String clientDownloadLandingPage)	The URL of the web page where you can download the latest ElastiCache client library.
CacheCluster.Builder	configurationEndpoint(Endpoint configurationEndpoint)	Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, 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 or redis) to be used for this cache cluster.
CacheCluster.Builder	engineVersion(String engineVersion)	The version of the cache engine that is used in this cache cluster.
CacheCluster.Builder	notificationConfiguration(NotificationConfiguration notificationConfiguration)
CacheCluster.Builder	numCacheNodes(Integer numCacheNodes)	The number of cache nodes in the cache cluster.
CacheCluster.Builder	pendingModifiedValues(PendingModifiedValues pendingModifiedValues)
CacheCluster.Builder	preferredAvailabilityZone(String preferredAvailabilityZone)	The name of the Availability Zone in which the cache 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	replicationGroupId(String replicationGroupId)	The replication group to which this cache cluster belongs.
CacheCluster.Builder	securityGroups(Collection<SecurityGroupMembership> securityGroups)	A list of VPC Security Groups associated with the cache cluster.
CacheCluster.Builder	securityGroups(SecurityGroupMembership... securityGroups)	A list of VPC Security Groups associated with the cache cluster.
CacheCluster.Builder	snapshotRetentionLimit(Integer snapshotRetentionLimit)	The number of days for which ElastiCache retains automatic cache 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 cache cluster.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

cacheClusterId

CacheCluster.Builder cacheClusterId(String cacheClusterId)

The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.

Parameters:

cacheClusterId - The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache 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, if Automatic Discovery is enabled on the cluster, 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, if Automatic Discovery is enabled on the cluster, 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.

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 cache cluster.

Valid node types are as follows:

• General purpose:

  • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

  • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

• Compute optimized: cache.c1.xlarge

• Memory optimized:

  • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

  • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

• All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

• Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.

• Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

Parameters:

cacheNodeType - The name of the compute and memory capacity node type for the cache cluster.

Valid node types are as follows:

• General purpose:

  • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

  • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

• Compute optimized: cache.c1.xlarge

• Memory optimized:

  • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

  • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

• All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

• Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.

• Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

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 or redis) to be used for this cache cluster.

Parameters:

engine - The name of the cache engine (memcached or redis) to be used for this cache 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 cache cluster.

Parameters:

engineVersion - The version of the cache engine that is used in this cache 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 cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.

Parameters:

cacheClusterStatus - The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.

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 cache cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

Parameters:

numCacheNodes - The number of cache nodes in the cache cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

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

cacheClusterCreateTime

CacheCluster.Builder cacheClusterCreateTime(Date cacheClusterCreateTime)

The date and time when the cache cluster was created.

Parameters:

cacheClusterCreateTime - The date and time when the cache 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)

Parameters:

pendingModifiedValues -

Returns:

Returns a reference to this object so that method calls can be chained together.

notificationConfiguration

CacheCluster.Builder notificationConfiguration(NotificationConfiguration notificationConfiguration)

Parameters:

notificationConfiguration -

Returns:

Returns a reference to this object so that method calls can be chained together.

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.

NOTE: This method appends the values to the existing list (if any). Use #setCacheSecurityGroups(java.util.Collection) or #withCacheSecurityGroups(java.util.Collection) if you want to override the existing values.

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.

cacheParameterGroup

CacheCluster.Builder cacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)

Parameters:

cacheParameterGroup -

Returns:

Returns a reference to this object so that method calls can be chained together.

cacheSubnetGroupName

CacheCluster.Builder cacheSubnetGroupName(String cacheSubnetGroupName)

The name of the cache subnet group associated with the cache cluster.

Parameters:

cacheSubnetGroupName - The name of the cache subnet group associated with the cache 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 cache cluster.

Parameters:

cacheNodes - A list of cache nodes that are members of the cache 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 cache cluster.

NOTE: This method appends the values to the existing list (if any). Use #setCacheNodes(java.util.Collection) or #withCacheNodes(java.util.Collection) if you want to override the existing values.

Parameters:

cacheNodes - A list of cache nodes that are members of the cache cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

autoMinorVersionUpgrade

CacheCluster.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

This parameter is currently disabled.

Parameters:

autoMinorVersionUpgrade - This parameter is currently disabled.

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 cache cluster.

Parameters:

securityGroups - A list of VPC Security Groups associated with the cache 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 cache cluster.

NOTE: This method appends the values to the existing list (if any). Use #setSecurityGroups(java.util.Collection) or #withSecurityGroups(java.util.Collection) if you want to override the existing values.

Parameters:

securityGroups - A list of VPC Security Groups associated with the cache cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

replicationGroupId

CacheCluster.Builder replicationGroupId(String replicationGroupId)

The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.

Parameters:

replicationGroupId - The replication group to which this cache cluster belongs. If this field is empty, the cache 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 cache 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 cache 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.

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 cache cluster.

Example: 05:00-09:00

Parameters:

snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cache cluster.

Example: 05:00-09:00

Returns:

Returns a reference to this object so that method calls can be chained together.