@Generated(value="software.amazon.awssdk:codegen") public final class Snapshot extends Object implements ToCopyableBuilder<Snapshot.Builder,Snapshot>
Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
Modifier and Type | Class and Description |
---|---|
static interface |
Snapshot.Builder |
Modifier and Type | Method and Description |
---|---|
AutomaticFailoverStatus |
automaticFailover()
Indicates the status of Multi-AZ with automatic failover for the source Redis replication group.
|
String |
automaticFailoverAsString()
Indicates the status of Multi-AZ with automatic failover for the source Redis replication group.
|
Boolean |
autoMinorVersionUpgrade()
This parameter is currently disabled.
|
static Snapshot.Builder |
builder() |
Instant |
cacheClusterCreateTime()
The date and time when the source cluster was created.
|
String |
cacheClusterId()
The user-supplied identifier of the source cluster.
|
String |
cacheNodeType()
The name of the compute and memory capacity node type for the source cluster.
|
String |
cacheParameterGroupName()
The cache parameter group that is associated with the source cluster.
|
String |
cacheSubnetGroupName()
The name of the cache subnet group associated with the source cluster.
|
String |
engine()
The name of the cache engine (
memcached or redis ) used by the source cluster. |
String |
engineVersion()
The version of the cache engine version that is used by the source cluster.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<NodeSnapshot> |
nodeSnapshots()
A list of the cache nodes in the source cluster.
|
Integer |
numCacheNodes()
The number of cache nodes in the source cluster.
|
Integer |
numNodeGroups()
The number of node groups (shards) in this snapshot.
|
Integer |
port()
The port number used by each cache nodes in the source cluster.
|
String |
preferredAvailabilityZone()
The name of the Availability Zone in which the source cluster is located.
|
String |
preferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cluster is performed.
|
String |
replicationGroupDescription()
A description of the source replication group.
|
String |
replicationGroupId()
The unique identifier of the source replication group.
|
static Class<? extends Snapshot.Builder> |
serializableBuilderClass() |
String |
snapshotName()
The name of a snapshot.
|
Integer |
snapshotRetentionLimit()
For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
|
String |
snapshotSource()
Indicates whether the snapshot is from an automatic backup (
automated ) or was created manually (
manual ). |
String |
snapshotStatus()
The status of the snapshot.
|
String |
snapshotWindow()
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
|
Snapshot.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
topicArn()
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
|
String |
toString() |
String |
vpcId()
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
|
copy
public 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.
public String replicationGroupId()
The unique identifier of the source replication group.
public String replicationGroupDescription()
A description of the source replication group.
public String cacheClusterId()
The user-supplied identifier of the source cluster.
public String snapshotStatus()
The status of the snapshot. Valid values: creating
| available
| restoring
| copying
| deleting
.
creating
| available
|
restoring
| copying
| deleting
.public String snapshotSource()
Indicates whether the snapshot is from an automatic backup (automated
) or was created manually (
manual
).
automated
) or was created
manually (manual
).public 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:
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.
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.
public String engine()
The name of the cache engine (memcached
or redis
) used by the source cluster.
memcached
or redis
) used by the source cluster.public String engineVersion()
The version of the cache engine version that is used by the source cluster.
public 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 20.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
public String preferredAvailabilityZone()
The name of the Availability Zone in which the source cluster is located.
public Instant cacheClusterCreateTime()
The date and time when the source cluster was created.
public 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
Valid values for ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
public String topicArn()
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
public Integer port()
The port number used by each cache nodes in the source cluster.
public String cacheParameterGroupName()
The cache parameter group that is associated with the source cluster.
public String cacheSubnetGroupName()
The name of the cache subnet group associated with the source cluster.
public String vpcId()
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
public Boolean autoMinorVersionUpgrade()
This parameter is currently disabled.
public 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.
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 String snapshotWindow()
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
public 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.
public AutomaticFailoverStatus automaticFailover()
Indicates the status of Multi-AZ with automatic failover for the source Redis replication group.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
If the service returns an enum value that is not available in the current SDK version, automaticFailover
will return AutomaticFailoverStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from automaticFailoverAsString()
.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
AutomaticFailoverStatus
public String automaticFailoverAsString()
Indicates the status of Multi-AZ with automatic failover for the source Redis replication group.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
If the service returns an enum value that is not available in the current SDK version, automaticFailover
will return AutomaticFailoverStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from automaticFailoverAsString()
.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
AutomaticFailoverStatus
public List<NodeSnapshot> nodeSnapshots()
A list of the cache nodes in the source cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Snapshot.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Snapshot.Builder,Snapshot>
public static Snapshot.Builder builder()
public static Class<? extends Snapshot.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.