Snapshot
elasticache.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | elasticache-controller/apis/v1alpha1#Snapshot |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Snapshot |
| ListKind | SnapshotList |
| Plural | snapshots |
| Singular | snapshot |
Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
Spec
cacheClusterID: string
kmsKeyID: string
replicationGroupID: string
snapshotName: string
sourceSnapshotName: string
tags:
- key: string
value: string
| Field | Description |
|---|---|
| cacheClusterID Optional | string The identifier of an existing cluster. The snapshot is created from this cluster. |
| kmsKeyID Optional | string The ID of the KMS key used to encrypt the snapshot. |
| replicationGroupID Optional | string The identifier of an existing replication group. The snapshot is created from this replication group. |
| snapshotName Required | string A name for the snapshot being created. |
| sourceSnapshotName Optional | string The name of an existing snapshot from which to make a copy. |
| tags Optional | array A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. |
| tags.[] Required | object A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted. |
| tags.[].value Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
autoMinorVersionUpgrade: boolean
automaticFailover: string
cacheClusterCreateTime: string
cacheNodeType: string
cacheParameterGroupName: string
cacheSubnetGroupName: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
dataTiering: string
engine: string
engineVersion: string
nodeSnapshots:
- cacheClusterID: string
cacheNodeCreateTime: string
cacheNodeID: string
cacheSize: string
nodeGroupConfiguration:
nodeGroupID: string
primaryAvailabilityZone: string
primaryOutpostARN: string
replicaAvailabilityZones:
- string
replicaCount: integer
replicaOutpostARNs:
- string
slots: string
nodeGroupID: string
snapshotCreateTime: string
numCacheNodes: integer
numNodeGroups: integer
port: integer
preferredAvailabilityZone: string
preferredMaintenanceWindow: string
preferredOutpostARN: string
replicationGroupDescription: string
snapshotRetentionLimit: integer
snapshotSource: string
snapshotStatus: string
snapshotWindow: string
topicARN: string
vpcID: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata member that is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| autoMinorVersionUpgrade Optional | boolean 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. |
| automaticFailover Optional | string Indicates the status of automatic failover for the source Redis replication group. |
| cacheClusterCreateTime Optional | string The date and time when the source cluster was created. |
| cacheNodeType Optional | string 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 (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) 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 with data tiering: Current generation: R6gd node types (available only for Redis engine version 6.2 onward). cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge, cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge * 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 (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) 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 and appendfsync are not supported on Redis version 2.8.22 and later. |
| cacheParameterGroupName Optional | string The cache parameter group that is associated with the source cluster. |
| cacheSubnetGroupName Optional | string The name of the cache subnet group associated with the source cluster. |
| conditions Optional | array All CRS managed by ACK have a common Status.Conditions member that contains a collection of ackv1alpha1.Condition objects that describe the various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| dataTiering Optional | string 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 (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html). |
| engine Optional | string The name of the cache engine (memcached or redis) used by the source cluster. |
| engineVersion Optional | string The version of the cache engine version that is used by the source cluster. |
| nodeSnapshots Optional | array A list of the cache nodes in the source cluster. |
| nodeSnapshots.[] Required | object Represents an individual cache node in a snapshot of a cluster. |
| nodeSnapshots.[].cacheNodeCreateTime Optional | string |
| nodeSnapshots.[].cacheNodeID Optional | string |
| nodeSnapshots.[].cacheSize Optional | string |
| nodeSnapshots.[].nodeGroupConfiguration Optional | object Node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount. |
| nodeSnapshots.[].nodeGroupConfiguration.nodeGroupID Optional | string |
| nodeSnapshots.[].nodeGroupConfiguration.primaryAvailabilityZone Optional | string |
| nodeSnapshots.[].nodeGroupConfiguration.primaryOutpostARN Optional | string |
| nodeSnapshots.[].nodeGroupConfiguration.replicaAvailabilityZones Optional | array |
| nodeSnapshots.[].nodeGroupConfiguration.replicaAvailabilityZones.[] Required | string |
| nodeSnapshots.[].nodeGroupConfiguration.replicaOutpostARNs Optional | array |
| nodeSnapshots.[].nodeGroupConfiguration.replicaOutpostARNs.[] Required | string |
| nodeSnapshots.[].nodeGroupID Optional | string |
| nodeSnapshots.[].snapshotCreateTime Optional | string |
| numCacheNodes Optional | integer 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. |
| numNodeGroups Optional | integer 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. |
| port Optional | integer The port number used by each cache nodes in the source cluster. |
| preferredAvailabilityZone Optional | string The name of the Availability Zone in which the source cluster is located. |
| preferredMaintenanceWindow Optional | 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. Valid values for ddd are: * sun * mon * tue * wed * thu * fri * sat Example: sun:23:00-mon:01:30 |
| preferredOutpostARN Optional | string The ARN (Amazon Resource Name) of the preferred outpost. |
| replicationGroupDescription Optional | string A description of the source replication group. |
| snapshotRetentionLimit Optional | integer 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. |
| snapshotSource Optional | string Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual). |
| snapshotStatus Optional | string The status of the snapshot. Valid values: creating |
| snapshotWindow Optional | string The daily time range during which ElastiCache takes daily snapshots of the source cluster. |
| topicARN Optional | string The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications. |
| vpcID Optional | string The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster. |