@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Snapshot extends Object implements Serializable, Cloneable
Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
Constructor and Description |
---|
Snapshot() |
Modifier and Type | Method and Description |
---|---|
Snapshot |
clone() |
boolean |
equals(Object obj) |
String |
getARN()
The ARN (Amazon Resource Name) of the snapshot.
|
String |
getAutomaticFailover()
Indicates the status of automatic failover for the source Redis replication group.
|
Boolean |
getAutoMinorVersionUpgrade()
This parameter is currently disabled.
|
Date |
getCacheClusterCreateTime()
The date and time when the source cluster was created.
|
String |
getCacheClusterId()
The user-supplied identifier of the source cluster.
|
String |
getCacheNodeType()
The name of the compute and memory capacity node type for the source cluster.
|
String |
getCacheParameterGroupName()
The cache parameter group that is associated with the source cluster.
|
String |
getCacheSubnetGroupName()
The name of the cache subnet group associated with the source cluster.
|
String |
getEngine()
The name of the cache engine (
memcached or redis ) used by the source cluster. |
String |
getEngineVersion()
The version of the cache engine version that is used by the source cluster.
|
String |
getKmsKeyId()
The ID of the KMS key used to encrypt the snapshot.
|
List<NodeSnapshot> |
getNodeSnapshots()
A list of the cache nodes in the source cluster.
|
Integer |
getNumCacheNodes()
The number of cache nodes in the source cluster.
|
Integer |
getNumNodeGroups()
The number of node groups (shards) in this snapshot.
|
Integer |
getPort()
The port number used by each cache nodes in the source cluster.
|
String |
getPreferredAvailabilityZone()
The name of the Availability Zone in which the source cluster is located.
|
String |
getPreferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cluster is performed.
|
String |
getPreferredOutpostArn()
The ARN (Amazon Resource Name) of the preferred outpost.
|
String |
getReplicationGroupDescription()
A description of the source replication group.
|
String |
getReplicationGroupId()
The unique identifier of the source replication group.
|
String |
getSnapshotName()
The name of a snapshot.
|
Integer |
getSnapshotRetentionLimit()
For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
|
String |
getSnapshotSource()
Indicates whether the snapshot is from an automatic backup (
automated ) or was created manually (
manual ). |
String |
getSnapshotStatus()
The status of the snapshot.
|
String |
getSnapshotWindow()
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
|
String |
getTopicArn()
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
|
String |
getVpcId()
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
This parameter is currently disabled.
|
void |
setARN(String aRN)
The ARN (Amazon Resource Name) of the snapshot.
|
void |
setAutomaticFailover(AutomaticFailoverStatus automaticFailover)
Indicates the status of automatic failover for the source Redis replication group.
|
void |
setAutomaticFailover(String automaticFailover)
Indicates the status of automatic failover for the source Redis replication group.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
|
void |
setCacheClusterCreateTime(Date cacheClusterCreateTime)
The date and time when the source cluster was created.
|
void |
setCacheClusterId(String cacheClusterId)
The user-supplied identifier of the source cluster.
|
void |
setCacheNodeType(String cacheNodeType)
The name of the compute and memory capacity node type for the source cluster.
|
void |
setCacheParameterGroupName(String cacheParameterGroupName)
The cache parameter group that is associated with the source cluster.
|
void |
setCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group associated with the source cluster.
|
void |
setEngine(String engine)
The name of the cache engine (
memcached or redis ) used by the source cluster. |
void |
setEngineVersion(String engineVersion)
The version of the cache engine version that is used by the source cluster.
|
void |
setKmsKeyId(String kmsKeyId)
The ID of the KMS key used to encrypt the snapshot.
|
void |
setNodeSnapshots(Collection<NodeSnapshot> nodeSnapshots)
A list of the cache nodes in the source cluster.
|
void |
setNumCacheNodes(Integer numCacheNodes)
The number of cache nodes in the source cluster.
|
void |
setNumNodeGroups(Integer numNodeGroups)
The number of node groups (shards) in this snapshot.
|
void |
setPort(Integer port)
The port number used by each cache nodes in the source cluster.
|
void |
setPreferredAvailabilityZone(String preferredAvailabilityZone)
The name of the Availability Zone in which the source cluster is located.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed.
|
void |
setPreferredOutpostArn(String preferredOutpostArn)
The ARN (Amazon Resource Name) of the preferred outpost.
|
void |
setReplicationGroupDescription(String replicationGroupDescription)
A description of the source replication group.
|
void |
setReplicationGroupId(String replicationGroupId)
The unique identifier of the source replication group.
|
void |
setSnapshotName(String snapshotName)
The name of a snapshot.
|
void |
setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
|
void |
setSnapshotSource(String snapshotSource)
Indicates whether the snapshot is from an automatic backup (
automated ) or was created manually (
manual ). |
void |
setSnapshotStatus(String snapshotStatus)
The status of the snapshot.
|
void |
setSnapshotWindow(String snapshotWindow)
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
|
void |
setTopicArn(String topicArn)
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
|
void |
setVpcId(String vpcId)
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
|
String |
toString()
Returns a string representation of this object.
|
Snapshot |
withARN(String aRN)
The ARN (Amazon Resource Name) of the snapshot.
|
Snapshot |
withAutomaticFailover(AutomaticFailoverStatus automaticFailover)
Indicates the status of automatic failover for the source Redis replication group.
|
Snapshot |
withAutomaticFailover(String automaticFailover)
Indicates the status of automatic failover for the source Redis replication group.
|
Snapshot |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
|
Snapshot |
withCacheClusterCreateTime(Date cacheClusterCreateTime)
The date and time when the source cluster was created.
|
Snapshot |
withCacheClusterId(String cacheClusterId)
The user-supplied identifier of the source cluster.
|
Snapshot |
withCacheNodeType(String cacheNodeType)
The name of the compute and memory capacity node type for the source cluster.
|
Snapshot |
withCacheParameterGroupName(String cacheParameterGroupName)
The cache parameter group that is associated with the source cluster.
|
Snapshot |
withCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group associated with the source cluster.
|
Snapshot |
withEngine(String engine)
The name of the cache engine (
memcached or redis ) used by the source cluster. |
Snapshot |
withEngineVersion(String engineVersion)
The version of the cache engine version that is used by the source cluster.
|
Snapshot |
withKmsKeyId(String kmsKeyId)
The ID of the KMS key used to encrypt the snapshot.
|
Snapshot |
withNodeSnapshots(Collection<NodeSnapshot> nodeSnapshots)
A list of the cache nodes in the source cluster.
|
Snapshot |
withNodeSnapshots(NodeSnapshot... nodeSnapshots)
A list of the cache nodes in the source cluster.
|
Snapshot |
withNumCacheNodes(Integer numCacheNodes)
The number of cache nodes in the source cluster.
|
Snapshot |
withNumNodeGroups(Integer numNodeGroups)
The number of node groups (shards) in this snapshot.
|
Snapshot |
withPort(Integer port)
The port number used by each cache nodes in the source cluster.
|
Snapshot |
withPreferredAvailabilityZone(String preferredAvailabilityZone)
The name of the Availability Zone in which the source cluster is located.
|
Snapshot |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed.
|
Snapshot |
withPreferredOutpostArn(String preferredOutpostArn)
The ARN (Amazon Resource Name) of the preferred outpost.
|
Snapshot |
withReplicationGroupDescription(String replicationGroupDescription)
A description of the source replication group.
|
Snapshot |
withReplicationGroupId(String replicationGroupId)
The unique identifier of the source replication group.
|
Snapshot |
withSnapshotName(String snapshotName)
The name of a snapshot.
|
Snapshot |
withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
|
Snapshot |
withSnapshotSource(String snapshotSource)
Indicates whether the snapshot is from an automatic backup (
automated ) or was created manually (
manual ). |
Snapshot |
withSnapshotStatus(String snapshotStatus)
The status of the snapshot.
|
Snapshot |
withSnapshotWindow(String snapshotWindow)
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
|
Snapshot |
withTopicArn(String topicArn)
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
|
Snapshot |
withVpcId(String vpcId)
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
|
public void setSnapshotName(String snapshotName)
The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
snapshotName
- The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot,
this is the user-provided name.public String getSnapshotName()
The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
public Snapshot withSnapshotName(String snapshotName)
The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
snapshotName
- The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot,
this is the user-provided name.public void setReplicationGroupId(String replicationGroupId)
The unique identifier of the source replication group.
replicationGroupId
- The unique identifier of the source replication group.public String getReplicationGroupId()
The unique identifier of the source replication group.
public Snapshot withReplicationGroupId(String replicationGroupId)
The unique identifier of the source replication group.
replicationGroupId
- The unique identifier of the source replication group.public void setReplicationGroupDescription(String replicationGroupDescription)
A description of the source replication group.
replicationGroupDescription
- A description of the source replication group.public String getReplicationGroupDescription()
A description of the source replication group.
public Snapshot withReplicationGroupDescription(String replicationGroupDescription)
A description of the source replication group.
replicationGroupDescription
- A description of the source replication group.public void setCacheClusterId(String cacheClusterId)
The user-supplied identifier of the source cluster.
cacheClusterId
- The user-supplied identifier of the source cluster.public String getCacheClusterId()
The user-supplied identifier of the source cluster.
public Snapshot withCacheClusterId(String cacheClusterId)
The user-supplied identifier of the source cluster.
cacheClusterId
- The user-supplied identifier of the source cluster.public void setSnapshotStatus(String snapshotStatus)
The status of the snapshot. Valid values: creating
| available
| restoring
| copying
| deleting
.
snapshotStatus
- The status of the snapshot. Valid values: creating
| available
|
restoring
| copying
| deleting
.public String getSnapshotStatus()
The status of the snapshot. Valid values: creating
| available
| restoring
| copying
| deleting
.
creating
| available
|
restoring
| copying
| deleting
.public Snapshot withSnapshotStatus(String snapshotStatus)
The status of the snapshot. Valid values: creating
| available
| restoring
| copying
| deleting
.
snapshotStatus
- The status of the snapshot. Valid values: creating
| available
|
restoring
| copying
| deleting
.public void setSnapshotSource(String snapshotSource)
Indicates whether the snapshot is from an automatic backup (automated
) or was created manually (
manual
).
snapshotSource
- Indicates whether the snapshot is from an automatic backup (automated
) or was created
manually (manual
).public String getSnapshotSource()
Indicates whether the snapshot is from an automatic backup (automated
) or was created manually (
manual
).
automated
) or was created
manually (manual
).public Snapshot withSnapshotSource(String snapshotSource)
Indicates whether the snapshot is from an automatic backup (automated
) or was created manually (
manual
).
snapshotSource
- Indicates whether the snapshot is from an automatic backup (automated
) or was created
manually (manual
).public void setCacheNodeType(String cacheNodeType)
The name of the compute and memory capacity node type for the source 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:
M6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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:
R6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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
and appendfsync
are not supported on Redis
version 2.8.22 and later.
cacheNodeType
- The name of the compute and memory capacity node type for the source 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:
M6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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:
R6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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
and appendfsync
are not supported on
Redis version 2.8.22 and later.
public String getCacheNodeType()
The name of the compute and memory capacity node type for the source 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:
M6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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:
R6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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
and appendfsync
are not supported on Redis
version 2.8.22 and later.
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:
M6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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:
R6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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
and appendfsync
are not supported on
Redis version 2.8.22 and later.
public Snapshot withCacheNodeType(String cacheNodeType)
The name of the compute and memory capacity node type for the source 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:
M6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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:
R6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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
and appendfsync
are not supported on Redis
version 2.8.22 and later.
cacheNodeType
- The name of the compute and memory capacity node type for the source 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:
M6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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:
R6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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
and appendfsync
are not supported on
Redis version 2.8.22 and later.
public void setEngine(String engine)
The name of the cache engine (memcached
or redis
) used by the source cluster.
engine
- The name of the cache engine (memcached
or redis
) used by the source cluster.public String getEngine()
The name of the cache engine (memcached
or redis
) used by the source cluster.
memcached
or redis
) used by the source cluster.public Snapshot withEngine(String engine)
The name of the cache engine (memcached
or redis
) used by the source cluster.
engine
- The name of the cache engine (memcached
or redis
) used by the source cluster.public void setEngineVersion(String engineVersion)
The version of the cache engine version that is used by the source cluster.
engineVersion
- The version of the cache engine version that is used by the source cluster.public String getEngineVersion()
The version of the cache engine version that is used by the source cluster.
public Snapshot withEngineVersion(String engineVersion)
The version of the cache engine version that is used by the source cluster.
engineVersion
- The version of the cache engine version that is used by the source cluster.public void setNumCacheNodes(Integer numCacheNodes)
The number of cache nodes in the source cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
numCacheNodes
- The number of cache nodes in the source cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
public Integer getNumCacheNodes()
The number of cache nodes in the source cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
public Snapshot withNumCacheNodes(Integer numCacheNodes)
The number of cache nodes in the source cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
numCacheNodes
- The number of cache nodes in the source cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
public void setPreferredAvailabilityZone(String preferredAvailabilityZone)
The name of the Availability Zone in which the source cluster is located.
preferredAvailabilityZone
- The name of the Availability Zone in which the source cluster is located.public String getPreferredAvailabilityZone()
The name of the Availability Zone in which the source cluster is located.
public Snapshot withPreferredAvailabilityZone(String preferredAvailabilityZone)
The name of the Availability Zone in which the source cluster is located.
preferredAvailabilityZone
- The name of the Availability Zone in which the source cluster is located.public void setPreferredOutpostArn(String preferredOutpostArn)
The ARN (Amazon Resource Name) of the preferred outpost.
preferredOutpostArn
- The ARN (Amazon Resource Name) of the preferred outpost.public String getPreferredOutpostArn()
The ARN (Amazon Resource Name) of the preferred outpost.
public Snapshot withPreferredOutpostArn(String preferredOutpostArn)
The ARN (Amazon Resource Name) of the preferred outpost.
preferredOutpostArn
- The ARN (Amazon Resource Name) of the preferred outpost.public void setCacheClusterCreateTime(Date cacheClusterCreateTime)
The date and time when the source cluster was created.
cacheClusterCreateTime
- The date and time when the source cluster was created.public Date getCacheClusterCreateTime()
The date and time when the source cluster was created.
public Snapshot withCacheClusterCreateTime(Date cacheClusterCreateTime)
The date and time when the source cluster was created.
cacheClusterCreateTime
- The date and time when the source cluster was created.public void setPreferredMaintenanceWindow(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
public String getPreferredMaintenanceWindow()
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
Valid values for ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
public Snapshot withPreferredMaintenanceWindow(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
public void setTopicArn(String topicArn)
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
topicArn
- The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.public String getTopicArn()
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
public Snapshot withTopicArn(String topicArn)
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
topicArn
- The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.public void setPort(Integer port)
The port number used by each cache nodes in the source cluster.
port
- The port number used by each cache nodes in the source cluster.public Integer getPort()
The port number used by each cache nodes in the source cluster.
public Snapshot withPort(Integer port)
The port number used by each cache nodes in the source cluster.
port
- The port number used by each cache nodes in the source cluster.public void setCacheParameterGroupName(String cacheParameterGroupName)
The cache parameter group that is associated with the source cluster.
cacheParameterGroupName
- The cache parameter group that is associated with the source cluster.public String getCacheParameterGroupName()
The cache parameter group that is associated with the source cluster.
public Snapshot withCacheParameterGroupName(String cacheParameterGroupName)
The cache parameter group that is associated with the source cluster.
cacheParameterGroupName
- The cache parameter group that is associated with the source cluster.public void setCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group associated with the source cluster.
cacheSubnetGroupName
- The name of the cache subnet group associated with the source cluster.public String getCacheSubnetGroupName()
The name of the cache subnet group associated with the source cluster.
public Snapshot withCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group associated with the source cluster.
cacheSubnetGroupName
- The name of the cache subnet group associated with the source cluster.public void setVpcId(String vpcId)
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
vpcId
- The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.public String getVpcId()
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
public Snapshot withVpcId(String vpcId)
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
vpcId
- The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
autoMinorVersionUpgrade
- This parameter is currently disabled.public Boolean getAutoMinorVersionUpgrade()
This parameter is currently disabled.
public Snapshot withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
autoMinorVersionUpgrade
- This parameter is currently disabled.public Boolean isAutoMinorVersionUpgrade()
This parameter is currently disabled.
public void setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit
for the source cluster when the
snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted
using the DeleteSnapshot
operation.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
snapshotRetentionLimit
- For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting
it.
For manual snapshots, this field reflects the SnapshotRetentionLimit
for the source cluster
when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can
only be deleted using the DeleteSnapshot
operation.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
public Integer getSnapshotRetentionLimit()
For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit
for the source cluster when the
snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted
using the DeleteSnapshot
operation.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
For manual snapshots, this field reflects the SnapshotRetentionLimit
for the source cluster
when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can
only be deleted using the DeleteSnapshot
operation.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
public Snapshot withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit
for the source cluster when the
snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted
using the DeleteSnapshot
operation.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
snapshotRetentionLimit
- For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting
it.
For manual snapshots, this field reflects the SnapshotRetentionLimit
for the source cluster
when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can
only be deleted using the DeleteSnapshot
operation.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
public void setSnapshotWindow(String snapshotWindow)
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
snapshotWindow
- The daily time range during which ElastiCache takes daily snapshots of the source cluster.public String getSnapshotWindow()
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
public Snapshot withSnapshotWindow(String snapshotWindow)
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
snapshotWindow
- The daily time range during which ElastiCache takes daily snapshots of the source cluster.public void setNumNodeGroups(Integer numNodeGroups)
The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.
numNodeGroups
- The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node
groups (shards) in the snapshot and in the restored replication group must be the same.public Integer getNumNodeGroups()
The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.
public Snapshot withNumNodeGroups(Integer numNodeGroups)
The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.
numNodeGroups
- The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node
groups (shards) in the snapshot and in the restored replication group must be the same.public void setAutomaticFailover(String automaticFailover)
Indicates the status of automatic failover for the source Redis replication group.
automaticFailover
- Indicates the status of automatic failover for the source Redis replication group.AutomaticFailoverStatus
public String getAutomaticFailover()
Indicates the status of automatic failover for the source Redis replication group.
AutomaticFailoverStatus
public Snapshot withAutomaticFailover(String automaticFailover)
Indicates the status of automatic failover for the source Redis replication group.
automaticFailover
- Indicates the status of automatic failover for the source Redis replication group.AutomaticFailoverStatus
public void setAutomaticFailover(AutomaticFailoverStatus automaticFailover)
Indicates the status of automatic failover for the source Redis replication group.
automaticFailover
- Indicates the status of automatic failover for the source Redis replication group.AutomaticFailoverStatus
public Snapshot withAutomaticFailover(AutomaticFailoverStatus automaticFailover)
Indicates the status of automatic failover for the source Redis replication group.
automaticFailover
- Indicates the status of automatic failover for the source Redis replication group.AutomaticFailoverStatus
public List<NodeSnapshot> getNodeSnapshots()
A list of the cache nodes in the source cluster.
public void setNodeSnapshots(Collection<NodeSnapshot> nodeSnapshots)
A list of the cache nodes in the source cluster.
nodeSnapshots
- A list of the cache nodes in the source cluster.public Snapshot withNodeSnapshots(NodeSnapshot... nodeSnapshots)
A list of the cache nodes in the source cluster.
NOTE: This method appends the values to the existing list (if any). Use
setNodeSnapshots(java.util.Collection)
or withNodeSnapshots(java.util.Collection)
if you want
to override the existing values.
nodeSnapshots
- A list of the cache nodes in the source cluster.public Snapshot withNodeSnapshots(Collection<NodeSnapshot> nodeSnapshots)
A list of the cache nodes in the source cluster.
nodeSnapshots
- A list of the cache nodes in the source cluster.public void setKmsKeyId(String kmsKeyId)
The ID of the KMS key used to encrypt the snapshot.
kmsKeyId
- The ID of the KMS key used to encrypt the snapshot.public String getKmsKeyId()
The ID of the KMS key used to encrypt the snapshot.
public Snapshot withKmsKeyId(String kmsKeyId)
The ID of the KMS key used to encrypt the snapshot.
kmsKeyId
- The ID of the KMS key used to encrypt the snapshot.public void setARN(String aRN)
The ARN (Amazon Resource Name) of the snapshot.
aRN
- The ARN (Amazon Resource Name) of the snapshot.public String getARN()
The ARN (Amazon Resource Name) of the snapshot.
public Snapshot withARN(String aRN)
The ARN (Amazon Resource Name) of the snapshot.
aRN
- The ARN (Amazon Resource Name) of the snapshot.public String toString()
toString
in class Object
Object.toString()
Copyright © 2021. All rights reserved.