/
types.go
4700 lines (3527 loc) · 173 KB
/
types.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
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// Describes a quota for an Amazon Web Services account. The following are account
// quotas:
// - AllocatedStorage - The total allocated storage per account, in GiB. The used
// value is the total allocated storage in the account, in GiB.
// - AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB
// security group. The used value is the highest number of ingress rules in a DB
// security group in the account. Other DB security groups in the account might
// have a lower number of ingress rules.
// - CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster.
// The used value is the highest number of custom endpoints in a DB clusters in the
// account. Other DB clusters in the account might have a lower number of custom
// endpoints.
// - DBClusterParameterGroups - The number of DB cluster parameter groups per
// account, excluding default parameter groups. The used value is the count of
// nondefault DB cluster parameter groups in the account.
// - DBClusterRoles - The number of associated Amazon Web Services Identity and
// Access Management (IAM) roles per DB cluster. The used value is the highest
// number of associated IAM roles for a DB cluster in the account. Other DB
// clusters in the account might have a lower number of associated IAM roles.
// - DBClusters - The number of DB clusters per account. The used value is the
// count of DB clusters in the account.
// - DBInstanceRoles - The number of associated IAM roles per DB instance. The
// used value is the highest number of associated IAM roles for a DB instance in
// the account. Other DB instances in the account might have a lower number of
// associated IAM roles.
// - DBInstances - The number of DB instances per account. The used value is the
// count of the DB instances in the account. Amazon RDS DB instances, Amazon Aurora
// DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to
// this quota.
// - DBParameterGroups - The number of DB parameter groups per account, excluding
// default parameter groups. The used value is the count of nondefault DB parameter
// groups in the account.
// - DBSecurityGroups - The number of DB security groups (not VPC security
// groups) per account, excluding the default security group. The used value is the
// count of nondefault DB security groups in the account.
// - DBSubnetGroups - The number of DB subnet groups per account. The used value
// is the count of the DB subnet groups in the account.
// - EventSubscriptions - The number of event subscriptions per account. The used
// value is the count of the event subscriptions in the account.
// - ManualClusterSnapshots - The number of manual DB cluster snapshots per
// account. The used value is the count of the manual DB cluster snapshots in the
// account.
// - ManualSnapshots - The number of manual DB instance snapshots per account.
// The used value is the count of the manual DB instance snapshots in the account.
// - OptionGroups - The number of DB option groups per account, excluding default
// option groups. The used value is the count of nondefault DB option groups in the
// account.
// - ReadReplicasPerMaster - The number of read replicas per DB instance. The
// used value is the highest number of read replicas for a DB instance in the
// account. Other DB instances in the account might have a lower number of read
// replicas.
// - ReservedDBInstances - The number of reserved DB instances per account. The
// used value is the count of the active reserved DB instances in the account.
// - SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The
// used value is highest number of subnets for a DB subnet group in the account.
// Other DB subnet groups in the account might have a lower number of subnets.
//
// For more information, see Quotas for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html)
// in the Amazon RDS User Guide and Quotas for Amazon Aurora (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html)
// in the Amazon Aurora User Guide.
type AccountQuota struct {
// The name of the Amazon RDS quota for this Amazon Web Services account.
AccountQuotaName *string
// The maximum allowed value for the quota.
Max *int64
// The amount currently used toward the quota maximum.
Used *int64
noSmithyDocumentSerde
}
// Contains Availability Zone information. This data type is used as an element in
// the OrderableDBInstanceOption data type.
type AvailabilityZone struct {
// The name of the Availability Zone.
Name *string
noSmithyDocumentSerde
}
// Contains the available processor feature information for the DB instance class
// of a DB instance. For more information, see Configuring the Processor of the DB
// Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor)
// in the Amazon RDS User Guide.
type AvailableProcessorFeature struct {
// The allowed values for the processor feature of the DB instance class.
AllowedValues *string
// The default value for the processor feature of the DB instance class.
DefaultValue *string
// The name of the processor feature. Valid names are coreCount and threadsPerCore .
Name *string
noSmithyDocumentSerde
}
// Details about a blue/green deployment. For more information, see Using Amazon
// RDS Blue/Green Deployments for database updates (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html)
// in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for
// database updates (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html)
// in the Amazon Aurora User Guide.
type BlueGreenDeployment struct {
// The unique identifier of the blue/green deployment.
BlueGreenDeploymentIdentifier *string
// The user-supplied name of the blue/green deployment.
BlueGreenDeploymentName *string
// The time when the blue/green deployment was created, in Universal Coordinated
// Time (UTC).
CreateTime *time.Time
// The time when the blue/green deployment was deleted, in Universal Coordinated
// Time (UTC).
DeleteTime *time.Time
// The source database for the blue/green deployment. Before switchover, the
// source database is the production database in the blue environment.
Source *string
// The status of the blue/green deployment. Valid Values:
// - PROVISIONING - Resources are being created in the green environment.
// - AVAILABLE - Resources are available in the green environment.
// - SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue
// environment to the green environment.
// - SWITCHOVER_COMPLETED - Switchover from the blue environment to the green
// environment is complete.
// - INVALID_CONFIGURATION - Resources in the green environment are invalid, so
// switchover isn't possible.
// - SWITCHOVER_FAILED - Switchover was attempted but failed.
// - DELETING - The blue/green deployment is being deleted.
Status *string
// Additional information about the status of the blue/green deployment.
StatusDetails *string
// The details about each source and target resource in the blue/green deployment.
SwitchoverDetails []SwitchoverDetail
// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
// in the Amazon RDS User Guide.
TagList []Tag
// The target database for the blue/green deployment. Before switchover, the
// target database is the clone database in the green environment.
Target *string
// Either tasks to be performed or tasks that have been completed on the target
// database before switchover.
Tasks []BlueGreenDeploymentTask
noSmithyDocumentSerde
}
// Details about a task for a blue/green deployment. For more information, see
// Using Amazon RDS Blue/Green Deployments for database updates (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html)
// in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for
// database updates (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html)
// in the Amazon Aurora User Guide.
type BlueGreenDeploymentTask struct {
// The name of the blue/green deployment task.
Name *string
// The status of the blue/green deployment task. Valid Values:
// - PENDING - The resource is being prepared for deployment.
// - IN_PROGRESS - The resource is being deployed.
// - COMPLETED - The resource has been deployed.
// - FAILED - Deployment of the resource failed.
Status *string
noSmithyDocumentSerde
}
// A CA certificate for an Amazon Web Services account. 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.
type Certificate struct {
// The Amazon Resource Name (ARN) for the certificate.
CertificateArn *string
// The unique key that identifies a certificate.
CertificateIdentifier *string
// The type of the certificate.
CertificateType *string
// Indicates whether there is an override for the default certificate identifier.
CustomerOverride *bool
// If there is an override for the default certificate identifier, when the
// override expires.
CustomerOverrideValidTill *time.Time
// The thumbprint of the certificate.
Thumbprint *string
// The starting date from which the certificate is valid.
ValidFrom *time.Time
// The final date that the certificate continues to be valid.
ValidTill *time.Time
noSmithyDocumentSerde
}
// Returns the details of the DB instance’s server certificate. 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.
type CertificateDetails struct {
// The CA identifier of the CA certificate used for the DB instance's server
// certificate.
CAIdentifier *string
// The expiration date of the DB instance’s server certificate.
ValidTill *time.Time
noSmithyDocumentSerde
}
// This data type is used as a response element in the action
// DescribeDBEngineVersions .
type CharacterSet struct {
// The description of the character set.
CharacterSetDescription *string
// The name of the character set.
CharacterSetName *string
noSmithyDocumentSerde
}
// The configuration setting for the log types to be enabled for export to
// CloudWatch Logs for a specific DB instance or DB cluster. The EnableLogTypes
// and DisableLogTypes arrays determine which logs will be exported (or not
// exported) to CloudWatch Logs. The values within these arrays depend on the DB
// engine being used. For more information about exporting CloudWatch Logs for
// Amazon RDS DB instances, 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. For more information about exporting CloudWatch
// Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon
// CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
// in the Amazon Aurora User Guide.
type CloudwatchLogsExportConfiguration struct {
// The list of log types to disable.
DisableLogTypes []string
// The list of log types to enable.
EnableLogTypes []string
noSmithyDocumentSerde
}
// This data type is used as a response element in the ModifyDBCluster operation
// and contains changes that will be applied during the next maintenance window.
type ClusterPendingModifiedValues struct {
// The allocated storage size in gibibytes (GiB) for all database engines except
// Amazon Aurora. For Aurora, AllocatedStorage always returns 1, because Aurora DB
// cluster storage size isn't fixed, but instead automatically adjusts as needed.
AllocatedStorage *int32
// The number of days for which automatic DB snapshots are retained.
BackupRetentionPeriod *int32
// Returns the details of the DB instance’s server certificate. 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.
CertificateDetails *CertificateDetails
// The DBClusterIdentifier value for the DB cluster.
DBClusterIdentifier *string
// The database engine version.
EngineVersion *string
// Indicates whether mapping of Amazon Web Services Identity and Access Management
// (IAM) accounts to database accounts is enabled.
IAMDatabaseAuthenticationEnabled *bool
// The Provisioned IOPS (I/O operations per second) value. This setting is only
// for non-Aurora Multi-AZ DB clusters.
Iops *int32
// The master credentials for the DB cluster.
MasterUserPassword *string
// A list of the log types whose configuration is still pending. In other words,
// these log types are in the process of being activated or deactivated.
PendingCloudwatchLogsExports *PendingCloudwatchLogsExports
// Reserved for future use.
RdsCustomClusterConfiguration *RdsCustomClusterConfiguration
// The storage type for the DB cluster.
StorageType *string
noSmithyDocumentSerde
}
// Specifies the settings that control the size and behavior of the connection
// pool associated with a DBProxyTargetGroup .
type ConnectionPoolConfiguration struct {
// The number of seconds for a proxy to wait for a connection to become available
// in the connection pool. This setting only applies when the proxy has opened its
// maximum number of connections and all connections are busy with client sessions.
// For an unlimited wait time, specify 0 . Default: 120 Constraints:
// - Must be between 0 and 3600.
ConnectionBorrowTimeout *int32
// One or more SQL statements for the proxy to run when opening each new database
// connection. Typically used with SET statements to make sure that each
// connection has identical settings such as time zone and character set. For
// multiple statements, use semicolons as the separator. You can also include
// multiple variables in a single SET statement, such as SET x=1, y=2 . Default: no
// initialization query
InitQuery *string
// The maximum size of the connection pool for each target in a target group. The
// value is expressed as a percentage of the max_connections setting for the RDS
// DB instance or Aurora DB cluster used by the target group. If you specify
// MaxIdleConnectionsPercent , then you must also include a value for this
// parameter. Default: 10 for RDS for Microsoft SQL Server, and 100 for all other
// engines Constraints:
// - Must be between 1 and 100.
MaxConnectionsPercent *int32
// A value that controls how actively the proxy closes idle database connections
// in the connection pool. The value is expressed as a percentage of the
// max_connections setting for the RDS DB instance or Aurora DB cluster used by the
// target group. With a high value, the proxy leaves a high percentage of idle
// database connections open. A low value causes the proxy to close more idle
// connections and return them to the database. If you specify this parameter, then
// you must also include a value for MaxConnectionsPercent . Default: The default
// value is half of the value of MaxConnectionsPercent . For example, if
// MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent
// is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL
// Server, MaxIdleConnectionsPercent is 5 , and for all other engines, the default
// is 50 . Constraints:
// - Must be between 0 and the value of MaxConnectionsPercent .
MaxIdleConnectionsPercent *int32
// Each item in the list represents a class of SQL operations that normally cause
// all later statements in a session using a proxy to be pinned to the same
// underlying database connection. Including an item in the list exempts that class
// of SQL operations from the pinning behavior. Default: no session pinning filters
SessionPinningFilters []string
noSmithyDocumentSerde
}
// Displays the settings that control the size and behavior of the connection pool
// associated with a DBProxyTarget .
type ConnectionPoolConfigurationInfo struct {
// The number of seconds for a proxy to wait for a connection to become available
// in the connection pool. Only applies when the proxy has opened its maximum
// number of connections and all connections are busy with client sessions.
ConnectionBorrowTimeout *int32
// One or more SQL statements for the proxy to run when opening each new database
// connection. Typically used with SET statements to make sure that each
// connection has identical settings such as time zone and character set. This
// setting is empty by default. For multiple statements, use semicolons as the
// separator. You can also include multiple variables in a single SET statement,
// such as SET x=1, y=2 .
InitQuery *string
// The maximum size of the connection pool for each target in a target group. The
// value is expressed as a percentage of the max_connections setting for the RDS
// DB instance or Aurora DB cluster used by the target group.
MaxConnectionsPercent *int32
// Controls how actively the proxy closes idle database connections in the
// connection pool. The value is expressed as a percentage of the max_connections
// setting for the RDS DB instance or Aurora DB cluster used by the target group.
// With a high value, the proxy leaves a high percentage of idle database
// connections open. A low value causes the proxy to close more idle connections
// and return them to the database.
MaxIdleConnectionsPercent *int32
// Each item in the list represents a class of SQL operations that normally cause
// all later statements in a session using a proxy to be pinned to the same
// underlying database connection. Including an item in the list exempts that class
// of SQL operations from the pinning behavior. This setting is only supported for
// MySQL engine family databases. Currently, the only allowed value is
// EXCLUDE_VARIABLE_SETS .
SessionPinningFilters []string
noSmithyDocumentSerde
}
// The additional attributes of RecommendedAction data type.
type ContextAttribute struct {
// The key of ContextAttribute .
Key *string
// The value of ContextAttribute .
Value *string
noSmithyDocumentSerde
}
// A value that indicates the AMI information.
type CustomDBEngineVersionAMI struct {
// A value that indicates the ID of the AMI.
ImageId *string
// A value that indicates the status of a custom engine version (CEV).
Status *string
noSmithyDocumentSerde
}
// Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For
// an Amazon Aurora DB cluster, this data type is used as a response element in the
// operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters ,
// FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster ,
// RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot ,
// RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster . For a
// Multi-AZ DB cluster, this data type is used as a response element in the
// operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters ,
// FailoverDBCluster , ModifyDBCluster , RebootDBCluster ,
// RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . For more
// information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
// in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters,
// see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
// in the Amazon RDS User Guide.
type DBCluster struct {
// The name of the Amazon Kinesis data stream used for the database activity
// stream.
ActivityStreamKinesisStreamName *string
// The Amazon Web Services KMS key identifier used for encrypting messages in the
// database activity stream. The Amazon Web Services KMS key identifier is the key
// ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKmsKeyId *string
// The mode of the database activity stream. Database events such as a change or
// access generate an activity stream event. The database session can handle these
// events either synchronously or asynchronously.
ActivityStreamMode ActivityStreamMode
// The status of the database activity stream.
ActivityStreamStatus ActivityStreamStatus
// For all database engines except Amazon Aurora, AllocatedStorage specifies the
// allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always
// returns 1, because Aurora DB cluster storage size isn't fixed, but instead
// automatically adjusts as needed.
AllocatedStorage *int32
// A list of the Amazon Web Services Identity and Access Management (IAM) roles
// that are associated with the DB cluster. IAM roles that are associated with a DB
// cluster grant permission for the DB cluster to access other Amazon Web Services
// on your behalf.
AssociatedRoles []DBClusterRole
// Indicates whether minor version patches are applied automatically. This setting
// is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade *bool
// The time when a stopped DB cluster is restarted automatically.
AutomaticRestartTime *time.Time
// The list of Availability Zones (AZs) where instances in the DB cluster can be
// created.
AvailabilityZones []string
// The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services
// Backup.
AwsBackupRecoveryPointArn *string
// The number of change records stored for Backtrack.
BacktrackConsumedChangeRecords *int64
// The target backtrack window, in seconds. If this value is set to 0 ,
// backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
BacktrackWindow *int64
// The number of days for which automatic DB snapshots are retained.
BackupRetentionPeriod *int32
// The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0
// (zero) when the cluster is paused. For more information about Aurora Serverless
// v1, see Using Amazon Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html)
// in the Amazon Aurora User Guide.
Capacity *int32
// Returns the details of the DB instance’s server certificate. 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.
CertificateDetails *CertificateDetails
// If present, specifies the name of the character set that this cluster is
// associated with.
CharacterSetName *string
// The ID of the clone group with which the DB cluster is associated.
CloneGroupId *string
// The time when the DB cluster was created, in Universal Coordinated Time (UTC).
ClusterCreateTime *time.Time
// Indicates whether tags are copied from the DB cluster to snapshots of the DB
// cluster.
CopyTagsToSnapshot *bool
// Indicates whether the DB cluster is a clone of a DB cluster owned by a
// different Amazon Web Services account.
CrossAccountClone *bool
// The custom endpoints associated with the DB cluster.
CustomEndpoints []string
// The Amazon Resource Name (ARN) for the DB cluster.
DBClusterArn *string
// The user-supplied identifier for the DB cluster. This identifier is the unique
// key that identifies a DB cluster.
DBClusterIdentifier *string
// The name of the compute and memory capacity class of the DB instance. This
// setting is only for non-Aurora Multi-AZ DB clusters.
DBClusterInstanceClass *string
// The list of DB instances that make up the DB cluster.
DBClusterMembers []DBClusterMember
// The list of option group memberships for this DB cluster.
DBClusterOptionGroupMemberships []DBClusterOptionGroupStatus
// The name of the DB cluster parameter group for the DB cluster.
DBClusterParameterGroup *string
// Information about the subnet group associated with the DB cluster, including
// the name, description, and subnets in the subnet group.
DBSubnetGroup *string
// Reserved for future use.
DBSystemId *string
// The name of the initial database that was specified for the DB cluster when it
// was created, if one was provided. This same name is returned for the life of the
// DB cluster.
DatabaseName *string
// The Amazon Web Services Region-unique, immutable identifier for the DB cluster.
// This identifier is found in Amazon Web Services CloudTrail log entries whenever
// the KMS key for the DB cluster is accessed.
DbClusterResourceId *string
// Indicates whether the DB cluster has deletion protection enabled. The database
// can't be deleted when deletion protection is enabled.
DeletionProtection *bool
// The Active Directory Domain membership records associated with the DB cluster.
DomainMemberships []DomainMembership
// The earliest time to which a DB cluster can be backtracked.
EarliestBacktrackTime *time.Time
// The earliest time to which a database can be restored with point-in-time
// restore.
EarliestRestorableTime *time.Time
// A list of log types that this DB cluster is configured to export to CloudWatch
// Logs. Log types vary by DB engine. For information about the log types for each
// DB engine, see Amazon RDS Database Log Files (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html)
// in the Amazon Aurora User Guide.
EnabledCloudwatchLogsExports []string
// The connection endpoint for the primary instance of the DB cluster.
Endpoint *string
// The database engine used for this DB cluster.
Engine *string
// The DB engine mode of the DB cluster, either provisioned or serverless . For
// more information, see CreateDBCluster (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html)
// .
EngineMode *string
// The version of the database engine.
EngineVersion *string
// Indicates whether write forwarding is enabled for a secondary cluster in an
// Aurora global database. Because write forwarding takes time to enable, check the
// value of GlobalWriteForwardingStatus to confirm that the request has completed
// before using the write forwarding feature for this cluster.
GlobalWriteForwardingRequested *bool
// The status of write forwarding for a secondary cluster in an Aurora global
// database.
GlobalWriteForwardingStatus WriteForwardingStatus
// The ID that Amazon Route 53 assigns when you create a hosted zone.
HostedZoneId *string
// Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster. When
// enabled, the HTTP endpoint provides a connectionless web service API (RDS Data
// API) for running SQL queries on the DB cluster. You can also query your database
// from inside the RDS console with the RDS query editor. For more information, see
// Using RDS Data API (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)
// in the Amazon Aurora User Guide.
HttpEndpointEnabled *bool
// Indicates whether the mapping of Amazon Web Services Identity and Access
// Management (IAM) accounts to database accounts is enabled.
IAMDatabaseAuthenticationEnabled *bool
// The next time you can modify the DB cluster to use the aurora-iopt1 storage
// type. This setting is only for Aurora DB clusters.
IOOptimizedNextAllowedModificationTime *time.Time
// The Provisioned IOPS (I/O operations per second) value. This setting is only
// for non-Aurora Multi-AZ DB clusters.
Iops *int32
// If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for
// the encrypted DB cluster. The Amazon Web Services KMS key identifier is the key
// ARN, key ID, alias ARN, or alias name for the KMS key.
KmsKeyId *string
// The latest time to which a database can be restored with point-in-time restore.
LatestRestorableTime *time.Time
// The details for Aurora Limitless Database.
LimitlessDatabase *LimitlessDatabase
// Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled,
// not enabled, requested, or is in the process of enabling it.
LocalWriteForwardingStatus LocalWriteForwardingStatus
// The secret managed by RDS in Amazon Web Services Secrets Manager for the master
// user password. 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 and Password management with Amazon Web Services
// Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html)
// in the Amazon Aurora User Guide.
MasterUserSecret *MasterUserSecret
// The master username for the DB cluster.
MasterUsername *string
// The interval, in seconds, between points when Enhanced Monitoring metrics are
// collected for the DB cluster. This setting is only for non-Aurora Multi-AZ DB
// clusters.
MonitoringInterval *int32
// The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics
// to Amazon CloudWatch Logs. This setting is only for non-Aurora Multi-AZ DB
// clusters.
MonitoringRoleArn *string
// Indicates whether the DB cluster has instances in multiple Availability Zones.
MultiAZ *bool
// The network type of the DB instance. The network type is determined by the
// DBSubnetGroup specified for the DB cluster. 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/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
// in the Amazon Aurora User Guide. This setting is only for Aurora DB clusters.
// Valid Values: IPV4 | DUAL
NetworkType *string
// Information about pending changes to the DB cluster. This information is
// returned only when there are pending changes. Specific changes are identified by
// subelements.
PendingModifiedValues *ClusterPendingModifiedValues
// The progress of the operation as a percentage.
PercentProgress *string
// Indicates whether Performance Insights is enabled for the DB cluster. This
// setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled *bool
// 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. This setting is only for
// non-Aurora Multi-AZ DB clusters.
PerformanceInsightsKMSKeyId *string
// The number of days to retain Performance Insights data. This setting is only
// for non-Aurora Multi-AZ DB clusters. Valid Values:
// - 7
// - month * 31, where month is a number of months from 1-23. Examples: 93 (3
// months * 31), 341 (11 months * 31), 589 (19 months * 31)
// - 731
// Default: 7 days
PerformanceInsightsRetentionPeriod *int32
// The port that the database engine is listening on.
Port *int32
// The daily time range during which automated backups are created if automated
// backups are enabled, as determined by the BackupRetentionPeriod .
PreferredBackupWindow *string
// The weekly time range during which system maintenance can occur, in Universal
// Coordinated Time (UTC).
PreferredMaintenanceWindow *string
// Indicates whether the DB cluster is publicly accessible. When the DB cluster is
// publicly accessible, its Domain Name System (DNS) endpoint resolves to the
// private IP address from within the DB cluster's virtual private cloud (VPC). It
// resolves to the public IP address from outside of the DB cluster's VPC. Access
// to the DB cluster is ultimately controlled by the security group it uses. That
// public access isn't permitted if the security group assigned to the DB cluster
// doesn't permit it. When the DB cluster isn't publicly accessible, it is an
// internal DB cluster with a DNS name that resolves to a private IP address. For
// more information, see CreateDBCluster . This setting is only for non-Aurora
// Multi-AZ DB clusters.
PubliclyAccessible *bool
// Reserved for future use.
RdsCustomClusterConfiguration *RdsCustomClusterConfiguration
// Contains one or more identifiers of the read replicas associated with this DB
// cluster.
ReadReplicaIdentifiers []string
// The reader endpoint for the DB cluster. The reader endpoint for a DB cluster
// load-balances connections across the Aurora Replicas that are available in a DB
// cluster. As clients request new connections to the reader endpoint, Aurora
// distributes the connection requests among the Aurora Replicas in the DB cluster.
// This functionality can help balance your read workload across multiple Aurora
// Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that
// you are connected to is promoted to be the primary instance, your connection is
// dropped. To continue sending your read workload to other Aurora Replicas in the
// cluster, you can then reconnect to the reader endpoint.
ReaderEndpoint *string
// The identifier of the source DB cluster if this DB cluster is a read replica.
ReplicationSourceIdentifier *string
// The scaling configuration for an Aurora DB cluster in serverless DB engine
// mode. For more information, see Using Amazon Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html)
// in the Amazon Aurora User Guide.
ScalingConfigurationInfo *ScalingConfigurationInfo
// The scaling configuration for an Aurora Serverless v2 DB cluster. For more
// information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html)
// in the Amazon Aurora User Guide.
ServerlessV2ScalingConfiguration *ServerlessV2ScalingConfigurationInfo
// The current state of this DB cluster.
Status *string
// Reserved for future use.
StatusInfos []DBClusterStatusInfo
// Indicates whether the DB cluster is encrypted.
StorageEncrypted *bool
// The storage throughput for the DB cluster. The throughput is automatically set
// based on the IOPS that you provision, and is not configurable. This setting is
// only for non-Aurora Multi-AZ DB clusters.
StorageThroughput *int32
// The storage type associated with the DB cluster.
StorageType *string
// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
// in the Amazon RDS User Guide.
TagList []Tag
// The list of VPC security groups that the DB cluster belongs to.
VpcSecurityGroups []VpcSecurityGroupMembership
noSmithyDocumentSerde
}
// An automated backup of a DB cluster. It consists of system backups, transaction
// logs, and the database cluster properties that existed at the time you deleted
// the source cluster.
type DBClusterAutomatedBackup struct {
// For all database engines except Amazon Aurora, AllocatedStorage specifies the
// allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always
// returns 1, because Aurora DB cluster storage size isn't fixed, but instead
// automatically adjusts as needed.
AllocatedStorage *int32
// The Availability Zones where instances in the DB cluster can be created. For
// information on Amazon Web Services Regions and Availability Zones, see Regions
// and Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html)
// .
AvailabilityZones []string
// The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services
// Backup.
AwsBackupRecoveryPointArn *string
// The retention period for the automated backups.
BackupRetentionPeriod *int32
// The time when the DB cluster was created, in Universal Coordinated Time (UTC).
ClusterCreateTime *time.Time
// The Amazon Resource Name (ARN) for the source DB cluster.
DBClusterArn *string
// The Amazon Resource Name (ARN) for the automated backups.
DBClusterAutomatedBackupsArn *string
// The identifier for the source DB cluster, which can't be changed and which is
// unique to an Amazon Web Services Region.
DBClusterIdentifier *string
// The resource ID for the source DB cluster, which can't be changed and which is
// unique to an Amazon Web Services Region.
DbClusterResourceId *string
// The name of the database engine for this automated backup.
Engine *string
// The engine mode of the database engine for the automated backup.
EngineMode *string
// The version of the database engine for the automated backup.
EngineVersion *string
// Indicates whether mapping of Amazon Web Services Identity and Access Management
// (IAM) accounts to database accounts is enabled.
IAMDatabaseAuthenticationEnabled *bool
// The IOPS (I/O operations per second) value for the automated backup. This
// setting is only for non-Aurora Multi-AZ DB clusters.
Iops *int32
// The Amazon Web Services KMS key ID for an automated backup. The Amazon Web
// Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for
// the KMS key.
KmsKeyId *string
// The license model information for this DB cluster automated backup.
LicenseModel *string
// The master user name of the automated backup.
MasterUsername *string
// The port number that the automated backup used for connections. Default:
// Inherits from the source DB cluster Valid Values: 1150-65535
Port *int32
// The Amazon Web Services Region associated with the automated backup.
Region *string
// Earliest and latest time an instance can be restored to:
RestoreWindow *RestoreWindow
// A list of status information for an automated backup:
// - retained - Automated backups for deleted clusters.
Status *string
// Indicates whether the source DB cluster is encrypted.
StorageEncrypted *bool
// The storage throughput for the automated backup. The throughput is
// automatically set based on the IOPS that you provision, and is not configurable.
// This setting is only for non-Aurora Multi-AZ DB clusters.
StorageThroughput *int32
// The storage type associated with the DB cluster. This setting is only for
// non-Aurora Multi-AZ DB clusters.
StorageType *string
// The VPC ID associated with the DB cluster.
VpcId *string
noSmithyDocumentSerde
}
// This data type is used as a response element in the DescribeDBClusterBacktracks
// action.
type DBClusterBacktrack struct {
// Contains the backtrack identifier.
BacktrackIdentifier *string
// The timestamp of the time at which the backtrack was requested.
BacktrackRequestCreationTime *time.Time
// The timestamp of the time to which the DB cluster was backtracked.
BacktrackTo *time.Time
// The timestamp of the time from which the DB cluster was backtracked.
BacktrackedFrom *time.Time
// Contains a user-supplied DB cluster identifier. This identifier is the unique
// key that identifies a DB cluster.
DBClusterIdentifier *string
// The status of the backtrack. This property returns one of the following values:
// - applying - The backtrack is currently being applied to or rolled back from
// the DB cluster.
// - completed - The backtrack has successfully been applied to or rolled back
// from the DB cluster.
// - failed - An error occurred while the backtrack was applied to or rolled back
// from the DB cluster.
// - pending - The backtrack is currently pending application to or rollback from
// the DB cluster.
Status *string
noSmithyDocumentSerde
}
// This data type represents the information you need to connect to an Amazon
// Aurora DB cluster. This data type is used as a response element in the following
// actions:
// - CreateDBClusterEndpoint
// - DescribeDBClusterEndpoints
// - ModifyDBClusterEndpoint
// - DeleteDBClusterEndpoint
//
// For the data structure that represents Amazon RDS DB instance endpoints, see
// Endpoint .
type DBClusterEndpoint struct {
// The type associated with a custom endpoint. One of: READER , WRITER , ANY .
CustomEndpointType *string
// The Amazon Resource Name (ARN) for the endpoint.
DBClusterEndpointArn *string
// The identifier associated with the endpoint. This parameter is stored as a
// lowercase string.
DBClusterEndpointIdentifier *string
// A unique system-generated identifier for an endpoint. It remains the same for
// the whole life of the endpoint.
DBClusterEndpointResourceIdentifier *string
// The DB cluster identifier of the DB cluster associated with the endpoint. This
// parameter is stored as a lowercase string.
DBClusterIdentifier *string
// The DNS address of the endpoint.
Endpoint *string
// The type of the endpoint. One of: READER , WRITER , CUSTOM .
EndpointType *string
// List of DB instance identifiers that aren't part of the custom endpoint group.
// All other eligible instances are reachable through the custom endpoint. Only
// relevant if the list of static members is empty.
ExcludedMembers []string
// List of DB instance identifiers that are part of the custom endpoint group.
StaticMembers []string
// The current status of the endpoint. One of: creating , available , deleting ,
// inactive , modifying . The inactive state applies to an endpoint that can't be
// used for a certain kind of cluster, such as a writer endpoint for a read-only
// secondary cluster in a global database.
Status *string
noSmithyDocumentSerde
}
// Contains information about an instance that is part of a DB cluster.
type DBClusterMember struct {
// Specifies the status of the DB cluster parameter group for this member of the
// DB cluster.
DBClusterParameterGroupStatus *string