Snapshot

class Snapshot

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

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String?

The ARN (Amazon Resource Name) of the snapshot.

Link copied to clipboard

Indicates the status of automatic failover for the source Valkey or Redis OSS replication group.

Link copied to clipboard

If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

Link copied to clipboard

The date and time when the source cluster was created.

Link copied to clipboard

The user-supplied identifier of the source cluster.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The ID of the KMS key used to encrypt the snapshot.

Link copied to clipboard

A list of the cache nodes in the source cluster.

Link copied to clipboard

The number of cache nodes in the source cluster.

Link copied to clipboard

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.

Link copied to clipboard
val port: Int?

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The ARN (Amazon Resource Name) of the preferred outpost.

Link copied to clipboard

A description of the source replication group.

Link copied to clipboard

The unique identifier of the source replication group.

Link copied to clipboard

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

Link copied to clipboard

For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: Snapshot.Builder.() -> Unit = {}): Snapshot
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String