Snapshot class
Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
Constructors
-
Snapshot({String? arn, bool? autoMinorVersionUpgrade, AutomaticFailoverStatus? automaticFailover, DateTime? cacheClusterCreateTime, String? cacheClusterId, String? cacheNodeType, String? cacheParameterGroupName, String? cacheSubnetGroupName, String? engine, String? engineVersion, String? kmsKeyId, List<
NodeSnapshot> ? nodeSnapshots, int? numCacheNodes, int? numNodeGroups, int? port, String? preferredAvailabilityZone, String? preferredMaintenanceWindow, String? preferredOutpostArn, String? replicationGroupDescription, String? replicationGroupId, String? snapshotName, int? snapshotRetentionLimit, String? snapshotSource, String? snapshotStatus, String? snapshotWindow, String? topicArn, String? vpcId}) - Snapshot.fromXml(XmlElement elem)
-
factory
Properties
- arn → String?
-
The ARN (Amazon Resource Name) of the snapshot.
final
- automaticFailover → AutomaticFailoverStatus?
-
Indicates the status of automatic failover for the source Redis replication
group.
final
- autoMinorVersionUpgrade → bool?
-
This parameter is currently disabled.
final
- cacheClusterCreateTime → DateTime?
-
The date and time when the source cluster was created.
final
- cacheClusterId → String?
-
The user-supplied identifier of the source cluster.
final
- cacheNodeType → String?
-
The name of the compute and memory capacity node type for the source
cluster.
final
- cacheParameterGroupName → String?
-
The cache parameter group that is associated with the source cluster.
final
- cacheSubnetGroupName → String?
-
The name of the cache subnet group associated with the source cluster.
final
- engine → String?
-
The name of the cache engine (
memcached
orredis
) used by the source cluster.final - engineVersion → String?
-
The version of the cache engine version that is used by the source cluster.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- kmsKeyId → String?
-
The ID of the KMS key used to encrypt the snapshot.
final
-
nodeSnapshots
→ List<
NodeSnapshot> ? -
A list of the cache nodes in the source cluster.
final
- numCacheNodes → int?
-
The number of cache nodes in the source cluster.
final
- numNodeGroups → int?
-
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.
final
- port → int?
-
The port number used by each cache nodes in the source cluster.
final
- preferredAvailabilityZone → String?
-
The name of the Availability Zone in which the source cluster is located.
final
- preferredMaintenanceWindow → String?
-
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.
final
- preferredOutpostArn → String?
-
The ARN (Amazon Resource Name) of the preferred outpost.
final
- replicationGroupDescription → String?
-
A description of the source replication group.
final
- replicationGroupId → String?
-
The unique identifier of the source replication group.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- snapshotName → String?
-
The name of a snapshot. For an automatic snapshot, the name is
system-generated. For a manual snapshot, this is the user-provided name.
final
- snapshotRetentionLimit → int?
-
For an automatic snapshot, the number of days for which ElastiCache retains
the snapshot before deleting it.
final
- snapshotSource → String?
-
Indicates whether the snapshot is from an automatic backup
(
automated
) or was created manually (manual
).final - snapshotStatus → String?
-
The status of the snapshot. Valid values:
creating
|available
|restoring
|copying
|deleting
.final - snapshotWindow → String?
-
The daily time range during which ElastiCache takes daily snapshots of the
source cluster.
final
- topicArn → String?
-
The Amazon Resource Name (ARN) for the topic used by the source cluster for
publishing notifications.
final
- vpcId → String?
-
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet
group for the source cluster.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited