-
Notifications
You must be signed in to change notification settings - Fork 17
/
awsdynamodb.go
5714 lines (5265 loc) · 197 KB
/
awsdynamodb.go
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
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package awsdynamodb
import (
_init_ "github.com/aws/aws-cdk-go/awscdk/jsii"
_jsii_ "github.com/aws/jsii-runtime-go/runtime"
"github.com/aws/aws-cdk-go/awscdk"
"github.com/aws/aws-cdk-go/awscdk/awsapplicationautoscaling"
"github.com/aws/aws-cdk-go/awscdk/awscloudwatch"
"github.com/aws/aws-cdk-go/awscdk/awsdynamodb/internal"
"github.com/aws/aws-cdk-go/awscdk/awsiam"
"github.com/aws/aws-cdk-go/awscdk/awskinesis"
"github.com/aws/aws-cdk-go/awscdk/awskms"
"github.com/aws/constructs-go/constructs/v3"
)
// Represents an attribute for describing the key schema for the table and indexes.
//
// Example:
// globalTable := dynamodb.NewTable(this, jsii.String("Table"), &tableProps{
// partitionKey: &attribute{
// name: jsii.String("id"),
// type: dynamodb.attributeType_STRING,
// },
// replicationRegions: []*string{
// jsii.String("us-east-1"),
// jsii.String("us-east-2"),
// jsii.String("us-west-2"),
// },
// billingMode: dynamodb.billingMode_PROVISIONED,
// })
//
// globalTable.autoScaleWriteCapacity(&enableScalingProps{
// minCapacity: jsii.Number(1),
// maxCapacity: jsii.Number(10),
// }).scaleOnUtilization(&utilizationScalingProps{
// targetUtilizationPercent: jsii.Number(75),
// })
//
// Experimental.
type Attribute struct {
// The name of an attribute.
// Experimental.
Name *string `json:"name" yaml:"name"`
// The data type of an attribute.
// Experimental.
Type AttributeType `json:"type" yaml:"type"`
}
// Data types for attributes within a table.
//
// Example:
// globalTable := dynamodb.NewTable(this, jsii.String("Table"), &tableProps{
// partitionKey: &attribute{
// name: jsii.String("id"),
// type: dynamodb.attributeType_STRING,
// },
// replicationRegions: []*string{
// jsii.String("us-east-1"),
// jsii.String("us-east-2"),
// jsii.String("us-west-2"),
// },
// billingMode: dynamodb.billingMode_PROVISIONED,
// })
//
// globalTable.autoScaleWriteCapacity(&enableScalingProps{
// minCapacity: jsii.Number(1),
// maxCapacity: jsii.Number(10),
// }).scaleOnUtilization(&utilizationScalingProps{
// targetUtilizationPercent: jsii.Number(75),
// })
//
// See: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes
//
// Experimental.
type AttributeType string
const (
// Up to 400KiB of binary data (which must be encoded as base64 before sending to DynamoDB).
// Experimental.
AttributeType_BINARY AttributeType = "BINARY"
// Numeric values made of up to 38 digits (positive, negative or zero).
// Experimental.
AttributeType_NUMBER AttributeType = "NUMBER"
// Up to 400KiB of UTF-8 encoded text.
// Experimental.
AttributeType_STRING AttributeType = "STRING"
)
// DynamoDB's Read/Write capacity modes.
//
// Example:
// table := dynamodb.NewTable(this, jsii.String("Table"), &tableProps{
// partitionKey: &attribute{
// name: jsii.String("id"),
// type: dynamodb.attributeType_STRING,
// },
// billingMode: dynamodb.billingMode_PAY_PER_REQUEST,
// })
//
// Experimental.
type BillingMode string
const (
// Pay only for what you use.
//
// You don't configure Read/Write capacity units.
// Experimental.
BillingMode_PAY_PER_REQUEST BillingMode = "PAY_PER_REQUEST"
// Explicitly specified Read/Write capacity units.
// Experimental.
BillingMode_PROVISIONED BillingMode = "PROVISIONED"
)
// A CloudFormation `AWS::DynamoDB::GlobalTable`.
//
// The `AWS::DynamoDB::GlobalTable` resource enables you to create and manage a Version 2019.11.21 global table. This resource cannot be used to create or manage a Version 2017.11.29 global table.
//
// > You cannot convert a resource of type `AWS::DynamoDB::Table` into a resource of type `AWS::DynamoDB::GlobalTable` by changing its type in your template. *Doing so might result in the deletion of your DynamoDB table.*
// >
// > You can instead use the GlobalTable resource to create a new table in a single Region. This will be billed the same as a single Region table. If you later update the stack to add other Regions then Global Tables pricing will apply.
//
// You should be aware of the following behaviors when working with DynamoDB global tables.
//
// - The IAM Principal executing the stack operation must have the permissions listed below in all regions where you plan to have a global table replica. The IAM Principal's permissions should not have restrictions based on IP source address. Some global tables operations (for example, adding a replica) are asynchronous, and require that the IAM Principal is valid until they complete. You should not delete the Principal (user or IAM role) until CloudFormation has finished updating your stack.
//
// - `dynamodb:CreateTable`
// - `dynamodb:UpdateTable`
// - `dynamodb:DeleteTable`
// - `dynamodb:DescribeContinuousBackups`
// - `dynamodb:DescribeContributorInsights`
// - `dynamodb:DescribeTable`
// - `dynamodb:DescribeTableReplicaAutoScaling`
// - `dynamodb:DescribeTimeToLive`
// - `dynamodb:ListTables`
// - `dynamodb:UpdateTimeToLive`
// - `dynamodb:UpdateContributorInsights`
// - `dynamodb:UpdateContinuousBackups`
// - `dynamodb:ListTagsOfResource`
// - `dynamodb:TagResource`
// - `dynamodb:UntagResource`
// - `dynamodb:BatchWriteItem`
// - `dynamodb:CreateTableReplica`
// - `dynamodb:DeleteItem`
// - `dynamodb:DeleteTableReplica`
// - `dynamodb:DisableKinesisStreamingDestination`
// - `dynamodb:EnableKinesisStreamingDestination`
// - `dynamodb:GetItem`
// - `dynamodb:PutItem`
// - `dynamodb:Query`
// - `dynamodb:Scan`
// - `dynamodb:UpdateItem`
// - `dynamodb:DescribeTableReplicaAutoScaling`
// - `dynamodb:UpdateTableReplicaAutoScaling`
// - `iam:CreateServiceLinkedRole`
// - `kms:CreateGrant`
// - `kms:DescribeKey`
// - `application-autoscaling:DeleteScalingPolicy`
// - `application-autoscaling:DeleteScheduledAction`
// - `application-autoscaling:DeregisterScalableTarget`
// - `application-autoscaling:DescribeScalingPolicies`
// - `application-autoscaling:DescribeScalableTargets`
// - `application-autoscaling:PutScalingPolicy`
// - `application-autoscaling:PutScheduledAction`
// - `application-autoscaling:RegisterScalableTarget`
// - When using provisioned billing mode, CloudFormation will create an auto scaling policy on each of your replicas to control their write capacities. You must configure this policy using the `WriteProvisionedThroughputSettings` property. CloudFormation will ensure that all replicas have the same write capacity auto scaling property. You cannot directly specify a value for write capacity for a global table.
// - If your table uses provisioned capacity, you must configure auto scaling directly in the `AWS::DynamoDB::GlobalTable` resource. You should not configure additional auto scaling policies on any of the table replicas or global secondary indexes, either via API or via `AWS::ApplicationAutoScaling::ScalableTarget` or `AWS::ApplicationAutoScaling::ScalingPolicy` . Doing so might result in unexpected behavior and is unsupported.
// - In AWS CloudFormation , each global table is controlled by a single stack, in a single region, regardless of the number of replicas. When you deploy your template, CloudFormation will create/update all replicas as part of a single stack operation. You should not deploy the same `AWS::DynamoDB::GlobalTable` resource in multiple regions. Doing so will result in errors, and is unsupported. If you deploy your application template in multiple regions, you can use conditions to only create the resource in a single region. Alternatively, you can choose to define your `AWS::DynamoDB::GlobalTable` resources in a stack separate from your application stack, and make sure it is only deployed to a single region.
//
// Example:
// import awscdk "github.com/aws/aws-cdk-go/awscdk"import dynamodb "github.com/aws/aws-cdk-go/awscdk/aws_dynamodb"
// cfnGlobalTable := dynamodb.NewCfnGlobalTable(this, jsii.String("MyCfnGlobalTable"), &cfnGlobalTableProps{
// attributeDefinitions: []interface{}{
// &attributeDefinitionProperty{
// attributeName: jsii.String("attributeName"),
// attributeType: jsii.String("attributeType"),
// },
// },
// keySchema: []interface{}{
// &keySchemaProperty{
// attributeName: jsii.String("attributeName"),
// keyType: jsii.String("keyType"),
// },
// },
// replicas: []interface{}{
// &replicaSpecificationProperty{
// region: jsii.String("region"),
//
// // the properties below are optional
// contributorInsightsSpecification: &contributorInsightsSpecificationProperty{
// enabled: jsii.Boolean(false),
// },
// globalSecondaryIndexes: []interface{}{
// &replicaGlobalSecondaryIndexSpecificationProperty{
// indexName: jsii.String("indexName"),
//
// // the properties below are optional
// contributorInsightsSpecification: &contributorInsightsSpecificationProperty{
// enabled: jsii.Boolean(false),
// },
// readProvisionedThroughputSettings: &readProvisionedThroughputSettingsProperty{
// readCapacityAutoScalingSettings: &capacityAutoScalingSettingsProperty{
// maxCapacity: jsii.Number(123),
// minCapacity: jsii.Number(123),
// targetTrackingScalingPolicyConfiguration: &targetTrackingScalingPolicyConfigurationProperty{
// targetValue: jsii.Number(123),
//
// // the properties below are optional
// disableScaleIn: jsii.Boolean(false),
// scaleInCooldown: jsii.Number(123),
// scaleOutCooldown: jsii.Number(123),
// },
//
// // the properties below are optional
// seedCapacity: jsii.Number(123),
// },
// readCapacityUnits: jsii.Number(123),
// },
// },
// },
// pointInTimeRecoverySpecification: &pointInTimeRecoverySpecificationProperty{
// pointInTimeRecoveryEnabled: jsii.Boolean(false),
// },
// readProvisionedThroughputSettings: &readProvisionedThroughputSettingsProperty{
// readCapacityAutoScalingSettings: &capacityAutoScalingSettingsProperty{
// maxCapacity: jsii.Number(123),
// minCapacity: jsii.Number(123),
// targetTrackingScalingPolicyConfiguration: &targetTrackingScalingPolicyConfigurationProperty{
// targetValue: jsii.Number(123),
//
// // the properties below are optional
// disableScaleIn: jsii.Boolean(false),
// scaleInCooldown: jsii.Number(123),
// scaleOutCooldown: jsii.Number(123),
// },
//
// // the properties below are optional
// seedCapacity: jsii.Number(123),
// },
// readCapacityUnits: jsii.Number(123),
// },
// sseSpecification: &replicaSSESpecificationProperty{
// kmsMasterKeyId: jsii.String("kmsMasterKeyId"),
// },
// tableClass: jsii.String("tableClass"),
// tags: []cfnTag{
// &cfnTag{
// key: jsii.String("key"),
// value: jsii.String("value"),
// },
// },
// },
// },
//
// // the properties below are optional
// billingMode: jsii.String("billingMode"),
// globalSecondaryIndexes: []interface{}{
// &globalSecondaryIndexProperty{
// indexName: jsii.String("indexName"),
// keySchema: []interface{}{
// &keySchemaProperty{
// attributeName: jsii.String("attributeName"),
// keyType: jsii.String("keyType"),
// },
// },
// projection: &projectionProperty{
// nonKeyAttributes: []*string{
// jsii.String("nonKeyAttributes"),
// },
// projectionType: jsii.String("projectionType"),
// },
//
// // the properties below are optional
// writeProvisionedThroughputSettings: &writeProvisionedThroughputSettingsProperty{
// writeCapacityAutoScalingSettings: &capacityAutoScalingSettingsProperty{
// maxCapacity: jsii.Number(123),
// minCapacity: jsii.Number(123),
// targetTrackingScalingPolicyConfiguration: &targetTrackingScalingPolicyConfigurationProperty{
// targetValue: jsii.Number(123),
//
// // the properties below are optional
// disableScaleIn: jsii.Boolean(false),
// scaleInCooldown: jsii.Number(123),
// scaleOutCooldown: jsii.Number(123),
// },
//
// // the properties below are optional
// seedCapacity: jsii.Number(123),
// },
// },
// },
// },
// localSecondaryIndexes: []interface{}{
// &localSecondaryIndexProperty{
// indexName: jsii.String("indexName"),
// keySchema: []interface{}{
// &keySchemaProperty{
// attributeName: jsii.String("attributeName"),
// keyType: jsii.String("keyType"),
// },
// },
// projection: &projectionProperty{
// nonKeyAttributes: []*string{
// jsii.String("nonKeyAttributes"),
// },
// projectionType: jsii.String("projectionType"),
// },
// },
// },
// sseSpecification: &sSESpecificationProperty{
// sseEnabled: jsii.Boolean(false),
//
// // the properties below are optional
// sseType: jsii.String("sseType"),
// },
// streamSpecification: &streamSpecificationProperty{
// streamViewType: jsii.String("streamViewType"),
// },
// tableName: jsii.String("tableName"),
// timeToLiveSpecification: &timeToLiveSpecificationProperty{
// enabled: jsii.Boolean(false),
//
// // the properties below are optional
// attributeName: jsii.String("attributeName"),
// },
// writeProvisionedThroughputSettings: &writeProvisionedThroughputSettingsProperty{
// writeCapacityAutoScalingSettings: &capacityAutoScalingSettingsProperty{
// maxCapacity: jsii.Number(123),
// minCapacity: jsii.Number(123),
// targetTrackingScalingPolicyConfiguration: &targetTrackingScalingPolicyConfigurationProperty{
// targetValue: jsii.Number(123),
//
// // the properties below are optional
// disableScaleIn: jsii.Boolean(false),
// scaleInCooldown: jsii.Number(123),
// scaleOutCooldown: jsii.Number(123),
// },
//
// // the properties below are optional
// seedCapacity: jsii.Number(123),
// },
// },
// })
//
type CfnGlobalTable interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) of the DynamoDB table, such as `arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable` .
//
// The ARN returned is that of the replica in the region the stack is deployed to.
AttrArn() *string
// A list of attributes that describe the key schema for the global table and indexes.
AttributeDefinitions() interface{}
SetAttributeDefinitions(val interface{})
// The ARN of the DynamoDB stream, such as `arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000` . The `StreamArn` returned is that of the replica in the region the stack is deployed to.
//
// > You must specify the `StreamSpecification` property to use this attribute.
AttrStreamArn() *string
// Unique identifier for the table, such as `a123b456-01ab-23cd-123a-111222aaabbb` .
//
// The `TableId` returned is that of the replica in the region the stack is deployed to.
AttrTableId() *string
// Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:.
//
// - `PAY_PER_REQUEST`
// - `PROVISIONED`
//
// All replicas in your global table will have the same billing mode. If you use `PROVISIONED` billing mode, you must provide an auto scaling configuration via the `WriteProvisionedThroughputSettings` property. The default value of this property is `PROVISIONED` .
BillingMode() *string
SetBillingMode(val *string)
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// Global secondary indexes to be created on the global table.
//
// You can create up to 20 global secondary indexes. Each replica in your global table will have the same global secondary index settings. You can only create or delete one global secondary index in a single stack operation.
//
// Since the backfilling of an index could take a long time, CloudFormation does not wait for the index to become active. If a stack operation rolls back, CloudFormation might not delete an index that has been added. In that case, you will need to delete the index manually.
GlobalSecondaryIndexes() interface{}
SetGlobalSecondaryIndexes(val interface{})
// Specifies the attributes that make up the primary key for the table.
//
// The attributes in the `KeySchema` property must also be defined in the `AttributeDefinitions` property.
KeySchema() interface{}
SetKeySchema(val interface{})
// Local secondary indexes to be created on the table.
//
// You can create up to five local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes. Each replica in your global table will have the same local secondary index settings.
LocalSecondaryIndexes() interface{}
SetLocalSecondaryIndexes(val interface{})
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// Specifies the list of replicas for your global table.
//
// The list must contain at least one element, the region where the stack defining the global table is deployed. For example, if you define your table in a stack deployed to us-east-1, you must have an entry in `Replicas` with the region us-east-1. You cannot remove the replica in the stack region.
//
// > Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an `UpdateStack` operation containing only that change.
// >
// > If you add or delete a replica during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new replica, you might need to manually delete the replica.
//
// You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.
Replicas() interface{}
SetReplicas(val interface{})
// Specifies the settings to enable server-side encryption.
//
// These settings will be applied to all replicas. If you plan to use customer-managed KMS keys, you must provide a key for each replica using the `ReplicaSpecification.ReplicaSSESpecification` property.
SseSpecification() interface{}
SetSseSpecification(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// Specifies the streams settings on your global table.
//
// You must provide a value for this property if your global table contains more than one replica. You can only change the streams settings if your global table has only one replica.
StreamSpecification() interface{}
SetStreamSpecification(val interface{})
// A name for the global table.
//
// If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
//
// > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
TableName() *string
SetTableName(val *string)
// Specifies the time to live (TTL) settings for the table.
//
// This setting will be applied to all replicas.
TimeToLiveSpecification() interface{}
SetTimeToLiveSpecification(val interface{})
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Specifies an auto scaling policy for write capacity.
//
// This policy will be applied to all replicas. This setting must be specified if `BillingMode` is set to `PROVISIONED` .
WriteProvisionedThroughputSettings() interface{}
SetWriteProvisionedThroughputSettings(val interface{})
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// ```typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// ```
// would add the overrides
// ```json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// ```
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
// The jsii proxy struct for CfnGlobalTable
type jsiiProxy_CfnGlobalTable struct {
internal.Type__awscdkCfnResource
internal.Type__awscdkIInspectable
}
func (j *jsiiProxy_CfnGlobalTable) AttrArn() *string {
var returns *string
_jsii_.Get(
j,
"attrArn",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) AttributeDefinitions() interface{} {
var returns interface{}
_jsii_.Get(
j,
"attributeDefinitions",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) AttrStreamArn() *string {
var returns *string
_jsii_.Get(
j,
"attrStreamArn",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) AttrTableId() *string {
var returns *string
_jsii_.Get(
j,
"attrTableId",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) BillingMode() *string {
var returns *string
_jsii_.Get(
j,
"billingMode",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) CfnOptions() awscdk.ICfnResourceOptions {
var returns awscdk.ICfnResourceOptions
_jsii_.Get(
j,
"cfnOptions",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) CfnProperties() *map[string]interface{} {
var returns *map[string]interface{}
_jsii_.Get(
j,
"cfnProperties",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) CfnResourceType() *string {
var returns *string
_jsii_.Get(
j,
"cfnResourceType",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) CreationStack() *[]*string {
var returns *[]*string
_jsii_.Get(
j,
"creationStack",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) GlobalSecondaryIndexes() interface{} {
var returns interface{}
_jsii_.Get(
j,
"globalSecondaryIndexes",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) KeySchema() interface{} {
var returns interface{}
_jsii_.Get(
j,
"keySchema",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) LocalSecondaryIndexes() interface{} {
var returns interface{}
_jsii_.Get(
j,
"localSecondaryIndexes",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) LogicalId() *string {
var returns *string
_jsii_.Get(
j,
"logicalId",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) Node() awscdk.ConstructNode {
var returns awscdk.ConstructNode
_jsii_.Get(
j,
"node",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) Ref() *string {
var returns *string
_jsii_.Get(
j,
"ref",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) Replicas() interface{} {
var returns interface{}
_jsii_.Get(
j,
"replicas",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) SseSpecification() interface{} {
var returns interface{}
_jsii_.Get(
j,
"sseSpecification",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) Stack() awscdk.Stack {
var returns awscdk.Stack
_jsii_.Get(
j,
"stack",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) StreamSpecification() interface{} {
var returns interface{}
_jsii_.Get(
j,
"streamSpecification",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) TableName() *string {
var returns *string
_jsii_.Get(
j,
"tableName",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) TimeToLiveSpecification() interface{} {
var returns interface{}
_jsii_.Get(
j,
"timeToLiveSpecification",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) UpdatedProperites() *map[string]interface{} {
var returns *map[string]interface{}
_jsii_.Get(
j,
"updatedProperites",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnGlobalTable) WriteProvisionedThroughputSettings() interface{} {
var returns interface{}
_jsii_.Get(
j,
"writeProvisionedThroughputSettings",
&returns,
)
return returns
}
// Create a new `AWS::DynamoDB::GlobalTable`.
func NewCfnGlobalTable(scope awscdk.Construct, id *string, props *CfnGlobalTableProps) CfnGlobalTable {
_init_.Initialize()
j := jsiiProxy_CfnGlobalTable{}
_jsii_.Create(
"monocdk.aws_dynamodb.CfnGlobalTable",
[]interface{}{scope, id, props},
&j,
)
return &j
}
// Create a new `AWS::DynamoDB::GlobalTable`.
func NewCfnGlobalTable_Override(c CfnGlobalTable, scope awscdk.Construct, id *string, props *CfnGlobalTableProps) {
_init_.Initialize()
_jsii_.Create(
"monocdk.aws_dynamodb.CfnGlobalTable",
[]interface{}{scope, id, props},
c,
)
}
func (j *jsiiProxy_CfnGlobalTable) SetAttributeDefinitions(val interface{}) {
_jsii_.Set(
j,
"attributeDefinitions",
val,
)
}
func (j *jsiiProxy_CfnGlobalTable) SetBillingMode(val *string) {
_jsii_.Set(
j,
"billingMode",
val,
)
}
func (j *jsiiProxy_CfnGlobalTable) SetGlobalSecondaryIndexes(val interface{}) {
_jsii_.Set(
j,
"globalSecondaryIndexes",
val,
)
}
func (j *jsiiProxy_CfnGlobalTable) SetKeySchema(val interface{}) {
_jsii_.Set(
j,
"keySchema",
val,
)
}
func (j *jsiiProxy_CfnGlobalTable) SetLocalSecondaryIndexes(val interface{}) {
_jsii_.Set(
j,
"localSecondaryIndexes",
val,
)
}
func (j *jsiiProxy_CfnGlobalTable) SetReplicas(val interface{}) {
_jsii_.Set(
j,
"replicas",
val,
)
}
func (j *jsiiProxy_CfnGlobalTable) SetSseSpecification(val interface{}) {
_jsii_.Set(
j,
"sseSpecification",
val,
)
}
func (j *jsiiProxy_CfnGlobalTable) SetStreamSpecification(val interface{}) {
_jsii_.Set(
j,
"streamSpecification",
val,
)
}
func (j *jsiiProxy_CfnGlobalTable) SetTableName(val *string) {
_jsii_.Set(
j,
"tableName",
val,
)
}
func (j *jsiiProxy_CfnGlobalTable) SetTimeToLiveSpecification(val interface{}) {
_jsii_.Set(
j,
"timeToLiveSpecification",
val,
)
}
func (j *jsiiProxy_CfnGlobalTable) SetWriteProvisionedThroughputSettings(val interface{}) {
_jsii_.Set(
j,
"writeProvisionedThroughputSettings",
val,
)
}
// Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
//
// Uses duck-typing instead of `instanceof` to allow stack elements from different
// versions of this library to be included in the same stack.
//
// Returns: The construct as a stack element or undefined if it is not a stack element.
// Experimental.
func CfnGlobalTable_IsCfnElement(x interface{}) *bool {
_init_.Initialize()
var returns *bool
_jsii_.StaticInvoke(
"monocdk.aws_dynamodb.CfnGlobalTable",
"isCfnElement",