-
Notifications
You must be signed in to change notification settings - Fork 47
/
db_instance.go
1391 lines (1382 loc) · 59.6 KB
/
db_instance.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
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License"). You may
// not use this file except in compliance with the License. A copy of the
// License is located at
//
// http://aws.amazon.com/apache2.0/
//
// or in the "license" file accompanying this file. This file is distributed
// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
// express or implied. See the License for the specific language governing
// permissions and limitations under the License.
// Code generated by ack-generate. DO NOT EDIT.
package v1alpha1
import (
ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
// DBInstanceSpec defines the desired state of DBInstance.
//
// Contains the details of an Amazon RDS DB instance.
//
// This data type is used as a response element in the operations CreateDBInstance,
// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,
// PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
type DBInstanceSpec struct {
// The amount of storage in gibibytes (GiB) to allocate for the DB instance.
//
// Type: Integer
//
// # Amazon Aurora
//
// Not applicable. Aurora cluster volumes automatically grow as the amount of
// data in your database increases, though you are only charged for the space
// that you use in an Aurora cluster volume.
//
// # Amazon RDS Custom
//
// Constraints to the amount of storage for each storage type are the following:
//
// - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40
// to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
//
// - Provisioned IOPS storage (io1): Must be an integer from 40 to 65536
// for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
//
// # MySQL
//
// Constraints to the amount of storage for each storage type are the following:
//
// - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
// to 65536.
//
// - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
//
// - Magnetic storage (standard): Must be an integer from 5 to 3072.
//
// # MariaDB
//
// Constraints to the amount of storage for each storage type are the following:
//
// - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
// to 65536.
//
// - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
//
// - Magnetic storage (standard): Must be an integer from 5 to 3072.
//
// # PostgreSQL
//
// Constraints to the amount of storage for each storage type are the following:
//
// - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
// to 65536.
//
// - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
//
// - Magnetic storage (standard): Must be an integer from 5 to 3072.
//
// # Oracle
//
// Constraints to the amount of storage for each storage type are the following:
//
// - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
// to 65536.
//
// - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
//
// - Magnetic storage (standard): Must be an integer from 10 to 3072.
//
// # SQL Server
//
// Constraints to the amount of storage for each storage type are the following:
//
// - General Purpose (SSD) storage (gp2, gp3): Enterprise and Standard editions:
// Must be an integer from 20 to 16384. Web and Express editions: Must be
// an integer from 20 to 16384.
//
// - Provisioned IOPS storage (io1): Enterprise and Standard editions: Must
// be an integer from 100 to 16384. Web and Express editions: Must be an
// integer from 100 to 16384.
//
// - Magnetic storage (standard): Enterprise and Standard editions: Must
// be an integer from 20 to 1024. Web and Express editions: Must be an integer
// from 20 to 1024.
AllocatedStorage *int64 `json:"allocatedStorage,omitempty"`
// A value that indicates whether minor engine upgrades are applied automatically
// to the DB instance during the maintenance window. By default, minor engine
// upgrades are applied automatically.
//
// If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade
// to false.
AutoMinorVersionUpgrade *bool `json:"autoMinorVersionUpgrade,omitempty"`
// The Availability Zone (AZ) where the database will be created. For information
// on Amazon Web Services Regions and Availability Zones, see Regions and Availability
// Zones (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).
//
// # Amazon Aurora
//
// Each Aurora DB cluster hosts copies of its storage in three separate Availability
// Zones. Specify one of these Availability Zones. Aurora automatically chooses
// an appropriate Availability Zone if you don't specify one.
//
// Default: A random, system-chosen Availability Zone in the endpoint's Amazon
// Web Services Region.
//
// Example: us-east-1d
//
// Constraint: The AvailabilityZone parameter can't be specified if the DB instance
// is a Multi-AZ deployment. The specified Availability Zone must be in the
// same Amazon Web Services Region as the current endpoint.
AvailabilityZone *string `json:"availabilityZone,omitempty"`
// The number of days for which automated backups are retained. Setting this
// parameter to a positive number enables backups. Setting this parameter to
// 0 disables automated backups.
//
// # Amazon Aurora
//
// Not applicable. The retention period for automated backups is managed by
// the DB cluster.
//
// Default: 1
//
// Constraints:
//
// - Must be a value from 0 to 35
//
// - Can't be set to 0 if the DB instance is a source to read replicas
//
// - Can't be set to 0 for an RDS Custom for Oracle DB instance
BackupRetentionPeriod *int64 `json:"backupRetentionPeriod,omitempty"`
// Specifies where automated backups and manual snapshots are stored.
//
// Possible values are outposts (Amazon Web Services Outposts) and region (Amazon
// Web Services Region). The default is region.
//
// For more information, see Working with Amazon RDS on Amazon Web Services
// Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
// in the Amazon RDS User Guide.
BackupTarget *string `json:"backupTarget,omitempty"`
// Specifies the CA certificate identifier to use for the DB instance’s server
// certificate.
//
// This setting doesn't apply to RDS Custom.
//
// For more information, see Using SSL/TLS to encrypt a connection to a DB instance
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html)
// in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to
// a DB cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html)
// in the Amazon Aurora User Guide.
CACertificateIdentifier *string `json:"caCertificateIdentifier,omitempty"`
// For supported engines, this value indicates that the DB instance should be
// associated with the specified CharacterSet.
//
// This setting doesn't apply to RDS Custom. However, if you need to change
// the character set, you can change it on the database itself.
//
// # Amazon Aurora
//
// Not applicable. The character set is managed by the DB cluster. For more
// information, see CreateDBCluster.
CharacterSetName *string `json:"characterSetName,omitempty"`
// A value that indicates whether to copy tags from the DB instance to snapshots
// of the DB instance. By default, tags are not copied.
//
// # Amazon Aurora
//
// Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting
// this value for an Aurora DB instance has no effect on the DB cluster setting.
CopyTagsToSnapshot *bool `json:"copyTagsToSnapshot,omitempty"`
// The instance profile associated with the underlying Amazon EC2 instance of
// an RDS Custom DB instance. The instance profile must meet the following requirements:
//
// - The profile must exist in your account.
//
// - The profile must have an IAM role that Amazon EC2 has permissions to
// assume.
//
// - The instance profile name and the associated IAM role name must start
// with the prefix AWSRDSCustom.
//
// For the list of permissions required for the IAM role, see Configure IAM
// and your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc)
// in the Amazon RDS User Guide.
//
// This setting is required for RDS Custom.
CustomIAMInstanceProfile *string `json:"customIAMInstanceProfile,omitempty"`
// The identifier of the DB cluster that the instance will belong to.
//
// This setting doesn't apply to RDS Custom.
DBClusterIdentifier *string `json:"dbClusterIdentifier,omitempty"`
// The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore
// from.
//
// For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
// in the Amazon RDS User Guide.
//
// Constraints:
//
// - Must match the identifier of an existing Multi-AZ DB cluster snapshot.
//
// - Can't be specified when DBSnapshotIdentifier is specified.
//
// - Must be specified when DBSnapshotIdentifier isn't specified.
//
// - If you are restoring from a shared manual Multi-AZ DB cluster snapshot,
// the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
//
// - Can't be the identifier of an Aurora DB cluster snapshot.
//
// - Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster
// snapshot.
DBClusterSnapshotIdentifier *string `json:"dbClusterSnapshotIdentifier,omitempty"`
// The compute and memory capacity of the DB instance, for example db.m5.large.
// Not all DB instance classes are available in all Amazon Web Services 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.
// +kubebuilder:validation:Required
DBInstanceClass *string `json:"dbInstanceClass"`
// The DB instance identifier. This parameter is stored as a lowercase string.
//
// Constraints:
//
// - Must contain from 1 to 63 letters, numbers, or hyphens.
//
// - First character must be a letter.
//
// - Can't end with a hyphen or contain two consecutive hyphens.
//
// Example: mydbinstance
// +kubebuilder:validation:Required
DBInstanceIdentifier *string `json:"dbInstanceIdentifier"`
// The meaning of this parameter differs according to the database engine you
// use.
//
// # MySQL
//
// The name of the database to create when the DB instance is created. If this
// parameter isn't specified, no database is created in the DB instance.
//
// Constraints:
//
// - Must contain 1 to 64 letters or numbers.
//
// - Must begin with a letter. Subsequent characters can be letters, underscores,
// or digits (0-9).
//
// - Can't be a word reserved by the specified database engine
//
// # MariaDB
//
// The name of the database to create when the DB instance is created. If this
// parameter isn't specified, no database is created in the DB instance.
//
// Constraints:
//
// - Must contain 1 to 64 letters or numbers.
//
// - Must begin with a letter. Subsequent characters can be letters, underscores,
// or digits (0-9).
//
// - Can't be a word reserved by the specified database engine
//
// # PostgreSQL
//
// The name of the database to create when the DB instance is created. If this
// parameter isn't specified, a database named postgres is created in the DB
// instance.
//
// Constraints:
//
// - Must contain 1 to 63 letters, numbers, or underscores.
//
// - Must begin with a letter. Subsequent characters can be letters, underscores,
// or digits (0-9).
//
// - Can't be a word reserved by the specified database engine
//
// # Oracle
//
// The Oracle System ID (SID) of the created DB instance. If you specify null,
// the default value ORCL is used. You can't specify the string NULL, or any
// other reserved word, for DBName.
//
// Default: ORCL
//
// Constraints:
//
// - Can't be longer than 8 characters
//
// # Amazon RDS Custom for Oracle
//
// The Oracle System ID (SID) of the created RDS Custom DB instance. If you
// don't specify a value, the default value is ORCL.
//
// Default: ORCL
//
// Constraints:
//
// - It must contain 1 to 8 alphanumeric characters.
//
// - It must contain a letter.
//
// - It can't be a word reserved by the database engine.
//
// # Amazon RDS Custom for SQL Server
//
// Not applicable. Must be null.
//
// # SQL Server
//
// Not applicable. Must be null.
//
// # Amazon Aurora MySQL
//
// The name of the database to create when the primary DB instance of the Aurora
// MySQL DB cluster is created. If this parameter isn't specified for an Aurora
// MySQL DB cluster, no database is created in the DB cluster.
//
// Constraints:
//
// - It must contain 1 to 64 alphanumeric characters.
//
// - It can't be a word reserved by the database engine.
//
// # Amazon Aurora PostgreSQL
//
// The name of the database to create when the primary DB instance of the Aurora
// PostgreSQL DB cluster is created. If this parameter isn't specified for an
// Aurora PostgreSQL DB cluster, a database named postgres is created in the
// DB cluster.
//
// Constraints:
//
// - It must contain 1 to 63 alphanumeric characters.
//
// - It must begin with a letter. Subsequent characters can be letters, underscores,
// or digits (0 to 9).
//
// - It can't be a word reserved by the database engine.
DBName *string `json:"dbName,omitempty"`
// The name of the DB parameter group to associate with this DB instance. If
// you do not specify a value, then the default DB parameter group for the specified
// DB engine and version is used.
//
// This setting doesn't apply to RDS Custom.
//
// Constraints:
//
// - It must be 1 to 255 letters, numbers, or hyphens.
//
// - The first character must be a letter.
//
// - It can't end with a hyphen or contain two consecutive hyphens.
DBParameterGroupName *string `json:"dbParameterGroupName,omitempty"`
DBParameterGroupRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"dbParameterGroupRef,omitempty"`
// The identifier for the DB snapshot to restore from.
//
// Constraints:
//
// - Must match the identifier of an existing DBSnapshot.
//
// - Can't be specified when DBClusterSnapshotIdentifier is specified.
//
// - Must be specified when DBClusterSnapshotIdentifier isn't specified.
//
// - If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
// must be the ARN of the shared DB snapshot.
DBSnapshotIdentifier *string `json:"dbSnapshotIdentifier,omitempty"`
// A DB subnet group to associate with this DB instance.
//
// Constraints: Must match the name of an existing DBSubnetGroup. Must not be
// default.
//
// Example: mydbsubnetgroup
DBSubnetGroupName *string `json:"dbSubnetGroupName,omitempty"`
DBSubnetGroupRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"dbSubnetGroupRef,omitempty"`
// A value that indicates whether the DB instance has deletion protection enabled.
// The database can't be deleted when deletion protection is enabled. By default,
// deletion protection isn't enabled. For more information, see Deleting a DB
// Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
//
// # Amazon Aurora
//
// Not applicable. You can enable or disable deletion protection for the DB
// cluster. For more information, see CreateDBCluster. DB instances in a DB
// cluster can be deleted even when deletion protection is enabled for the DB
// cluster.
DeletionProtection *bool `json:"deletionProtection,omitempty"`
// DestinationRegion is used for presigning the request to a given region.
DestinationRegion *string `json:"destinationRegion,omitempty"`
// The Active Directory directory ID to create the DB instance in. Currently,
// only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can
// be created in an Active Directory Domain.
//
// For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html)
// in the Amazon RDS User Guide.
//
// This setting doesn't apply to RDS Custom.
//
// # Amazon Aurora
//
// Not applicable. The domain is managed by the DB cluster.
Domain *string `json:"domain,omitempty"`
// Specify the name of the IAM role to be used when making API calls to the
// Directory Service.
//
// This setting doesn't apply to RDS Custom.
//
// # Amazon Aurora
//
// Not applicable. The domain is managed by the DB cluster.
DomainIAMRoleName *string `json:"domainIAMRoleName,omitempty"`
// The list of log types that need to be enabled for exporting to CloudWatch
// Logs. The values in the list depend on the DB engine. For more information,
// see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
// in the Amazon RDS User Guide.
//
// # Amazon Aurora
//
// Not applicable. CloudWatch Logs exports are managed by the DB cluster.
//
// # RDS Custom
//
// Not applicable.
//
// # MariaDB
//
// Possible values are audit, error, general, and slowquery.
//
// # Microsoft SQL Server
//
// Possible values are agent and error.
//
// # MySQL
//
// Possible values are audit, error, general, and slowquery.
//
// # Oracle
//
// Possible values are alert, audit, listener, trace, and oemagent.
//
// # PostgreSQL
//
// Possible values are postgresql and upgrade.
EnableCloudwatchLogsExports []*string `json:"enableCloudwatchLogsExports,omitempty"`
// A value that indicates whether to enable a customer-owned IP address (CoIP)
// for an RDS on Outposts DB instance.
//
// A CoIP provides local or external connectivity to resources in your Outpost
// subnets through your on-premises network. For some use cases, a CoIP can
// provide lower latency for connections to the DB instance from outside of
// its virtual private cloud (VPC) on your local network.
//
// For more information about RDS on Outposts, see Working with Amazon RDS on
// Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
// in the Amazon RDS User Guide.
//
// For more information about CoIPs, see Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing)
// in the Amazon Web Services Outposts User Guide.
EnableCustomerOwnedIP *bool `json:"enableCustomerOwnedIP,omitempty"`
// A value that indicates whether to enable mapping of Amazon Web Services Identity
// and Access Management (IAM) accounts to database accounts. By default, mapping
// isn't enabled.
//
// For more information, see IAM Database Authentication for MySQL and PostgreSQL
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)
// in the Amazon RDS User Guide.
//
// This setting doesn't apply to RDS Custom.
//
// # Amazon Aurora
//
// Not applicable. Mapping Amazon Web Services IAM accounts to database accounts
// is managed by the DB cluster.
EnableIAMDatabaseAuthentication *bool `json:"enableIAMDatabaseAuthentication,omitempty"`
// The name of the database engine to be used for this instance.
//
// Not every database engine is available for every Amazon Web Services Region.
//
// Valid Values:
//
// - aurora (for MySQL 5.6-compatible Aurora)
//
// - aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
//
// - aurora-postgresql
//
// - custom-oracle-ee (for RDS Custom for Oracle instances)
//
// - custom-sqlserver-ee (for RDS Custom for SQL Server instances)
//
// - custom-sqlserver-se (for RDS Custom for SQL Server instances)
//
// - custom-sqlserver-web (for RDS Custom for SQL Server instances)
//
// - mariadb
//
// - mysql
//
// - oracle-ee
//
// - oracle-ee-cdb
//
// - oracle-se2
//
// - oracle-se2-cdb
//
// - postgres
//
// - sqlserver-ee
//
// - sqlserver-se
//
// - sqlserver-ex
//
// - sqlserver-web
//
// +kubebuilder:validation:Required
Engine *string `json:"engine"`
// The version number of the database engine to use.
//
// For a list of valid engine versions, use the DescribeDBEngineVersions operation.
//
// The following are the database engines and links to information about the
// major and minor versions that are available with Amazon RDS. Not every database
// engine is available for every Amazon Web Services Region.
//
// # Amazon Aurora
//
// Not applicable. The version number of the database engine to be used by the
// DB instance is managed by the DB cluster.
//
// # Amazon RDS Custom for Oracle
//
// A custom engine version (CEV) that you have previously created. This setting
// is required for RDS Custom for Oracle. The CEV name has the following format:
// 19.customized_string. A valid CEV name is 19.my_cev1. For more information,
// see Creating an RDS Custom for Oracle DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create)
// in the Amazon RDS User Guide.
//
// # Amazon RDS Custom for SQL Server
//
// See RDS Custom for SQL Server general requirements (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html)
// in the Amazon RDS User Guide.
//
// # MariaDB
//
// For information, see MariaDB on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)
// in the Amazon RDS User Guide.
//
// # Microsoft SQL Server
//
// For information, see Microsoft SQL Server Versions on Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport)
// in the Amazon RDS User Guide.
//
// # MySQL
//
// For information, see MySQL on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)
// in the Amazon RDS User Guide.
//
// # Oracle
//
// For information, see Oracle Database Engine Release Notes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html)
// in the Amazon RDS User Guide.
//
// # PostgreSQL
//
// For information, see Amazon RDS for PostgreSQL versions and extensions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts)
// in the Amazon RDS User Guide.
EngineVersion *string `json:"engineVersion,omitempty"`
// The amount of Provisioned IOPS (input/output operations per second) to be
// initially allocated for the DB instance. For information about valid IOPS
// values, see Amazon RDS DB instance storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html)
// in the Amazon RDS User Guide.
//
// Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must
// be a multiple between .5 and 50 of the storage amount for the DB instance.
// For SQL Server DB instances, must be a multiple between 1 and 50 of the storage
// amount for the DB instance.
//
// # Amazon Aurora
//
// Not applicable. Storage is managed by the DB cluster.
IOPS *int64 `json:"iops,omitempty"`
// The Amazon Web Services KMS key identifier for an encrypted DB instance.
//
// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
// ARN, or alias name for the KMS key. To use a KMS key in a different Amazon
// Web Services account, specify the key ARN or alias ARN.
//
// # Amazon Aurora
//
// Not applicable. The Amazon Web Services KMS key identifier is managed by
// the DB cluster. For more information, see CreateDBCluster.
//
// If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId
// parameter, then Amazon RDS uses your default KMS key. There is a default
// KMS key for your Amazon Web Services account. Your Amazon Web Services account
// has a different default KMS key for each Amazon Web Services Region.
//
// # Amazon RDS Custom
//
// A KMS key is required for RDS Custom instances. For most RDS engines, if
// you leave this parameter empty while enabling StorageEncrypted, the engine
// uses the default KMS key. However, RDS Custom doesn't use the default key
// when this parameter is empty. You must explicitly specify a key.
KMSKeyID *string `json:"kmsKeyID,omitempty"`
KMSKeyRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"kmsKeyRef,omitempty"`
// License model information for this DB instance.
//
// Valid values: license-included | bring-your-own-license | general-public-license
//
// This setting doesn't apply to RDS Custom.
//
// # Amazon Aurora
//
// Not applicable.
LicenseModel *string `json:"licenseModel,omitempty"`
// A value that indicates whether to manage the master user password with Amazon
// Web Services Secrets Manager.
//
// For more information, see Password management with Amazon Web Services Secrets
// Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html)
// in the Amazon RDS User Guide.
//
// Constraints:
//
// - Can't manage the master user password with Amazon Web Services Secrets
// Manager if MasterUserPassword is specified.
ManageMasterUserPassword *bool `json:"manageMasterUserPassword,omitempty"`
// The password for the master user. The password can include any printable
// ASCII character except "/", """, or "@".
//
// # Amazon Aurora
//
// Not applicable. The password for the master user is managed by the DB cluster.
//
// Constraints: Can't be specified if ManageMasterUserPassword is turned on.
//
// # MariaDB
//
// Constraints: Must contain from 8 to 41 characters.
//
// # Microsoft SQL Server
//
// Constraints: Must contain from 8 to 128 characters.
//
// # MySQL
//
// Constraints: Must contain from 8 to 41 characters.
//
// # Oracle
//
// Constraints: Must contain from 8 to 30 characters.
//
// # PostgreSQL
//
// Constraints: Must contain from 8 to 128 characters.
MasterUserPassword *ackv1alpha1.SecretKeyReference `json:"masterUserPassword,omitempty"`
// The Amazon Web Services KMS key identifier to encrypt a secret that is automatically
// generated and managed in Amazon Web Services Secrets Manager.
//
// This setting is valid only if the master user password is managed by RDS
// in Amazon Web Services Secrets Manager for the DB instance.
//
// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
// ARN, or alias name for the KMS key. To use a KMS key in a different Amazon
// Web Services account, specify the key ARN or alias ARN.
//
// If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager
// KMS key is used to encrypt the secret. If the secret is in a different Amazon
// Web Services account, then you can't use the aws/secretsmanager KMS key to
// encrypt the secret, and you must use a customer managed KMS key.
//
// There is a default KMS key for your Amazon Web Services account. Your Amazon
// Web Services account has a different default KMS key for each Amazon Web
// Services Region.
MasterUserSecretKMSKeyID *string `json:"masterUserSecretKMSKeyID,omitempty"`
MasterUserSecretKMSKeyRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"masterUserSecretKMSKeyRef,omitempty"`
// The name for the master user.
//
// # Amazon Aurora
//
// Not applicable. The name for the master user is managed by the DB cluster.
//
// # Amazon RDS
//
// Constraints:
//
// - Required.
//
// - Must be 1 to 16 letters, numbers, or underscores.
//
// - First character must be a letter.
//
// - Can't be a reserved word for the chosen database engine.
MasterUsername *string `json:"masterUsername,omitempty"`
// The upper limit in gibibytes (GiB) to which Amazon RDS can automatically
// scale the storage of the DB instance.
//
// For more information about this setting, including limitations that apply
// to it, see Managing capacity automatically with Amazon RDS storage autoscaling
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling)
// in the Amazon RDS User Guide.
//
// This setting doesn't apply to RDS Custom.
//
// # Amazon Aurora
//
// Not applicable. Storage is managed by the DB cluster.
MaxAllocatedStorage *int64 `json:"maxAllocatedStorage,omitempty"`
// The interval, in seconds, between points when Enhanced Monitoring metrics
// are collected for the DB instance. To disable collection of Enhanced Monitoring
// metrics, specify 0. The default is 0.
//
// If MonitoringRoleArn is specified, then you must set MonitoringInterval to
// a value other than 0.
//
// This setting doesn't apply to RDS Custom.
//
// Valid Values: 0, 1, 5, 10, 15, 30, 60
MonitoringInterval *int64 `json:"monitoringInterval,omitempty"`
// The ARN for the IAM role that permits RDS to send enhanced monitoring metrics
// to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.
// For information on creating a monitoring role, see Setting Up and Enabling
// Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling)
// in the Amazon RDS User Guide.
//
// If MonitoringInterval is set to a value other than 0, then you must supply
// a MonitoringRoleArn value.
//
// This setting doesn't apply to RDS Custom.
MonitoringRoleARN *string `json:"monitoringRoleARN,omitempty"`
// A value that indicates whether the DB instance is a Multi-AZ deployment.
// You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ
// deployment.
//
// This setting doesn't apply to RDS Custom.
//
// # Amazon Aurora
//
// Not applicable. DB instance Availability Zones (AZs) are managed by the DB
// cluster.
MultiAZ *bool `json:"multiAZ,omitempty"`
// The name of the NCHAR character set for the Oracle DB instance.
//
// This parameter doesn't apply to RDS Custom.
NcharCharacterSetName *string `json:"ncharCharacterSetName,omitempty"`
// The network type of the DB instance.
//
// Valid values:
//
// - IPV4
//
// - DUAL
//
// The network type is determined by the DBSubnetGroup specified for the DB
// instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4
// and the IPv6 protocols (DUAL).
//
// For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
// in the Amazon RDS User Guide.
NetworkType *string `json:"networkType,omitempty"`
// A value that indicates that the DB instance should be associated with the
// specified option group.
//
// Permanent options, such as the TDE option for Oracle Advanced Security TDE,
// can't be removed from an option group. Also, that option group can't be removed
// from a DB instance after it is associated with a DB instance.
//
// This setting doesn't apply to RDS Custom.
//
// # Amazon Aurora
//
// Not applicable.
OptionGroupName *string `json:"optionGroupName,omitempty"`
// A value that indicates whether to enable Performance Insights for the DB
// instance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)
// in the Amazon RDS User Guide.
//
// This setting doesn't apply to RDS Custom.
PerformanceInsightsEnabled *bool `json:"performanceInsightsEnabled,omitempty"`
// The Amazon Web Services KMS key identifier for encryption of Performance
// Insights data.
//
// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
// ARN, or alias name for the KMS key.
//
// If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon
// RDS uses your default KMS key. There is a default KMS key for your Amazon
// Web Services account. Your Amazon Web Services account has a different default
// KMS key for each Amazon Web Services Region.
//
// This setting doesn't apply to RDS Custom.
PerformanceInsightsKMSKeyID *string `json:"performanceInsightsKMSKeyID,omitempty"`
// The number of days to retain Performance Insights data. The default is 7
// days. The following values are valid:
//
// - 7
//
// - month * 31, where month is a number of months from 1-23
//
// - 731
//
// For example, the following values are valid:
//
// - 93 (3 months * 31)
//
// - 341 (11 months * 31)
//
// - 589 (19 months * 31)
//
// - 731
//
// If you specify a retention period such as 94, which isn't a valid value,
// RDS issues an error.
//
// This setting doesn't apply to RDS Custom.
PerformanceInsightsRetentionPeriod *int64 `json:"performanceInsightsRetentionPeriod,omitempty"`
// The port number on which the database accepts connections.
//
// # MySQL
//
// Default: 3306
//
// Valid values: 1150-65535
//
// Type: Integer
//
// # MariaDB
//
// Default: 3306
//
// Valid values: 1150-65535
//
// Type: Integer
//
// # PostgreSQL
//
// Default: 5432
//
// Valid values: 1150-65535
//
// Type: Integer
//
// # Oracle
//
// Default: 1521
//
// Valid values: 1150-65535
//
// # SQL Server
//
// Default: 1433
//
// Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and
// 49152-49156.
//
// # Amazon Aurora
//
// Default: 3306
//
// Valid values: 1150-65535
//
// Type: Integer
Port *int64 `json:"port,omitempty"`
// When you are creating a read replica from one Amazon Web Services GovCloud
// (US) Region to another or from one China Amazon Web Services Region to another,
// the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica
// API operation in the source Amazon Web Services Region that contains the
// source DB instance.
//
// This setting applies only to Amazon Web Services GovCloud (US) Regions and
// China Amazon Web Services Regions. It's ignored in other Amazon Web Services
// Regions.
//
// This setting applies only when replicating from a source DB instance. Source
// DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions
// and China Amazon Web Services Regions.
//
// You must specify this parameter when you create an encrypted read replica
// from another Amazon Web Services Region by using the Amazon RDS API. Don't
// specify PreSignedUrl when you are creating an encrypted read replica in the
// same Amazon Web Services Region.
//
// The presigned URL must be a valid request for the CreateDBInstanceReadReplica
// API operation that can run in the source Amazon Web Services Region that
// contains the encrypted source DB instance. The presigned URL request must
// contain the following parameter values:
//
// - DestinationRegion - The Amazon Web Services Region that the encrypted
// read replica is created in. This Amazon Web Services Region is the same
// one where the CreateDBInstanceReadReplica operation is called that contains
// this presigned URL. For example, if you create an encrypted DB instance
// in the us-west-1 Amazon Web Services Region, from a source DB instance
// in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica
// operation in the us-east-1 Amazon Web Services Region and provide a presigned
// URL that contains a call to the CreateDBInstanceReadReplica operation
// in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion
// in the presigned URL must be set to the us-east-1 Amazon Web Services
// Region.
//
// - KmsKeyId - The KMS key identifier for the key to use to encrypt the
// read replica in the destination Amazon Web Services Region. This is the
// same identifier for both the CreateDBInstanceReadReplica operation that
// is called in the destination Amazon Web Services Region, and the operation
// contained in the presigned URL.
//
// - SourceDBInstanceIdentifier - The DB instance identifier for the encrypted
// DB instance to be replicated. This identifier must be in the Amazon Resource
// Name (ARN) format for the source Amazon Web Services Region. For example,
// if you are creating an encrypted read replica from a DB instance in the
// us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier
// looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
//
// To learn how to generate a Signature Version 4 signed request, see Authenticating
// Requests: Using Query Parameters (Amazon Web Services Signature Version 4)
// (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html)
// and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
//
// If you are using an Amazon Web Services SDK tool or the CLI, you can specify
// SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl
// manually. Specifying SourceRegion autogenerates a presigned URL that is a
// valid request for the operation that can run in the source Amazon Web Services
// Region.
//
// SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server
// doesn't support cross-Region read replicas.
//
// This setting doesn't apply to RDS Custom.
PreSignedURL *string `json:"preSignedURL,omitempty"`
// The daily time range during which automated backups are created if automated
// backups are enabled, using the BackupRetentionPeriod parameter. The default
// is a 30-minute window selected at random from an 8-hour block of time for
// each Amazon Web Services Region. For more information, see Backup window
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow)
// in the Amazon RDS User Guide.
//
// # Amazon Aurora
//
// Not applicable. The daily time range for creating automated backups is managed
// by the DB cluster.
//
// Constraints:
//
// - Must be in the format hh24:mi-hh24:mi.
//
// - Must be in Universal Coordinated Time (UTC).
//
// - Must not conflict with the preferred maintenance window.
//
// - Must be at least 30 minutes.
PreferredBackupWindow *string `json:"preferredBackupWindow,omitempty"`
// The time range each week during which system maintenance can occur, in Universal
// Coordinated Time (UTC). For more information, see Amazon RDS Maintenance
// Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance).
//
// Format: ddd:hh24:mi-ddd:hh24:mi
//
// The default is a 30-minute window selected at random from an 8-hour block
// of time for each Amazon Web Services Region, occurring on a random day of
// the week.
//
// Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
//
// Constraints: Minimum 30-minute window.
PreferredMaintenanceWindow *string `json:"preferredMaintenanceWindow,omitempty"`
// The number of CPU cores and the number of threads per core for the DB instance
// class of the DB instance.
//