Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Snapshot = Snapshot' {
- arn :: Maybe Text
- autoMinorVersionUpgrade :: Maybe Bool
- automaticFailover :: Maybe AutomaticFailoverStatus
- cacheClusterCreateTime :: Maybe ISO8601
- cacheClusterId :: Maybe Text
- cacheNodeType :: Maybe Text
- cacheParameterGroupName :: Maybe Text
- cacheSubnetGroupName :: Maybe Text
- dataTiering :: Maybe DataTieringStatus
- engine :: Maybe Text
- engineVersion :: Maybe Text
- kmsKeyId :: Maybe Text
- nodeSnapshots :: Maybe [NodeSnapshot]
- numCacheNodes :: Maybe Int
- numNodeGroups :: Maybe Int
- port :: Maybe Int
- preferredAvailabilityZone :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- preferredOutpostArn :: Maybe Text
- replicationGroupDescription :: Maybe Text
- replicationGroupId :: Maybe Text
- snapshotName :: Maybe Text
- snapshotRetentionLimit :: Maybe Int
- snapshotSource :: Maybe Text
- snapshotStatus :: Maybe Text
- snapshotWindow :: Maybe Text
- topicArn :: Maybe Text
- vpcId :: Maybe Text
- newSnapshot :: Snapshot
- snapshot_arn :: Lens' Snapshot (Maybe Text)
- snapshot_autoMinorVersionUpgrade :: Lens' Snapshot (Maybe Bool)
- snapshot_automaticFailover :: Lens' Snapshot (Maybe AutomaticFailoverStatus)
- snapshot_cacheClusterCreateTime :: Lens' Snapshot (Maybe UTCTime)
- snapshot_cacheClusterId :: Lens' Snapshot (Maybe Text)
- snapshot_cacheNodeType :: Lens' Snapshot (Maybe Text)
- snapshot_cacheParameterGroupName :: Lens' Snapshot (Maybe Text)
- snapshot_cacheSubnetGroupName :: Lens' Snapshot (Maybe Text)
- snapshot_dataTiering :: Lens' Snapshot (Maybe DataTieringStatus)
- snapshot_engine :: Lens' Snapshot (Maybe Text)
- snapshot_engineVersion :: Lens' Snapshot (Maybe Text)
- snapshot_kmsKeyId :: Lens' Snapshot (Maybe Text)
- snapshot_nodeSnapshots :: Lens' Snapshot (Maybe [NodeSnapshot])
- snapshot_numCacheNodes :: Lens' Snapshot (Maybe Int)
- snapshot_numNodeGroups :: Lens' Snapshot (Maybe Int)
- snapshot_port :: Lens' Snapshot (Maybe Int)
- snapshot_preferredAvailabilityZone :: Lens' Snapshot (Maybe Text)
- snapshot_preferredMaintenanceWindow :: Lens' Snapshot (Maybe Text)
- snapshot_preferredOutpostArn :: Lens' Snapshot (Maybe Text)
- snapshot_replicationGroupDescription :: Lens' Snapshot (Maybe Text)
- snapshot_replicationGroupId :: Lens' Snapshot (Maybe Text)
- snapshot_snapshotName :: Lens' Snapshot (Maybe Text)
- snapshot_snapshotRetentionLimit :: Lens' Snapshot (Maybe Int)
- snapshot_snapshotSource :: Lens' Snapshot (Maybe Text)
- snapshot_snapshotStatus :: Lens' Snapshot (Maybe Text)
- snapshot_snapshotWindow :: Lens' Snapshot (Maybe Text)
- snapshot_topicArn :: Lens' Snapshot (Maybe Text)
- snapshot_vpcId :: Lens' Snapshot (Maybe Text)
Documentation
Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
See: newSnapshot
smart constructor.
Snapshot' | |
|
Instances
newSnapshot :: Snapshot Source #
Create a value of Snapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Snapshot'
, snapshot_arn
- The ARN (Amazon Resource Name) of the snapshot.
$sel:autoMinorVersionUpgrade:Snapshot'
, snapshot_autoMinorVersionUpgrade
- If you are running Redis engine version 6.0 or later, 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.
$sel:automaticFailover:Snapshot'
, snapshot_automaticFailover
- Indicates the status of automatic failover for the source Redis
replication group.
$sel:cacheClusterCreateTime:Snapshot'
, snapshot_cacheClusterCreateTime
- The date and time when the source cluster was created.
Snapshot
, snapshot_cacheClusterId
- The user-supplied identifier of the source cluster.
$sel:cacheNodeType:Snapshot'
, snapshot_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:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):
cache.m6g.large
,cache.m6g.xlarge
,cache.m6g.2xlarge
,cache.m6g.4xlarge
,cache.m6g.8xlarge
,cache.m6g.12xlarge
,cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types:
cache.m5.large
,cache.m5.xlarge
,cache.m5.2xlarge
,cache.m5.4xlarge
,cache.m5.12xlarge
,cache.m5.24xlarge
M4 node types:
cache.m4.large
,cache.m4.xlarge
,cache.m4.2xlarge
,cache.m4.4xlarge
,cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
cache.t4g.micro
,cache.t4g.small
,cache.t4g.medium
T3 node types:
cache.t3.micro
,cache.t3.small
,cache.t3.medium
T2 node types:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types:
cache.t1.micro
M1 node types:
cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
M3 node types:
cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types:
cache.c1.xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
,cache.r6g.xlarge
,cache.r6g.2xlarge
,cache.r6g.4xlarge
,cache.r6g.8xlarge
,cache.r6g.12xlarge
,cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types:
cache.r5.large
,cache.r5.xlarge
,cache.r5.2xlarge
,cache.r5.4xlarge
,cache.r5.12xlarge
,cache.r5.24xlarge
R4 node types:
cache.r4.large
,cache.r4.xlarge
,cache.r4.2xlarge
,cache.r4.4xlarge
,cache.r4.8xlarge
,cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
R3 node types:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
Additional node type info
- All current generation instance types are created in Amazon VPC by default.
- Redis append-only files (AOF) are not supported for T1 or T2 instances.
- Redis Multi-AZ with automatic failover is not supported on T1 instances.
- Redis configuration variables
appendonly
andappendfsync
are not supported on Redis version 2.8.22 and later.
$sel:cacheParameterGroupName:Snapshot'
, snapshot_cacheParameterGroupName
- The cache parameter group that is associated with the source cluster.
$sel:cacheSubnetGroupName:Snapshot'
, snapshot_cacheSubnetGroupName
- The name of the cache subnet group associated with the source cluster.
$sel:dataTiering:Snapshot'
, snapshot_dataTiering
- 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.
$sel:engine:Snapshot'
, snapshot_engine
- The name of the cache engine (memcached
or redis
) used by the source
cluster.
$sel:engineVersion:Snapshot'
, snapshot_engineVersion
- The version of the cache engine version that is used by the source
cluster.
$sel:kmsKeyId:Snapshot'
, snapshot_kmsKeyId
- The ID of the KMS key used to encrypt the snapshot.
$sel:nodeSnapshots:Snapshot'
, snapshot_nodeSnapshots
- A list of the cache nodes in the source cluster.
$sel:numCacheNodes:Snapshot'
, snapshot_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 40.
$sel:numNodeGroups:Snapshot'
, snapshot_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.
$sel:port:Snapshot'
, snapshot_port
- The port number used by each cache nodes in the source cluster.
$sel:preferredAvailabilityZone:Snapshot'
, snapshot_preferredAvailabilityZone
- The name of the Availability Zone in which the source cluster is
located.
$sel:preferredMaintenanceWindow:Snapshot'
, snapshot_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
$sel:preferredOutpostArn:Snapshot'
, snapshot_preferredOutpostArn
- The ARN (Amazon Resource Name) of the preferred outpost.
$sel:replicationGroupDescription:Snapshot'
, snapshot_replicationGroupDescription
- A description of the source replication group.
$sel:replicationGroupId:Snapshot'
, snapshot_replicationGroupId
- The unique identifier of the source replication group.
$sel:snapshotName:Snapshot'
, snapshot_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.
$sel:snapshotRetentionLimit:Snapshot'
, snapshot_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.
$sel:snapshotSource:Snapshot'
, snapshot_snapshotSource
- Indicates whether the snapshot is from an automatic backup (automated
)
or was created manually (manual
).
$sel:snapshotStatus:Snapshot'
, snapshot_snapshotStatus
- The status of the snapshot. Valid values: creating
| available
|
restoring
| copying
| deleting
.
$sel:snapshotWindow:Snapshot'
, snapshot_snapshotWindow
- The daily time range during which ElastiCache takes daily snapshots of
the source cluster.
$sel:topicArn:Snapshot'
, snapshot_topicArn
- The Amazon Resource Name (ARN) for the topic used by the source cluster
for publishing notifications.
$sel:vpcId:Snapshot'
, snapshot_vpcId
- The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet
group for the source cluster.
snapshot_autoMinorVersionUpgrade :: Lens' Snapshot (Maybe Bool) Source #
If you are running Redis engine version 6.0 or later, 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.
snapshot_automaticFailover :: Lens' Snapshot (Maybe AutomaticFailoverStatus) Source #
Indicates the status of automatic failover for the source Redis replication group.
snapshot_cacheClusterCreateTime :: Lens' Snapshot (Maybe UTCTime) Source #
The date and time when the source cluster was created.
snapshot_cacheClusterId :: Lens' Snapshot (Maybe Text) Source #
The user-supplied identifier of the source cluster.
snapshot_cacheNodeType :: Lens' Snapshot (Maybe Text) Source #
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:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):
cache.m6g.large
,cache.m6g.xlarge
,cache.m6g.2xlarge
,cache.m6g.4xlarge
,cache.m6g.8xlarge
,cache.m6g.12xlarge
,cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types:
cache.m5.large
,cache.m5.xlarge
,cache.m5.2xlarge
,cache.m5.4xlarge
,cache.m5.12xlarge
,cache.m5.24xlarge
M4 node types:
cache.m4.large
,cache.m4.xlarge
,cache.m4.2xlarge
,cache.m4.4xlarge
,cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
cache.t4g.micro
,cache.t4g.small
,cache.t4g.medium
T3 node types:
cache.t3.micro
,cache.t3.small
,cache.t3.medium
T2 node types:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types:
cache.t1.micro
M1 node types:
cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
M3 node types:
cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types:
cache.c1.xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
,cache.r6g.xlarge
,cache.r6g.2xlarge
,cache.r6g.4xlarge
,cache.r6g.8xlarge
,cache.r6g.12xlarge
,cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types:
cache.r5.large
,cache.r5.xlarge
,cache.r5.2xlarge
,cache.r5.4xlarge
,cache.r5.12xlarge
,cache.r5.24xlarge
R4 node types:
cache.r4.large
,cache.r4.xlarge
,cache.r4.2xlarge
,cache.r4.4xlarge
,cache.r4.8xlarge
,cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
R3 node types:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
Additional node type info
- All current generation instance types are created in Amazon VPC by default.
- Redis append-only files (AOF) are not supported for T1 or T2 instances.
- Redis Multi-AZ with automatic failover is not supported on T1 instances.
- Redis configuration variables
appendonly
andappendfsync
are not supported on Redis version 2.8.22 and later.
snapshot_cacheParameterGroupName :: Lens' Snapshot (Maybe Text) Source #
The cache parameter group that is associated with the source cluster.
snapshot_cacheSubnetGroupName :: Lens' Snapshot (Maybe Text) Source #
The name of the cache subnet group associated with the source cluster.
snapshot_dataTiering :: Lens' Snapshot (Maybe DataTieringStatus) Source #
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.
snapshot_engine :: Lens' Snapshot (Maybe Text) Source #
The name of the cache engine (memcached
or redis
) used by the source
cluster.
snapshot_engineVersion :: Lens' Snapshot (Maybe Text) Source #
The version of the cache engine version that is used by the source cluster.
snapshot_kmsKeyId :: Lens' Snapshot (Maybe Text) Source #
The ID of the KMS key used to encrypt the snapshot.
snapshot_nodeSnapshots :: Lens' Snapshot (Maybe [NodeSnapshot]) Source #
A list of the cache nodes in the source cluster.
snapshot_numCacheNodes :: Lens' Snapshot (Maybe Int) Source #
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 40.
snapshot_numNodeGroups :: Lens' Snapshot (Maybe Int) Source #
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.
snapshot_port :: Lens' Snapshot (Maybe Int) Source #
The port number used by each cache nodes in the source cluster.
snapshot_preferredAvailabilityZone :: Lens' Snapshot (Maybe Text) Source #
The name of the Availability Zone in which the source cluster is located.
snapshot_preferredMaintenanceWindow :: Lens' Snapshot (Maybe Text) Source #
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
snapshot_preferredOutpostArn :: Lens' Snapshot (Maybe Text) Source #
The ARN (Amazon Resource Name) of the preferred outpost.
snapshot_replicationGroupDescription :: Lens' Snapshot (Maybe Text) Source #
A description of the source replication group.
snapshot_replicationGroupId :: Lens' Snapshot (Maybe Text) Source #
The unique identifier of the source replication group.
snapshot_snapshotName :: Lens' Snapshot (Maybe Text) Source #
The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
snapshot_snapshotRetentionLimit :: Lens' Snapshot (Maybe Int) Source #
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.
snapshot_snapshotSource :: Lens' Snapshot (Maybe Text) Source #
Indicates whether the snapshot is from an automatic backup (automated
)
or was created manually (manual
).
snapshot_snapshotStatus :: Lens' Snapshot (Maybe Text) Source #
The status of the snapshot. Valid values: creating
| available
|
restoring
| copying
| deleting
.
snapshot_snapshotWindow :: Lens' Snapshot (Maybe Text) Source #
The daily time range during which ElastiCache takes daily snapshots of the source cluster.