public class Snapshot extends Object implements Serializable, Cloneable
Represents a copy of an entire cache 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) |
Boolean |
getAutoMinorVersionUpgrade()
This parameter is currently disabled.
|
Date |
getCacheClusterCreateTime()
The date and time when the source cache cluster was created.
|
String |
getCacheClusterId()
The user-supplied identifier of the source cache cluster.
|
String |
getCacheNodeType()
The name of the compute and memory capacity node type for the source
cache cluster.
|
String |
getCacheParameterGroupName()
The cache parameter group that is associated with the source cache
cluster.
|
String |
getCacheSubnetGroupName()
The name of the cache subnet group associated with the source cache
cluster.
|
String |
getEngine()
The name of the cache engine (memcached or redis) used
by the source cache cluster.
|
String |
getEngineVersion()
The version of the cache engine version that is used by the source
cache cluster.
|
List<NodeSnapshot> |
getNodeSnapshots()
A list of the cache nodes in the source cache cluster.
|
Integer |
getNumCacheNodes()
The number of cache nodes in the source cache cluster.
|
Integer |
getPort()
The port number used by each cache nodes in the source cache cluster.
|
String |
getPreferredAvailabilityZone()
The name of the Availability Zone in which the source cache cluster is
located.
|
String |
getPreferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cache
cluster is performed.
|
String |
getSnapshotName()
The name of a snapshot.
|
Integer |
getSnapshotRetentionLimit()
For an automatic snapshot, the number of days for which ElastiCache
will retain 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 cache cluster.
|
String |
getTopicArn()
The Amazon Resource Name (ARN) for the topic used by the source cache
cluster for publishing notifications.
|
String |
getVpcId()
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache
subnet group for the source cache cluster.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
This parameter is currently disabled.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
|
void |
setCacheClusterCreateTime(Date cacheClusterCreateTime)
The date and time when the source cache cluster was created.
|
void |
setCacheClusterId(String cacheClusterId)
The user-supplied identifier of the source cache cluster.
|
void |
setCacheNodeType(String cacheNodeType)
The name of the compute and memory capacity node type for the source
cache cluster.
|
void |
setCacheParameterGroupName(String cacheParameterGroupName)
The cache parameter group that is associated with the source cache
cluster.
|
void |
setCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group associated with the source cache
cluster.
|
void |
setEngine(String engine)
The name of the cache engine (memcached or redis) used
by the source cache cluster.
|
void |
setEngineVersion(String engineVersion)
The version of the cache engine version that is used by the source
cache cluster.
|
void |
setNodeSnapshots(Collection<NodeSnapshot> nodeSnapshots)
A list of the cache nodes in the source cache cluster.
|
void |
setNumCacheNodes(Integer numCacheNodes)
The number of cache nodes in the source cache cluster.
|
void |
setPort(Integer port)
The port number used by each cache nodes in the source cache cluster.
|
void |
setPreferredAvailabilityZone(String preferredAvailabilityZone)
The name of the Availability Zone in which the source cache cluster is
located.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cache
cluster is performed.
|
void |
setSnapshotName(String snapshotName)
The name of a snapshot.
|
void |
setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
For an automatic snapshot, the number of days for which ElastiCache
will retain 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 cache cluster.
|
void |
setTopicArn(String topicArn)
The Amazon Resource Name (ARN) for the topic used by the source cache
cluster for publishing notifications.
|
void |
setVpcId(String vpcId)
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache
subnet group for the source cache cluster.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
Snapshot |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
|
Snapshot |
withCacheClusterCreateTime(Date cacheClusterCreateTime)
The date and time when the source cache cluster was created.
|
Snapshot |
withCacheClusterId(String cacheClusterId)
The user-supplied identifier of the source cache cluster.
|
Snapshot |
withCacheNodeType(String cacheNodeType)
The name of the compute and memory capacity node type for the source
cache cluster.
|
Snapshot |
withCacheParameterGroupName(String cacheParameterGroupName)
The cache parameter group that is associated with the source cache
cluster.
|
Snapshot |
withCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group associated with the source cache
cluster.
|
Snapshot |
withEngine(String engine)
The name of the cache engine (memcached or redis) used
by the source cache cluster.
|
Snapshot |
withEngineVersion(String engineVersion)
The version of the cache engine version that is used by the source
cache cluster.
|
Snapshot |
withNodeSnapshots(Collection<NodeSnapshot> nodeSnapshots)
A list of the cache nodes in the source cache cluster.
|
Snapshot |
withNodeSnapshots(NodeSnapshot... nodeSnapshots)
A list of the cache nodes in the source cache cluster.
|
Snapshot |
withNumCacheNodes(Integer numCacheNodes)
The number of cache nodes in the source cache cluster.
|
Snapshot |
withPort(Integer port)
The port number used by each cache nodes in the source cache cluster.
|
Snapshot |
withPreferredAvailabilityZone(String preferredAvailabilityZone)
The name of the Availability Zone in which the source cache cluster is
located.
|
Snapshot |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cache
cluster is performed.
|
Snapshot |
withSnapshotName(String snapshotName)
The name of a snapshot.
|
Snapshot |
withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
For an automatic snapshot, the number of days for which ElastiCache
will retain 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 cache cluster.
|
Snapshot |
withTopicArn(String topicArn)
The Amazon Resource Name (ARN) for the topic used by the source cache
cluster for publishing notifications.
|
Snapshot |
withVpcId(String vpcId)
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache
subnet group for the source cache cluster.
|
public String getSnapshotName()
public void setSnapshotName(String snapshotName)
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 Snapshot withSnapshotName(String snapshotName)
Returns a reference to this object so that method calls can be chained together.
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 getCacheClusterId()
public void setCacheClusterId(String cacheClusterId)
cacheClusterId
- The user-supplied identifier of the source cache cluster.public Snapshot withCacheClusterId(String cacheClusterId)
Returns a reference to this object so that method calls can be chained together.
cacheClusterId
- The user-supplied identifier of the source cache cluster.public String getSnapshotStatus()
creating
|
available
| restoring
| copying
| deleting
.creating
|
available
| restoring
| copying
| deleting
.public void setSnapshotStatus(String snapshotStatus)
creating
|
available
| restoring
| copying
| deleting
.snapshotStatus
- The status of the snapshot. Valid values: creating
|
available
| restoring
| copying
| deleting
.public Snapshot withSnapshotStatus(String snapshotStatus)
creating
|
available
| restoring
| copying
| deleting
.
Returns a reference to this object so that method calls can be chained together.
snapshotStatus
- The status of the snapshot. Valid values: creating
|
available
| restoring
| copying
| deleting
.public String getSnapshotSource()
automated
) or was created manually
(manual
).automated
) or was created manually
(manual
).public void setSnapshotSource(String snapshotSource)
automated
) or was created manually
(manual
).snapshotSource
- Indicates whether the snapshot is from an automatic backup
(automated
) or was created manually
(manual
).public Snapshot withSnapshotSource(String snapshotSource)
automated
) or was created manually
(manual
).
Returns a reference to this object so that method calls can be chained together.
snapshotSource
- Indicates whether the snapshot is from an automatic backup
(automated
) or was created manually
(manual
).public String getCacheNodeType()
Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
cache.c1.xlarge
cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
,
cache.r3.8xlarge
cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
cache.c1.xlarge
cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
,
cache.r3.8xlarge
cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
public void setCacheNodeType(String cacheNodeType)
Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
cache.c1.xlarge
cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
,
cache.r3.8xlarge
cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and 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 source
cache cluster. Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
cache.c1.xlarge
cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
,
cache.r3.8xlarge
cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
public Snapshot withCacheNodeType(String cacheNodeType)
Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
cache.c1.xlarge
cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
,
cache.r3.8xlarge
cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
Returns a reference to this object so that method calls can be chained together.
cacheNodeType
- The name of the compute and memory capacity node type for the source
cache cluster. Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
cache.c1.xlarge
cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
,
cache.r3.8xlarge
cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
public String getEngine()
public void setEngine(String engine)
engine
- The name of the cache engine (memcached or redis) used
by the source cache cluster.public Snapshot withEngine(String engine)
Returns a reference to this object so that method calls can be chained together.
engine
- The name of the cache engine (memcached or redis) used
by the source cache cluster.public String getEngineVersion()
public void setEngineVersion(String engineVersion)
engineVersion
- The version of the cache engine version that is used by the source
cache cluster.public Snapshot withEngineVersion(String engineVersion)
Returns a reference to this object so that method calls can be chained together.
engineVersion
- The version of the cache engine version that is used by the source
cache cluster.public Integer getNumCacheNodes()
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 void setNumCacheNodes(Integer numCacheNodes)
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 source cache cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
public Snapshot withNumCacheNodes(Integer numCacheNodes)
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
Returns a reference to this object so that method calls can be chained together.
numCacheNodes
- The number of cache nodes in the source cache cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
public String getPreferredAvailabilityZone()
public void setPreferredAvailabilityZone(String preferredAvailabilityZone)
preferredAvailabilityZone
- The name of the Availability Zone in which the source cache cluster is
located.public Snapshot withPreferredAvailabilityZone(String preferredAvailabilityZone)
Returns a reference to this object so that method calls can be chained together.
preferredAvailabilityZone
- The name of the Availability Zone in which the source cache cluster is
located.public Date getCacheClusterCreateTime()
public void setCacheClusterCreateTime(Date cacheClusterCreateTime)
cacheClusterCreateTime
- The date and time when the source cache cluster was created.public Snapshot withCacheClusterCreateTime(Date cacheClusterCreateTime)
Returns a reference to this object so that method calls can be chained together.
cacheClusterCreateTime
- The date and time when the source cache cluster was created.public String getPreferredMaintenanceWindow()
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
preferredMaintenanceWindow
- Specifies the weekly time range during which maintenance on the cache
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:05:00-sun:09:00
public Snapshot withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
Returns a reference to this object so that method calls can be chained together.
preferredMaintenanceWindow
- Specifies the weekly time range during which maintenance on the cache
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:05:00-sun:09:00
public String getTopicArn()
public void setTopicArn(String topicArn)
topicArn
- The Amazon Resource Name (ARN) for the topic used by the source cache
cluster for publishing notifications.public Snapshot withTopicArn(String topicArn)
Returns a reference to this object so that method calls can be chained together.
topicArn
- The Amazon Resource Name (ARN) for the topic used by the source cache
cluster for publishing notifications.public Integer getPort()
public void setPort(Integer port)
port
- The port number used by each cache nodes in the source cache cluster.public Snapshot withPort(Integer port)
Returns a reference to this object so that method calls can be chained together.
port
- The port number used by each cache nodes in the source cache cluster.public String getCacheParameterGroupName()
public void setCacheParameterGroupName(String cacheParameterGroupName)
cacheParameterGroupName
- The cache parameter group that is associated with the source cache
cluster.public Snapshot withCacheParameterGroupName(String cacheParameterGroupName)
Returns a reference to this object so that method calls can be chained together.
cacheParameterGroupName
- The cache parameter group that is associated with the source cache
cluster.public String getCacheSubnetGroupName()
public void setCacheSubnetGroupName(String cacheSubnetGroupName)
cacheSubnetGroupName
- The name of the cache subnet group associated with the source cache
cluster.public Snapshot withCacheSubnetGroupName(String cacheSubnetGroupName)
Returns a reference to this object so that method calls can be chained together.
cacheSubnetGroupName
- The name of the cache subnet group associated with the source cache
cluster.public String getVpcId()
public void setVpcId(String vpcId)
vpcId
- The Amazon Virtual Private Cloud identifier (VPC ID) of the cache
subnet group for the source cache cluster.public Snapshot withVpcId(String vpcId)
Returns a reference to this object so that method calls can be chained together.
vpcId
- The Amazon Virtual Private Cloud identifier (VPC ID) of the cache
subnet group for the source cache cluster.public Boolean isAutoMinorVersionUpgrade()
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
autoMinorVersionUpgrade
- This parameter is currently disabled.public Snapshot withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Returns a reference to this object so that method calls can be chained together.
autoMinorVersionUpgrade
- This parameter is currently disabled.public Boolean getAutoMinorVersionUpgrade()
public Integer getSnapshotRetentionLimit()
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
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 cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
Important
If the value
of SnapshotRetentionLimit is set to zero (0), backups are turned off.
public void setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
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
will retain the snapshot before deleting it. For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
Important
If the value
of SnapshotRetentionLimit is set to zero (0), backups are turned off.
public Snapshot withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
Important
If the value
of SnapshotRetentionLimit is set to zero (0), backups are turned off.
Returns a reference to this object so that method calls can be chained together.
snapshotRetentionLimit
- For an automatic snapshot, the number of days for which ElastiCache
will retain the snapshot before deleting it. For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
Important
If the value
of SnapshotRetentionLimit is set to zero (0), backups are turned off.
public String getSnapshotWindow()
public void setSnapshotWindow(String snapshotWindow)
snapshotWindow
- The daily time range during which ElastiCache takes daily snapshots of
the source cache cluster.public Snapshot withSnapshotWindow(String snapshotWindow)
Returns a reference to this object so that method calls can be chained together.
snapshotWindow
- The daily time range during which ElastiCache takes daily snapshots of
the source cache cluster.public List<NodeSnapshot> getNodeSnapshots()
public void setNodeSnapshots(Collection<NodeSnapshot> nodeSnapshots)
nodeSnapshots
- A list of the cache nodes in the source cache cluster.public Snapshot withNodeSnapshots(NodeSnapshot... nodeSnapshots)
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.
Returns a reference to this object so that method calls can be chained together.
nodeSnapshots
- A list of the cache nodes in the source cache cluster.public Snapshot withNodeSnapshots(Collection<NodeSnapshot> nodeSnapshots)
Returns a reference to this object so that method calls can be chained together.
nodeSnapshots
- A list of the cache nodes in the source cache cluster.public String toString()
toString
in class Object
Object.toString()
Copyright © 2016. All rights reserved.