-
Notifications
You must be signed in to change notification settings - Fork 37
/
Copy pathelasticache.services.k8s.aws_snapshots.yaml
399 lines (377 loc) · 19.1 KB
/
elasticache.services.k8s.aws_snapshots.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.16.2
name: snapshots.elasticache.services.k8s.aws
spec:
group: elasticache.services.k8s.aws
names:
kind: Snapshot
listKind: SnapshotList
plural: snapshots
singular: snapshot
scope: Namespaced
versions:
- name: v1alpha1
schema:
openAPIV3Schema:
description: Snapshot is the Schema for the Snapshots API
properties:
apiVersion:
description: |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type: string
kind:
description: |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type: string
metadata:
type: object
spec:
description: |-
SnapshotSpec defines the desired state of Snapshot.
Represents a copy of an entire Valkey or Redis OSS cluster as of the time
when the snapshot was taken.
properties:
cacheClusterID:
description: |-
The identifier of an existing cluster. The snapshot is created from this
cluster.
type: string
kmsKeyID:
description: The ID of the KMS key used to encrypt the snapshot.
type: string
replicationGroupID:
description: |-
The identifier of an existing replication group. The snapshot is created
from this replication group.
type: string
snapshotName:
description: A name for the snapshot being created.
type: string
sourceSnapshotName:
description: The name of an existing snapshot from which to make a
copy.
type: string
tags:
description: |-
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.
items:
description: |-
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.
properties:
key:
type: string
value:
type: string
type: object
type: array
required:
- snapshotName
type: object
status:
description: SnapshotStatus defines the observed state of Snapshot
properties:
ackResourceMetadata:
description: |-
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
properties:
arn:
description: |-
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.
https://github.com/aws/aws-controllers-k8s/issues/270
type: string
ownerAccountID:
description: |-
OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.
type: string
region:
description: Region is the AWS region in which the resource exists
or will exist.
type: string
required:
- ownerAccountID
- region
type: object
autoMinorVersionUpgrade:
description: |-
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.
type: boolean
automaticFailover:
description: |-
Indicates the status of automatic failover for the source Valkey or Redis
OSS replication group.
type: string
cacheClusterCreateTime:
description: The date and time when the source cluster was created.
format: date-time
type: string
cacheNodeType:
description: |-
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: M7g node types: cache.m7g.large,
cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported
Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
M6g node types (available only for Redis OSS 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 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 OSS 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: R7g node types: cache.r7g.large,
cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported
Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
R6g node types (available only for Redis OSS 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 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.
* Valkey or Redis OSS append-only files (AOF) are not supported for T1
or T2 instances.
* Valkey or Redis OSS Multi-AZ with automatic failover is not supported
on T1 instances.
* The configuration variables appendonly and appendfsync are not supported
on Valkey, or on Redis OSS version 2.8.22 and later.
type: string
cacheParameterGroupName:
description: The cache parameter group that is associated with the
source cluster.
type: string
cacheSubnetGroupName:
description: The name of the cache subnet group associated with the
source cluster.
type: string
conditions:
description: |-
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
items:
description: |-
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
properties:
lastTransitionTime:
description: Last time the condition transitioned from one status
to another.
format: date-time
type: string
message:
description: A human readable message indicating details about
the transition.
type: string
reason:
description: The reason for the condition's last transition.
type: string
status:
description: Status of the condition, one of True, False, Unknown.
type: string
type:
description: Type is the type of the Condition
type: string
required:
- status
- type
type: object
type: array
dataTiering:
description: |-
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/dg/data-tiering.html).
type: string
engine:
description: The name of the cache engine (memcached or redis) used
by the source cluster.
type: string
engineVersion:
description: The version of the cache engine version that is used
by the source cluster.
type: string
nodeSnapshots:
description: A list of the cache nodes in the source cluster.
items:
description: Represents an individual cache node in a snapshot of
a cluster.
properties:
cacheClusterID:
type: string
cacheNodeCreateTime:
format: date-time
type: string
cacheNodeID:
type: string
cacheSize:
type: string
nodeGroupConfiguration:
description: |-
Node group (shard) configuration options. Each node group (shard) configuration
has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones,
ReplicaCount.
properties:
nodeGroupID:
type: string
primaryAvailabilityZone:
type: string
primaryOutpostARN:
type: string
replicaAvailabilityZones:
items:
type: string
type: array
replicaCount:
format: int64
type: integer
replicaOutpostARNs:
items:
type: string
type: array
slots:
type: string
type: object
nodeGroupID:
type: string
snapshotCreateTime:
format: date-time
type: string
type: object
type: array
numCacheNodes:
description: |-
The number of cache nodes in the source cluster.
For clusters running Valkey or Redis OSS, this value must be 1. For clusters
running Memcached, this value must be between 1 and 40.
format: int64
type: integer
numNodeGroups:
description: |-
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.
format: int64
type: integer
port:
description: The port number used by each cache nodes in the source
cluster.
format: int64
type: integer
preferredAvailabilityZone:
description: The name of the Availability Zone in which the source
cluster is located.
type: string
preferredMaintenanceWindow:
description: |-
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
type: string
preferredOutpostARN:
description: The ARN (Amazon Resource Name) of the preferred outpost.
type: string
replicationGroupDescription:
description: A description of the source replication group.
type: string
snapshotRetentionLimit:
description: |-
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.
format: int64
type: integer
snapshotSource:
description: |-
Indicates whether the snapshot is from an automatic backup (automated) or
was created manually (manual).
type: string
snapshotStatus:
description: |-
The status of the snapshot. Valid values: creating | available | restoring
| copying | deleting.
type: string
snapshotWindow:
description: |-
The daily time range during which ElastiCache takes daily snapshots of the
source cluster.
type: string
topicARN:
description: |-
The Amazon Resource Name (ARN) for the topic used by the source cluster for
publishing notifications.
type: string
vpcID:
description: |-
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet
group for the source cluster.
type: string
type: object
type: object
served: true
storage: true
subresources:
status: {}