-
Notifications
You must be signed in to change notification settings - Fork 20
/
Copy pathdynamodb.services.k8s.aws_tables.yaml
721 lines (673 loc) · 34.7 KB
/
dynamodb.services.k8s.aws_tables.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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.16.2
name: tables.dynamodb.services.k8s.aws
spec:
group: dynamodb.services.k8s.aws
names:
kind: Table
listKind: TableList
plural: tables
singular: table
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .status.ackResourceMetadata.arn
name: ARN
priority: 1
type: string
- jsonPath: .spec.tableClass
name: CLASS
type: string
- jsonPath: .status.tableStatus
name: STATUS
type: string
- jsonPath: .status.conditions[?(@.type=="ACK.ResourceSynced")].status
name: Synced
type: string
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
name: v1alpha1
schema:
openAPIV3Schema:
description: Table is the Schema for the Tables 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: TableSpec defines the desired state of Table.
properties:
attributeDefinitions:
description: An array of attributes that describe the key schema for
the table and indexes.
items:
description: Represents an attribute for describing the schema for
the table and indexes.
properties:
attributeName:
type: string
attributeType:
type: string
type: object
type: array
billingMode:
description: |-
Controls how you are charged for read and write throughput and how you manage
capacity. This setting can be changed later.
- PROVISIONED - We recommend using PROVISIONED for predictable workloads.
PROVISIONED sets the billing mode to Provisioned capacity mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html).
- PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable
workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity
mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html).
type: string
continuousBackups:
description: Represents the settings used to enable point in time
recovery.
properties:
pointInTimeRecoveryEnabled:
type: boolean
type: object
deletionProtectionEnabled:
description: |-
Indicates whether deletion protection is to be enabled (true) or disabled
(false) on the table.
type: boolean
globalSecondaryIndexes:
description: |-
One or more global secondary indexes (the maximum is 20) to be created on
the table. Each global secondary index in the array includes the following:
- IndexName - The name of the global secondary index. Must be unique only
for this table.
- KeySchema - Specifies the key schema for the global secondary index.
- Projection - Specifies attributes that are copied (projected) from the
table into the index. These are in addition to the primary key attributes
and index key attributes, which are automatically projected. Each attribute
specification is composed of: ProjectionType - One of the following: KEYS_ONLY
- Only the index and primary keys are projected into the index. INCLUDE
- Only the specified table attributes are projected into the index. The
list of projected attributes is in NonKeyAttributes. ALL - All of the
table attributes are projected into the index. NonKeyAttributes - A list
of one or more non-key attribute names that are projected into the secondary
index. The total count of attributes provided in NonKeyAttributes, summed
across all of the secondary indexes, must not exceed 100. If you project
the same attribute into two different indexes, this counts as two distinct
attributes when determining the total.
- ProvisionedThroughput - The provisioned throughput settings for the
global secondary index, consisting of read and write capacity units.
items:
description: Represents the properties of a global secondary index.
properties:
indexName:
type: string
keySchema:
items:
description: |-
Represents a single element of a key schema. A key schema specifies the attributes
that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For
example, a simple primary key would be represented by one KeySchemaElement
(for the partition key). A composite primary key would require one KeySchemaElement
for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).
The data type must be one of String, Number, or Binary. The attribute cannot
be nested within a List or a Map.
properties:
attributeName:
type: string
keyType:
type: string
type: object
type: array
projection:
description: |-
Represents attributes that are copied (projected) from the table into an
index. These are in addition to the primary key attributes and index key
attributes, which are automatically projected.
properties:
nonKeyAttributes:
items:
type: string
type: array
projectionType:
type: string
type: object
provisionedThroughput:
description: |-
Represents the provisioned throughput settings for a specified table or index.
The settings can be modified using the UpdateTable operation.
For current minimum and maximum provisioned throughput values, see Service,
Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
in the Amazon DynamoDB Developer Guide.
properties:
readCapacityUnits:
format: int64
type: integer
writeCapacityUnits:
format: int64
type: integer
type: object
type: object
type: array
keySchema:
description: |-
Specifies the attributes that make up the primary key for a table or an index.
The attributes in KeySchema must also be defined in the AttributeDefinitions
array. For more information, see Data Model (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html)
in the Amazon DynamoDB Developer Guide.
Each KeySchemaElement in the array is composed of:
- AttributeName - The name of this key attribute.
- KeyType - The role that the key attribute will assume: HASH - partition
key RANGE - sort key
The partition key of an item is also known as its hash attribute. The term
"hash attribute" derives from the DynamoDB usage of an internal hash function
to evenly distribute data items across partitions, based on their partition
key values.
The sort key of an item is also known as its range attribute. The term "range
attribute" derives from the way DynamoDB stores items with the same partition
key physically close together, in sorted order by the sort key value.
For a simple primary key (partition key), you must provide exactly one element
with a KeyType of HASH.
For a composite primary key (partition key and sort key), you must provide
exactly two elements, in this order: The first element must have a KeyType
of HASH, and the second element must have a KeyType of RANGE.
For more information, see Working with Tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key)
in the Amazon DynamoDB Developer Guide.
items:
description: |-
Represents a single element of a key schema. A key schema specifies the attributes
that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For
example, a simple primary key would be represented by one KeySchemaElement
(for the partition key). A composite primary key would require one KeySchemaElement
for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).
The data type must be one of String, Number, or Binary. The attribute cannot
be nested within a List or a Map.
properties:
attributeName:
type: string
keyType:
type: string
type: object
type: array
x-kubernetes-validations:
- message: Value is immutable once set
rule: self == oldSelf
localSecondaryIndexes:
description: |-
One or more local secondary indexes (the maximum is 5) to be created on the
table. Each index is scoped to a given partition key value. There is a 10
GB size limit per partition key value; otherwise, the size of a local secondary
index is unconstrained.
Each local secondary index in the array includes the following:
- IndexName - The name of the local secondary index. Must be unique only
for this table.
- KeySchema - Specifies the key schema for the local secondary index.
The key schema must begin with the same partition key as the table.
- Projection - Specifies attributes that are copied (projected) from the
table into the index. These are in addition to the primary key attributes
and index key attributes, which are automatically projected. Each attribute
specification is composed of: ProjectionType - One of the following: KEYS_ONLY
- Only the index and primary keys are projected into the index. INCLUDE
- Only the specified table attributes are projected into the index. The
list of projected attributes is in NonKeyAttributes. ALL - All of the
table attributes are projected into the index. NonKeyAttributes - A list
of one or more non-key attribute names that are projected into the secondary
index. The total count of attributes provided in NonKeyAttributes, summed
across all of the secondary indexes, must not exceed 100. If you project
the same attribute into two different indexes, this counts as two distinct
attributes when determining the total.
items:
description: Represents the properties of a local secondary index.
properties:
indexName:
type: string
keySchema:
items:
description: |-
Represents a single element of a key schema. A key schema specifies the attributes
that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For
example, a simple primary key would be represented by one KeySchemaElement
(for the partition key). A composite primary key would require one KeySchemaElement
for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).
The data type must be one of String, Number, or Binary. The attribute cannot
be nested within a List or a Map.
properties:
attributeName:
type: string
keyType:
type: string
type: object
type: array
projection:
description: |-
Represents attributes that are copied (projected) from the table into an
index. These are in addition to the primary key attributes and index key
attributes, which are automatically projected.
properties:
nonKeyAttributes:
items:
type: string
type: array
projectionType:
type: string
type: object
type: object
type: array
x-kubernetes-validations:
- message: Value is immutable once set
rule: self == oldSelf
provisionedThroughput:
description: |-
Represents the provisioned throughput settings for a specified table or index.
The settings can be modified using the UpdateTable operation.
If you set BillingMode as PROVISIONED, you must specify this property. If
you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.
For current minimum and maximum provisioned throughput values, see Service,
Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
in the Amazon DynamoDB Developer Guide.
properties:
readCapacityUnits:
format: int64
type: integer
writeCapacityUnits:
format: int64
type: integer
type: object
sseSpecification:
description: Represents the settings used to enable server-side encryption.
properties:
enabled:
type: boolean
kmsMasterKeyID:
type: string
kmsMasterKeyRef:
description: Reference field for KMSMasterKeyID
properties:
from:
description: |-
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
properties:
name:
type: string
namespace:
type: string
type: object
type: object
sseType:
type: string
type: object
streamSpecification:
description: |-
The settings for DynamoDB Streams on the table. These settings consist of:
- StreamEnabled - Indicates whether DynamoDB Streams is to be enabled
(true) or disabled (false).
- StreamViewType - When an item in the table is modified, StreamViewType
determines what information is written to the table's stream. Valid values
for StreamViewType are: KEYS_ONLY - Only the key attributes of the modified
item are written to the stream. NEW_IMAGE - The entire item, as it appears
after it was modified, is written to the stream. OLD_IMAGE - The entire
item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item
are written to the stream.
properties:
streamEnabled:
type: boolean
streamViewType:
type: string
type: object
tableClass:
description: The table class of the new table. Valid values are STANDARD
and STANDARD_INFREQUENT_ACCESS.
type: string
tableName:
description: |-
The name of the table to create. You can also provide the Amazon Resource
Name (ARN) of the table in this parameter.
type: string
tags:
description: |-
A list of key-value pairs to label the table. For more information, see Tagging
for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html).
items:
description: |-
Describes a tag. A tag is a key-value pair. You can add up to 50 tags to
a single DynamoDB table.
Amazon Web Services-assigned tag names and values are automatically assigned
the aws: prefix, which the user cannot assign. Amazon Web Services-assigned
tag names do not count towards the tag limit of 50. User-assigned tag names
have the prefix user: in the Cost Allocation Report. You cannot backdate
the application of a tag.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)
in the Amazon DynamoDB Developer Guide.
properties:
key:
type: string
value:
type: string
type: object
type: array
timeToLive:
description: |-
Represents the settings used to enable or disable Time to Live for the specified
table.
properties:
attributeName:
type: string
enabled:
type: boolean
type: object
required:
- attributeDefinitions
- keySchema
- tableName
type: object
status:
description: TableStatus defines the observed state of Table
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
archivalSummary:
description: Contains information about the table archive.
properties:
archivalBackupARN:
type: string
archivalDateTime:
format: date-time
type: string
archivalReason:
type: string
type: object
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
creationDateTime:
description: |-
The date and time when the table was created, in UNIX epoch time (http://www.epochconverter.com/)
format.
format: date-time
type: string
globalSecondaryIndexesDescriptions:
items:
description: Represents the properties of a global secondary index.
properties:
backfilling:
type: boolean
indexARN:
type: string
indexName:
type: string
indexSizeBytes:
format: int64
type: integer
indexStatus:
type: string
itemCount:
format: int64
type: integer
keySchema:
items:
description: |-
Represents a single element of a key schema. A key schema specifies the attributes
that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For
example, a simple primary key would be represented by one KeySchemaElement
(for the partition key). A composite primary key would require one KeySchemaElement
for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).
The data type must be one of String, Number, or Binary. The attribute cannot
be nested within a List or a Map.
properties:
attributeName:
type: string
keyType:
type: string
type: object
type: array
projection:
description: |-
Represents attributes that are copied (projected) from the table into an
index. These are in addition to the primary key attributes and index key
attributes, which are automatically projected.
properties:
nonKeyAttributes:
items:
type: string
type: array
projectionType:
type: string
type: object
provisionedThroughput:
description: |-
Represents the provisioned throughput settings for the table, consisting
of read and write capacity units, along with data about increases and decreases.
properties:
lastDecreaseDateTime:
format: date-time
type: string
lastIncreaseDateTime:
format: date-time
type: string
numberOfDecreasesToday:
format: int64
type: integer
readCapacityUnits:
format: int64
type: integer
writeCapacityUnits:
format: int64
type: integer
type: object
type: object
type: array
globalTableVersion:
description: |-
Represents the version of global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)
in use, if the table is replicated across Amazon Web Services Regions.
type: string
itemCount:
description: |-
The number of items in the specified table. DynamoDB updates this value approximately
every six hours. Recent changes might not be reflected in this value.
format: int64
type: integer
latestStreamARN:
description: |-
The Amazon Resource Name (ARN) that uniquely identifies the latest stream
for this table.
type: string
latestStreamLabel:
description: |-
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel is not a unique identifier for the stream, because
it is possible that a stream from another table might have the same timestamp.
However, the combination of the following three elements is guaranteed to
be unique:
* Amazon Web Services customer ID
* Table name
* StreamLabel
type: string
replicas:
description: Represents replicas of the table.
items:
description: Contains the details of the replica.
properties:
globalSecondaryIndexes:
items:
description: Represents the properties of a replica global
secondary index.
properties:
indexName:
type: string
provisionedThroughputOverride:
description: |-
Replica-specific provisioned throughput settings. If not specified, uses
the source table's provisioned throughput settings.
properties:
readCapacityUnits:
format: int64
type: integer
type: object
type: object
type: array
kmsMasterKeyID:
type: string
provisionedThroughputOverride:
description: |-
Replica-specific provisioned throughput settings. If not specified, uses
the source table's provisioned throughput settings.
properties:
readCapacityUnits:
format: int64
type: integer
type: object
regionName:
type: string
replicaInaccessibleDateTime:
format: date-time
type: string
replicaStatus:
type: string
replicaStatusDescription:
type: string
replicaStatusPercentProgress:
type: string
replicaTableClassSummary:
description: Contains details of the table class.
properties:
lastUpdateDateTime:
format: date-time
type: string
tableClass:
type: string
type: object
type: object
type: array
restoreSummary:
description: Contains details for the restore.
properties:
restoreDateTime:
format: date-time
type: string
restoreInProgress:
type: boolean
sourceBackupARN:
type: string
sourceTableARN:
type: string
type: object
tableID:
description: Unique identifier for the table for which the backup
was created.
type: string
tableSizeBytes:
description: |-
The total size of the specified table, in bytes. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this
value.
format: int64
type: integer
tableStatus:
description: |-
The current state of the table:
* CREATING - The table is being created.
* UPDATING - The table/index configuration is being updated. The table/index
remains available for data operations when UPDATING.
* DELETING - The table is being deleted.
* ACTIVE - The table is ready for use.
* INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the
table in inaccessible. Table operations may fail due to failure to use
the KMS key. DynamoDB will initiate the table archival process when a
table's KMS key remains inaccessible for more than seven days.
* ARCHIVING - The table is being archived. Operations are not allowed
until archival is complete.
* ARCHIVED - The table has been archived. See the ArchivalReason for more
information.
type: string
type: object
type: object
served: true
storage: true
subresources:
status: {}