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

Class Snapshot

java.lang.Object

software.amazon.awssdk.services.elasticache.model.Snapshot

All Implemented Interfaces:

ToCopyableBuilder<Snapshot.Builder,Snapshot>

@Generated("software.amazon.awssdk:codegen")
public class Snapshot
extends Object
implements ToCopyableBuilder<Snapshot.Builder,Snapshot>

Represents a copy of an entire Redis cache cluster as of the time when the snapshot was taken.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Snapshot.Builder

Method Summary

Modifier and Type	Method	Description
String	automaticFailover()	Indicates the status of Multi-AZ for the source replication group.
Boolean	autoMinorVersionUpgrade()	This parameter is currently disabled.
static Snapshot.Builder	builder()
Date	cacheClusterCreateTime()	The date and time when the source cache cluster was created.
String	cacheClusterId()	The user-supplied identifier of the source cache cluster.
String	cacheNodeType()	The name of the compute and memory capacity node type for the source cache cluster.
String	cacheParameterGroupName()	The cache parameter group that is associated with the source cache cluster.
String	cacheSubnetGroupName()	The name of the cache subnet group associated with the source cache cluster.
String	engine()	The name of the cache engine (memcached or redis) used by the source cache cluster.
String	engineVersion()	The version of the cache engine version that is used by the source cache cluster.
boolean	equals(Object obj)
int	hashCode()
List<NodeSnapshot>	nodeSnapshots()	A list of the cache nodes in the source cache cluster.
Integer	numCacheNodes()	The number of cache nodes in the source cache 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 cache cluster.
String	preferredAvailabilityZone()	The name of the Availability Zone in which the source cache 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 cache 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 cache cluster for publishing notifications.
String	toString()
String	vpcId()	The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

snapshotName

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.

Returns:

The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

replicationGroupId

public String replicationGroupId()

The unique identifier of the source replication group.

Returns:

The unique identifier of the source replication group.

replicationGroupDescription

public String replicationGroupDescription()

A description of the source replication group.

Returns:

A description of the source replication group.

cacheClusterId

public String cacheClusterId()

The user-supplied identifier of the source cache cluster.

Returns:

The user-supplied identifier of the source cache cluster.

snapshotStatus

public String snapshotStatus()

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

Returns:

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

snapshotSource

public String snapshotSource()

Indicates whether the snapshot is from an automatic backup (automated) or was created manually ( manual).

Returns:

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

cacheNodeType

public String cacheNodeType()

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

Valid node types are as follows:

• General purpose:

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

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

• Compute optimized: cache.c1.xlarge

• Memory optimized:

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

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

Notes:

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

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

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

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

Returns:

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

Valid node types are as follows:

• General purpose:

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

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

• Compute optimized: cache.c1.xlarge

• Memory optimized:

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

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

Notes:

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

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

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

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

engine

public String engine()

The name of the cache engine (memcached or redis) used by the source cache cluster.

Returns:

The name of the cache engine (memcached or redis) used by the source cache cluster.

engineVersion

public String engineVersion()

The version of the cache engine version that is used by the source cache cluster.

Returns:

The version of the cache engine version that is used by the source cache cluster.

numCacheNodes

public Integer 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.

Returns:

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.

preferredAvailabilityZone

public String preferredAvailabilityZone()

The name of the Availability Zone in which the source cache cluster is located.

Returns:

The name of the Availability Zone in which the source cache cluster is located.

cacheClusterCreateTime

public Date cacheClusterCreateTime()

The date and time when the source cache cluster was created.

Returns:

The date and time when the source cache cluster was created.

preferredMaintenanceWindow

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

Returns:

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

topicArn

public String topicArn()

The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.

Returns:

The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.

port

public Integer port()

The port number used by each cache nodes in the source cache cluster.

Returns:

The port number used by each cache nodes in the source cache cluster.

cacheParameterGroupName

public String cacheParameterGroupName()

The cache parameter group that is associated with the source cache cluster.

Returns:

The cache parameter group that is associated with the source cache cluster.

cacheSubnetGroupName

public String cacheSubnetGroupName()

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

Returns:

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

vpcId

public String vpcId()

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.

Returns:

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.

autoMinorVersionUpgrade

public Boolean autoMinorVersionUpgrade()

This parameter is currently disabled.

Returns:

This parameter is currently disabled.

snapshotRetentionLimit

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

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Returns:

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

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

snapshotWindow

public String snapshotWindow()

The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.

Returns:

The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.

numNodeGroups

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.

Returns:

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.

automaticFailover

public String automaticFailover()

Indicates the status of Multi-AZ for the source replication group.

ElastiCache Multi-AZ replication groups are not supported 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.

Returns:

Indicates the status of Multi-AZ for the source replication group.

ElastiCache Multi-AZ replication groups are not supported 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.

See Also:

AutomaticFailoverStatus

nodeSnapshots

public List<NodeSnapshot> nodeSnapshots()

A list of the cache nodes in the source cache cluster.

Returns:

A list of the cache nodes in the source cache cluster.

toBuilder

public Snapshot.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Snapshot.Builder,Snapshot>

Returns:

a builder for type T

builder

public static Snapshot.Builder builder()

serializableBuilderClass

public static Class<? extends Snapshot.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object