public static interface CacheCluster.Builder extends CopyableBuilder<CacheCluster.Builder,CacheCluster>
Modifier and Type | Method and Description |
---|---|
CacheCluster.Builder |
atRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
A flag that enables encryption at-rest when set to
true . |
CacheCluster.Builder |
authTokenEnabled(Boolean authTokenEnabled)
A flag that enables using an
AuthToken (password) when issuing Redis commands. |
CacheCluster.Builder |
autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
|
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 , or snapshotting . |
CacheCluster.Builder |
cacheNodes(CacheNode... cacheNodes)
A list of cache nodes that are members of the cluster.
|
CacheCluster.Builder |
cacheNodes(Collection<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.
|
CacheCluster.Builder |
cacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)
Status of the cache parameter group.
|
default CacheCluster.Builder |
cacheParameterGroup(Consumer<CacheParameterGroupStatus.Builder> cacheParameterGroup)
Status of the cache parameter group.
|
CacheCluster.Builder |
cacheSecurityGroups(CacheSecurityGroupMembership... cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.
|
CacheCluster.Builder |
cacheSecurityGroups(Collection<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, if Automatic Discovery is enabled on the cluster, 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, 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 cluster. |
CacheCluster.Builder |
engineVersion(String engineVersion)
The version of the cache engine that is used in this cluster.
|
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 |
replicationGroupId(String replicationGroupId)
The replication group to which this cluster belongs.
|
CacheCluster.Builder |
securityGroups(Collection<SecurityGroupMembership> 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 to
true . |
copy
apply, build
CacheCluster.Builder cacheClusterId(String cacheClusterId)
The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
cacheClusterId
- The user-supplied identifier of the cluster. This identifier is a unique key that identifies a
cluster.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
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
default CacheCluster.Builder configurationEndpoint(Consumer<Endpoint.Builder> 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
Endpoint.Builder
avoiding the need to create
one manually via Endpoint.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result is
passed to configurationEndpoint(Endpoint)
.configurationEndpoint
- a consumer that will call methods on Endpoint.Builder
configurationEndpoint(Endpoint)
CacheCluster.Builder clientDownloadLandingPage(String clientDownloadLandingPage)
The URL of the web page where you can download the latest ElastiCache client library.
clientDownloadLandingPage
- The URL of the web page where you can download the latest ElastiCache client library.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:
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
,
cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
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
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R3 node types: cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 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.
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:
T2 node types: cache.t2.micro
, cache.t2.small
,
cache.t2.medium
M3 node types: cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
,
cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
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
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R3 node types: cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 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.
CacheCluster.Builder engine(String engine)
The name of the cache engine (memcached
or redis
) to be used for this cluster.
engine
- The name of the cache engine (memcached
or redis
) to be used for this
cluster.CacheCluster.Builder engineVersion(String engineVersion)
The version of the cache engine that is used in this cluster.
engineVersion
- The version of the cache engine that is used in this 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
, or snapshotting
.
cacheClusterStatus
- The current state of this cluster, one of the following values: available
,
creating
, deleted
, deleting
, incompatible-network
,
modifying
, rebooting cluster nodes
, restore-failed
, or
snapshotting
.CacheCluster.Builder numCacheNodes(Integer numCacheNodes)
The number of cache nodes in the cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
numCacheNodes
- The number of cache nodes in the cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
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.
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 cacheClusterCreateTime(Instant cacheClusterCreateTime)
The date and time when the cluster was created.
cacheClusterCreateTime
- The date and time when the cluster was created.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
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
CacheCluster.Builder pendingModifiedValues(PendingModifiedValues pendingModifiedValues)
pendingModifiedValues
- The new value for the PendingModifiedValues property for this object.default CacheCluster.Builder pendingModifiedValues(Consumer<PendingModifiedValues.Builder> pendingModifiedValues)
PendingModifiedValues.Builder
avoiding the need
to create one manually via PendingModifiedValues.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to pendingModifiedValues(PendingModifiedValues)
.pendingModifiedValues
- a consumer that will call methods on PendingModifiedValues.Builder
pendingModifiedValues(PendingModifiedValues)
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).
notificationConfiguration
- Describes a notification topic and its status. Notification topics are used for publishing ElastiCache
events to subscribers using Amazon Simple Notification Service (SNS).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 that creates an instance of theNotificationConfiguration.Builder
avoiding the
need to create one manually via NotificationConfiguration.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately
and its result is passed to notificationConfiguration(NotificationConfiguration)
.notificationConfiguration
- a consumer that will call methods on NotificationConfiguration.Builder
notificationConfiguration(NotificationConfiguration)
CacheCluster.Builder cacheSecurityGroups(Collection<CacheSecurityGroupMembership> cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.
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.
cacheSecurityGroups
- A list of cache security group elements, composed of name and status sub-elements.CacheCluster.Builder cacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)
Status of the cache parameter group.
cacheParameterGroup
- Status of the cache parameter group.default CacheCluster.Builder cacheParameterGroup(Consumer<CacheParameterGroupStatus.Builder> cacheParameterGroup)
Status of the cache parameter group.
This is a convenience that creates an instance of theCacheParameterGroupStatus.Builder
avoiding the
need to create one manually via CacheParameterGroupStatus.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately
and its result is passed to cacheParameterGroup(CacheParameterGroupStatus)
.cacheParameterGroup
- a consumer that will call methods on CacheParameterGroupStatus.Builder
cacheParameterGroup(CacheParameterGroupStatus)
CacheCluster.Builder cacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group associated with the cluster.
cacheSubnetGroupName
- The name of the cache subnet group associated with the cluster.CacheCluster.Builder cacheNodes(Collection<CacheNode> cacheNodes)
A list of cache nodes that are members of the cluster.
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.
cacheNodes
- A list of cache nodes that are members of the cluster.CacheCluster.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
autoMinorVersionUpgrade
- This parameter is currently disabled.CacheCluster.Builder securityGroups(Collection<SecurityGroupMembership> securityGroups)
A list of VPC Security Groups associated with the cluster.
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.
securityGroups
- A list of VPC Security Groups associated with the cluster.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.
replicationGroupId
- The replication group to which this cluster belongs. If this field is empty, the cluster is not
associated with any replication group.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.
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.
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
snapshotWindow
- The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your
cluster.
Example: 05:00-09:00
CacheCluster.Builder authTokenEnabled(Boolean authTokenEnabled)
A flag that enables using an AuthToken
(password) when issuing Redis commands.
Default: false
authTokenEnabled
- A flag that enables using an AuthToken
(password) when issuing Redis commands.
Default: false
CacheCluster.Builder transitEncryptionEnabled(Boolean transitEncryptionEnabled)
A flag that enables in-transit encryption when set to true
.
You cannot modify the value of TransitEncryptionEnabled
after the cluster is created. To enable
in-transit encryption on a cluster you must set TransitEncryptionEnabled
to true
when you create a cluster.
Default: false
transitEncryptionEnabled
- A flag that enables in-transit encryption when set to true
.
You cannot modify the value of TransitEncryptionEnabled
after the cluster is created. To
enable in-transit encryption on a cluster you must set TransitEncryptionEnabled
to
true
when you create a cluster.
Default: false
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 set AtRestEncryptionEnabled
to true
when
you create a cluster.
Default: false
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 set AtRestEncryptionEnabled
to
true
when you create a cluster.
Default: false
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.