-
Notifications
You must be signed in to change notification settings - Fork 17
/
CfnDBInstance.go
2626 lines (2393 loc) · 66.4 KB
/
CfnDBInstance.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 awsrds
import (
_init_ "github.com/aws/aws-cdk-go/awscdk/v2/jsii"
_jsii_ "github.com/aws/jsii-runtime-go/runtime"
"github.com/aws/aws-cdk-go/awscdk/v2"
"github.com/aws/aws-cdk-go/awscdk/v2/awsrds/internal"
"github.com/aws/constructs-go/constructs/v10"
)
// The `AWS::RDS::DBInstance` resource creates an Amazon DB instance.
//
// The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.
//
// For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide* .
//
// For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide* .
//
// If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.
//
// > If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) .
//
// *Updating DB instances*
//
// When properties labeled " *Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) " are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.
//
// > We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
// >
// > - Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
// > - Create a snapshot of the DB instance. For more information, see [Creating a DB Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html) .
// > - If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the `DBSnapshotIdentifier` property with the ID of the DB snapshot that you want to use.
// >
// > After you restore a DB instance with a `DBSnapshotIdentifier` property, you can delete the `DBSnapshotIdentifier` property. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the `DBSnapshotIdentifier` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified `DBSnapshotIdentifier` property, and the original DB instance is deleted.
// > - Update the stack.
//
// For more information about updating other properties of this resource, see `[ModifyDBInstance](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBInstance.html)` . For more information about updating stacks, see [AWS CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) .
//
// *Deleting DB instances*
//
// For DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to *retain* the DB instance, to *delete* the DB instance, or to *create a snapshot* of the DB instance. The default AWS CloudFormation behavior depends on the `DBClusterIdentifier` property:
//
// - For `AWS::RDS::DBInstance` resources that don't specify the `DBClusterIdentifier` property, AWS CloudFormation saves a snapshot of the DB instance.
// - For `AWS::RDS::DBInstance` resources that do specify the `DBClusterIdentifier` property, AWS CloudFormation deletes the DB instance.
//
// For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
//
// Example:
// // The code below shows an example of how to instantiate this type.
// // The values are placeholders you should change.
// import "github.com/aws/aws-cdk-go/awscdk"
//
// cfnDBInstance := awscdk.Aws_rds.NewCfnDBInstance(this, jsii.String("MyCfnDBInstance"), &CfnDBInstanceProps{
// AllocatedStorage: jsii.String("allocatedStorage"),
// AllowMajorVersionUpgrade: jsii.Boolean(false),
// AssociatedRoles: []interface{}{
// &DBInstanceRoleProperty{
// FeatureName: jsii.String("featureName"),
// RoleArn: jsii.String("roleArn"),
// },
// },
// AutomaticBackupReplicationKmsKeyId: jsii.String("automaticBackupReplicationKmsKeyId"),
// AutomaticBackupReplicationRegion: jsii.String("automaticBackupReplicationRegion"),
// AutoMinorVersionUpgrade: jsii.Boolean(false),
// AvailabilityZone: jsii.String("availabilityZone"),
// BackupRetentionPeriod: jsii.Number(123),
// CaCertificateIdentifier: jsii.String("caCertificateIdentifier"),
// CertificateDetails: &CertificateDetailsProperty{
// CaIdentifier: jsii.String("caIdentifier"),
// ValidTill: jsii.String("validTill"),
// },
// CertificateRotationRestart: jsii.Boolean(false),
// CharacterSetName: jsii.String("characterSetName"),
// CopyTagsToSnapshot: jsii.Boolean(false),
// CustomIamInstanceProfile: jsii.String("customIamInstanceProfile"),
// DbClusterIdentifier: jsii.String("dbClusterIdentifier"),
// DbClusterSnapshotIdentifier: jsii.String("dbClusterSnapshotIdentifier"),
// DbInstanceClass: jsii.String("dbInstanceClass"),
// DbInstanceIdentifier: jsii.String("dbInstanceIdentifier"),
// DbName: jsii.String("dbName"),
// DbParameterGroupName: jsii.String("dbParameterGroupName"),
// DbSecurityGroups: []*string{
// jsii.String("dbSecurityGroups"),
// },
// DbSnapshotIdentifier: jsii.String("dbSnapshotIdentifier"),
// DbSubnetGroupName: jsii.String("dbSubnetGroupName"),
// DedicatedLogVolume: jsii.Boolean(false),
// DeleteAutomatedBackups: jsii.Boolean(false),
// DeletionProtection: jsii.Boolean(false),
// Domain: jsii.String("domain"),
// DomainAuthSecretArn: jsii.String("domainAuthSecretArn"),
// DomainDnsIps: []*string{
// jsii.String("domainDnsIps"),
// },
// DomainFqdn: jsii.String("domainFqdn"),
// DomainIamRoleName: jsii.String("domainIamRoleName"),
// DomainOu: jsii.String("domainOu"),
// EnableCloudwatchLogsExports: []*string{
// jsii.String("enableCloudwatchLogsExports"),
// },
// EnableIamDatabaseAuthentication: jsii.Boolean(false),
// EnablePerformanceInsights: jsii.Boolean(false),
// Endpoint: &EndpointProperty{
// Address: jsii.String("address"),
// HostedZoneId: jsii.String("hostedZoneId"),
// Port: jsii.String("port"),
// },
// Engine: jsii.String("engine"),
// EngineVersion: jsii.String("engineVersion"),
// Iops: jsii.Number(123),
// KmsKeyId: jsii.String("kmsKeyId"),
// LicenseModel: jsii.String("licenseModel"),
// ManageMasterUserPassword: jsii.Boolean(false),
// MasterUsername: jsii.String("masterUsername"),
// MasterUserPassword: jsii.String("masterUserPassword"),
// MasterUserSecret: &MasterUserSecretProperty{
// KmsKeyId: jsii.String("kmsKeyId"),
// SecretArn: jsii.String("secretArn"),
// },
// MaxAllocatedStorage: jsii.Number(123),
// MonitoringInterval: jsii.Number(123),
// MonitoringRoleArn: jsii.String("monitoringRoleArn"),
// MultiAz: jsii.Boolean(false),
// NcharCharacterSetName: jsii.String("ncharCharacterSetName"),
// NetworkType: jsii.String("networkType"),
// OptionGroupName: jsii.String("optionGroupName"),
// PerformanceInsightsKmsKeyId: jsii.String("performanceInsightsKmsKeyId"),
// PerformanceInsightsRetentionPeriod: jsii.Number(123),
// Port: jsii.String("port"),
// PreferredBackupWindow: jsii.String("preferredBackupWindow"),
// PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"),
// ProcessorFeatures: []interface{}{
// &ProcessorFeatureProperty{
// Name: jsii.String("name"),
// Value: jsii.String("value"),
// },
// },
// PromotionTier: jsii.Number(123),
// PubliclyAccessible: jsii.Boolean(false),
// ReplicaMode: jsii.String("replicaMode"),
// RestoreTime: jsii.String("restoreTime"),
// SourceDbClusterIdentifier: jsii.String("sourceDbClusterIdentifier"),
// SourceDbInstanceAutomatedBackupsArn: jsii.String("sourceDbInstanceAutomatedBackupsArn"),
// SourceDbInstanceIdentifier: jsii.String("sourceDbInstanceIdentifier"),
// SourceDbiResourceId: jsii.String("sourceDbiResourceId"),
// SourceRegion: jsii.String("sourceRegion"),
// StorageEncrypted: jsii.Boolean(false),
// StorageThroughput: jsii.Number(123),
// StorageType: jsii.String("storageType"),
// Tags: []cfnTag{
// &cfnTag{
// Key: jsii.String("key"),
// Value: jsii.String("value"),
// },
// },
// TdeCredentialArn: jsii.String("tdeCredentialArn"),
// TdeCredentialPassword: jsii.String("tdeCredentialPassword"),
// Timezone: jsii.String("timezone"),
// UseDefaultProcessorFeatures: jsii.Boolean(false),
// UseLatestRestorableTime: jsii.Boolean(false),
// VpcSecurityGroups: []*string{
// jsii.String("vpcSecurityGroups"),
// },
// })
//
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html
//
type CfnDBInstance interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.
AllocatedStorage() *string
SetAllocatedStorage(val *string)
// A value that indicates whether major version upgrades are allowed.
AllowMajorVersionUpgrade() interface{}
SetAllowMajorVersionUpgrade(val interface{})
// The AWS Identity and Access Management (IAM) roles associated with the DB instance.
AssociatedRoles() interface{}
SetAssociatedRoles(val interface{})
// The CA identifier of the CA certificate used for the DB instance's server certificate.
AttrCertificateDetailsCaIdentifier() *string
// The expiration date of the DB instance’s server certificate.
AttrCertificateDetailsValidTill() *string
// The Amazon Resource Name (ARN) for the DB instance.
AttrDbInstanceArn() *string
// The AWS Region-unique, immutable identifier for the DB instance.
//
// This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
AttrDbiResourceId() *string
// The Oracle system ID (Oracle SID) for a container database (CDB).
//
// The Oracle SID is also the name of the CDB.
//
// This setting is valid for RDS Custom only.
AttrDbSystemId() *string
// The connection endpoint for the database. For example: `mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`.
//
// For Aurora Serverless DB clusters, the connection endpoint only applies to the DB cluster.
AttrEndpointAddress() *string
// The ID that Amazon Route 53 assigns when you create a hosted zone.
AttrEndpointHostedZoneId() *string
// The port number on which the database accepts connections.
//
// For example: `3306`.
AttrEndpointPort() *string
// The Amazon Resource Name (ARN) of the secret.
AttrMasterUserSecretSecretArn() *string
// The AWS KMS key identifier for encryption of the replicated automated backups.
AutomaticBackupReplicationKmsKeyId() *string
SetAutomaticBackupReplicationKmsKeyId(val *string)
// The destination region for the backup replication of the DB instance.
AutomaticBackupReplicationRegion() *string
SetAutomaticBackupReplicationRegion(val *string)
// A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.
AutoMinorVersionUpgrade() interface{}
SetAutoMinorVersionUpgrade(val interface{})
// The Availability Zone (AZ) where the database will be created.
AvailabilityZone() *string
SetAvailabilityZone(val *string)
// The number of days for which automated backups are retained.
BackupRetentionPeriod() *float64
SetBackupRetentionPeriod(val *float64)
// The identifier of the CA certificate for this DB instance.
CaCertificateIdentifier() *string
SetCaCertificateIdentifier(val *string)
// The details of the DB instance's server certificate.
CertificateDetails() interface{}
SetCertificateDetails(val interface{})
// Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
CertificateRotationRestart() interface{}
SetCertificateRotationRestart(val interface{})
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// For supported engines, indicates that the DB instance should be associated with the specified character set.
CharacterSetName() *string
SetCharacterSetName(val *string)
// Specifies whether to copy tags from the DB instance to snapshots of the DB instance.
CopyTagsToSnapshot() interface{}
SetCopyTagsToSnapshot(val interface{})
// 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.
CreationStack() *[]*string
// The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
CustomIamInstanceProfile() *string
SetCustomIamInstanceProfile(val *string)
// The identifier of the DB cluster that the instance will belong to.
DbClusterIdentifier() *string
SetDbClusterIdentifier(val *string)
// The identifier for the Multi-AZ DB cluster snapshot to restore from.
DbClusterSnapshotIdentifier() *string
SetDbClusterSnapshotIdentifier(val *string)
// The compute and memory capacity of the DB instance, for example `db.m5.large` . Not all DB instance classes are available in all AWS Regions , or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide* .
DbInstanceClass() *string
SetDbInstanceClass(val *string)
// A name for the DB instance.
DbInstanceIdentifier() *string
SetDbInstanceIdentifier(val *string)
// The meaning of this parameter differs according to the database engine you use.
DbName() *string
SetDbName(val *string)
// The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.
DbParameterGroupName() *string
SetDbParameterGroupName(val *string)
// A list of the DB security groups to assign to the DB instance.
DbSecurityGroups() *[]*string
SetDbSecurityGroups(val *[]*string)
// The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.
DbSnapshotIdentifier() *string
SetDbSnapshotIdentifier(val *string)
// A DB subnet group to associate with the DB instance.
DbSubnetGroupName() *string
SetDbSubnetGroupName(val *string)
// Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
DedicatedLogVolume() interface{}
SetDedicatedLogVolume(val interface{})
// A value that indicates whether to remove automated backups immediately after the DB instance is deleted.
DeleteAutomatedBackups() interface{}
SetDeleteAutomatedBackups(val interface{})
// A value that indicates whether the DB instance has deletion protection enabled.
DeletionProtection() interface{}
SetDeletionProtection(val interface{})
// The Active Directory directory ID to create the DB instance in.
Domain() *string
SetDomain(val *string)
// The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
DomainAuthSecretArn() *string
SetDomainAuthSecretArn(val *string)
// The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
DomainDnsIps() *[]*string
SetDomainDnsIps(val *[]*string)
// The fully qualified domain name (FQDN) of an Active Directory domain.
DomainFqdn() *string
SetDomainFqdn(val *string)
// The name of the IAM role to use when making API calls to the Directory Service.
DomainIamRoleName() *string
SetDomainIamRoleName(val *string)
// The Active Directory organizational unit for your DB instance to join.
DomainOu() *string
SetDomainOu(val *string)
// The list of log types that need to be enabled for exporting to CloudWatch Logs.
EnableCloudwatchLogsExports() *[]*string
SetEnableCloudwatchLogsExports(val *[]*string)
// A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
EnableIamDatabaseAuthentication() interface{}
SetEnableIamDatabaseAuthentication(val interface{})
// Specifies whether to enable Performance Insights for the DB instance.
EnablePerformanceInsights() interface{}
SetEnablePerformanceInsights(val interface{})
// The connection endpoint for the DB instance.
Endpoint() interface{}
SetEndpoint(val interface{})
// The name of the database engine to use for this DB instance.
Engine() *string
SetEngine(val *string)
// The version number of the database engine to use.
EngineVersion() *string
SetEngineVersion(val *string)
// The number of I/O operations per second (IOPS) that the database provisions.
Iops() *float64
SetIops(val *float64)
// The ARN of the AWS KMS key that's used to encrypt the DB instance, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` .
KmsKeyId() *string
SetKmsKeyId(val *string)
// License model information for this DB instance.
LicenseModel() *string
SetLicenseModel(val *string)
// 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.
LogicalId() *string
// Specifies whether to manage the master user password with AWS Secrets Manager.
ManageMasterUserPassword() interface{}
SetManageMasterUserPassword(val interface{})
// The master user name for the DB instance.
MasterUsername() *string
SetMasterUsername(val *string)
// The password for the master user.
//
// The password can include any printable ASCII character except "/", """, or "@".
MasterUserPassword() *string
SetMasterUserPassword(val *string)
// The secret managed by RDS in AWS Secrets Manager for the master user password.
MasterUserSecret() interface{}
SetMasterUserSecret(val interface{})
// The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
MaxAllocatedStorage() *float64
SetMaxAllocatedStorage(val *float64)
// The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
MonitoringInterval() *float64
SetMonitoringInterval(val *float64)
// The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
MonitoringRoleArn() *string
SetMonitoringRoleArn(val *string)
// Specifies whether the database instance is a Multi-AZ DB instance deployment.
MultiAz() interface{}
SetMultiAz(val interface{})
// The name of the NCHAR character set for the Oracle DB instance.
NcharCharacterSetName() *string
SetNcharCharacterSetName(val *string)
// The network type of the DB instance.
NetworkType() *string
SetNetworkType(val *string)
// The tree node.
Node() constructs.Node
// Indicates that the DB instance should be associated with the specified option group.
OptionGroupName() *string
SetOptionGroupName(val *string)
// The AWS KMS key identifier for encryption of Performance Insights data.
PerformanceInsightsKmsKeyId() *string
SetPerformanceInsightsKmsKeyId(val *string)
// The number of days to retain Performance Insights data.
PerformanceInsightsRetentionPeriod() *float64
SetPerformanceInsightsRetentionPeriod(val *float64)
// The port number on which the database accepts connections.
Port() *string
SetPort(val *string)
// The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter.
PreferredBackupWindow() *string
SetPreferredBackupWindow(val *string)
// The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PreferredMaintenanceWindow() *string
SetPreferredMaintenanceWindow(val *string)
// The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
ProcessorFeatures() interface{}
SetProcessorFeatures(val interface{})
// The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.
PromotionTier() *float64
SetPromotionTier(val *float64)
// Indicates whether the DB instance is an internet-facing instance.
PubliclyAccessible() interface{}
SetPubliclyAccessible(val interface{})
// 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 })`.
Ref() *string
// The open mode of an Oracle read replica.
ReplicaMode() *string
SetReplicaMode(val *string)
// The date and time to restore from.
RestoreTime() *string
SetRestoreTime(val *string)
// The identifier of the Multi-AZ DB cluster that will act as the source for the read replica.
SourceDbClusterIdentifier() *string
SetSourceDbClusterIdentifier(val *string)
// The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE` .
SourceDbInstanceAutomatedBackupsArn() *string
SetSourceDbInstanceAutomatedBackupsArn(val *string)
// If you want to create a read replica DB instance, specify the ID of the source DB instance.
SourceDbInstanceIdentifier() *string
SetSourceDbInstanceIdentifier(val *string)
// The resource ID of the source DB instance from which to restore.
SourceDbiResourceId() *string
SetSourceDbiResourceId(val *string)
// The ID of the region that contains the source DB instance for the read replica.
SourceRegion() *string
SetSourceRegion(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// A value that indicates whether the DB instance is encrypted.
//
// By default, it isn't encrypted.
StorageEncrypted() interface{}
SetStorageEncrypted(val interface{})
// Specifies the storage throughput value for the DB instance.
//
// This setting applies only to the `gp3` storage type.
StorageThroughput() *float64
SetStorageThroughput(val *float64)
// The storage type to associate with the DB instance.
StorageType() *string
SetStorageType(val *string)
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An optional array of key-value pairs to apply to this DB instance.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated: this property has been deprecated.
TdeCredentialArn() *string
// Deprecated: this property has been deprecated.
SetTdeCredentialArn(val *string)
// Deprecated: this property has been deprecated.
TdeCredentialPassword() *string
// Deprecated: this property has been deprecated.
SetTdeCredentialPassword(val *string)
// The time zone of the DB instance.
Timezone() *string
SetTimezone(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]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.
UpdatedProperties() *map[string]interface{}
// Specifies whether the DB instance class of the DB instance uses its default processor features.
UseDefaultProcessorFeatures() interface{}
SetUseDefaultProcessorFeatures(val interface{})
// Specifies whether the DB instance is restored from the latest backup time.
UseLatestRestorableTime() interface{}
SetUseLatestRestorableTime(val interface{})
// A list of the VPC security group IDs to assign to the DB instance.
VpcSecurityGroups() *[]*string
SetVpcSecurityGroups(val *[]*string)
// Syntactic sugar for `addOverride(path, undefined)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
// The jsii proxy struct for CfnDBInstance
type jsiiProxy_CfnDBInstance struct {
internal.Type__awscdkCfnResource
internal.Type__awscdkIInspectable
internal.Type__awscdkITaggable
}
func (j *jsiiProxy_CfnDBInstance) AllocatedStorage() *string {
var returns *string
_jsii_.Get(
j,
"allocatedStorage",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) AllowMajorVersionUpgrade() interface{} {
var returns interface{}
_jsii_.Get(
j,
"allowMajorVersionUpgrade",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) AssociatedRoles() interface{} {
var returns interface{}
_jsii_.Get(
j,
"associatedRoles",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) AttrCertificateDetailsCaIdentifier() *string {
var returns *string
_jsii_.Get(
j,
"attrCertificateDetailsCaIdentifier",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) AttrCertificateDetailsValidTill() *string {
var returns *string
_jsii_.Get(
j,
"attrCertificateDetailsValidTill",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) AttrDbInstanceArn() *string {
var returns *string
_jsii_.Get(
j,
"attrDbInstanceArn",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) AttrDbiResourceId() *string {
var returns *string
_jsii_.Get(
j,
"attrDbiResourceId",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) AttrDbSystemId() *string {
var returns *string
_jsii_.Get(
j,
"attrDbSystemId",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) AttrEndpointAddress() *string {
var returns *string
_jsii_.Get(
j,
"attrEndpointAddress",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) AttrEndpointHostedZoneId() *string {
var returns *string
_jsii_.Get(
j,
"attrEndpointHostedZoneId",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) AttrEndpointPort() *string {
var returns *string
_jsii_.Get(
j,
"attrEndpointPort",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) AttrMasterUserSecretSecretArn() *string {
var returns *string
_jsii_.Get(
j,
"attrMasterUserSecretSecretArn",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) AutomaticBackupReplicationKmsKeyId() *string {
var returns *string
_jsii_.Get(
j,
"automaticBackupReplicationKmsKeyId",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) AutomaticBackupReplicationRegion() *string {
var returns *string
_jsii_.Get(
j,
"automaticBackupReplicationRegion",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) AutoMinorVersionUpgrade() interface{} {
var returns interface{}
_jsii_.Get(
j,
"autoMinorVersionUpgrade",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) AvailabilityZone() *string {
var returns *string
_jsii_.Get(
j,
"availabilityZone",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) BackupRetentionPeriod() *float64 {
var returns *float64
_jsii_.Get(
j,
"backupRetentionPeriod",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) CaCertificateIdentifier() *string {
var returns *string
_jsii_.Get(
j,
"caCertificateIdentifier",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) CertificateDetails() interface{} {
var returns interface{}
_jsii_.Get(
j,
"certificateDetails",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) CertificateRotationRestart() interface{} {
var returns interface{}
_jsii_.Get(
j,
"certificateRotationRestart",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) CfnOptions() awscdk.ICfnResourceOptions {
var returns awscdk.ICfnResourceOptions
_jsii_.Get(
j,
"cfnOptions",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) CfnProperties() *map[string]interface{} {
var returns *map[string]interface{}
_jsii_.Get(
j,
"cfnProperties",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) CfnResourceType() *string {
var returns *string
_jsii_.Get(
j,
"cfnResourceType",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) CharacterSetName() *string {
var returns *string
_jsii_.Get(
j,
"characterSetName",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) CopyTagsToSnapshot() interface{} {
var returns interface{}
_jsii_.Get(
j,
"copyTagsToSnapshot",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) CreationStack() *[]*string {
var returns *[]*string
_jsii_.Get(
j,
"creationStack",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) CustomIamInstanceProfile() *string {
var returns *string
_jsii_.Get(
j,
"customIamInstanceProfile",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) DbClusterIdentifier() *string {
var returns *string
_jsii_.Get(
j,
"dbClusterIdentifier",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) DbClusterSnapshotIdentifier() *string {
var returns *string
_jsii_.Get(
j,
"dbClusterSnapshotIdentifier",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) DbInstanceClass() *string {
var returns *string
_jsii_.Get(
j,
"dbInstanceClass",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) DbInstanceIdentifier() *string {
var returns *string
_jsii_.Get(
j,
"dbInstanceIdentifier",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) DbName() *string {
var returns *string
_jsii_.Get(
j,
"dbName",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) DbParameterGroupName() *string {
var returns *string
_jsii_.Get(
j,
"dbParameterGroupName",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) DbSecurityGroups() *[]*string {
var returns *[]*string
_jsii_.Get(
j,
"dbSecurityGroups",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) DbSnapshotIdentifier() *string {
var returns *string
_jsii_.Get(
j,
"dbSnapshotIdentifier",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) DbSubnetGroupName() *string {
var returns *string
_jsii_.Get(
j,
"dbSubnetGroupName",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) DedicatedLogVolume() interface{} {
var returns interface{}
_jsii_.Get(
j,
"dedicatedLogVolume",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) DeleteAutomatedBackups() interface{} {
var returns interface{}
_jsii_.Get(
j,
"deleteAutomatedBackups",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnDBInstance) DeletionProtection() interface{} {
var returns interface{}
_jsii_.Get(