@aws-sdk/client-rds 3.716.0 → 3.719.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4459,7 +4459,7 @@ export interface CreateDBClusterMessage {
4459
4459
  /**
4460
4460
  * <p>Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
4461
4461
  * By default, minor engine upgrades are applied automatically.</p>
4462
- * <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
4462
+ * <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster</p>
4463
4463
  * @public
4464
4464
  */
4465
4465
  AutoMinorVersionUpgrade?: boolean | undefined;
@@ -4468,7 +4468,7 @@ export interface CreateDBClusterMessage {
4468
4468
  * collecting Enhanced Monitoring metrics, specify <code>0</code>.</p>
4469
4469
  * <p>If <code>MonitoringRoleArn</code> is specified, also set <code>MonitoringInterval</code>
4470
4470
  * to a value other than <code>0</code>.</p>
4471
- * <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
4471
+ * <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
4472
4472
  * <p>Valid Values: <code>0 | 1 | 5 | 10 | 15 | 30 | 60</code>
4473
4473
  * </p>
4474
4474
  * <p>Default: <code>0</code>
@@ -4482,12 +4482,15 @@ export interface CreateDBClusterMessage {
4482
4482
  * see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling">Setting
4483
4483
  * up and enabling Enhanced Monitoring</a> in the <i>Amazon RDS User Guide</i>.</p>
4484
4484
  * <p>If <code>MonitoringInterval</code> is set to a value other than <code>0</code>, supply a <code>MonitoringRoleArn</code> value.</p>
4485
- * <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
4485
+ * <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
4486
4486
  * @public
4487
4487
  */
4488
4488
  MonitoringRoleArn?: string | undefined;
4489
4489
  /**
4490
- * <p>Specifies the mode of Database Insights to enable for the cluster.</p>
4490
+ * <p>The mode of Database Insights to enable for the DB cluster.</p>
4491
+ * <p>If you set this value to <code>advanced</code>, you must also set the <code>PerformanceInsightsEnabled</code>
4492
+ * parameter to <code>true</code> and the <code>PerformanceInsightsRetentionPeriod</code> parameter to 465.</p>
4493
+ * <p>Valid for Cluster Type: Aurora DB clusters only</p>
4491
4494
  * @public
4492
4495
  */
4493
4496
  DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
@@ -4495,7 +4498,7 @@ export interface CreateDBClusterMessage {
4495
4498
  * <p>Specifies whether to turn on Performance Insights for the DB cluster.</p>
4496
4499
  * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html">
4497
4500
  * Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.</p>
4498
- * <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
4501
+ * <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
4499
4502
  * @public
4500
4503
  */
4501
4504
  EnablePerformanceInsights?: boolean | undefined;
@@ -4505,13 +4508,13 @@ export interface CreateDBClusterMessage {
4505
4508
  * <p>If you don't specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS
4506
4509
  * uses your default KMS key. There is a default KMS key for your Amazon Web Services account.
4507
4510
  * Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
4508
- * <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
4511
+ * <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
4509
4512
  * @public
4510
4513
  */
4511
4514
  PerformanceInsightsKMSKeyId?: string | undefined;
4512
4515
  /**
4513
4516
  * <p>The number of days to retain Performance Insights data.</p>
4514
- * <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
4517
+ * <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
4515
4518
  * <p>Valid Values:</p>
4516
4519
  * <ul>
4517
4520
  * <li>
@@ -5509,43 +5512,43 @@ export interface DBCluster {
5509
5512
  PubliclyAccessible?: boolean | undefined;
5510
5513
  /**
5511
5514
  * <p>Indicates whether minor version patches are applied automatically.</p>
5512
- * <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
5515
+ * <p>This setting is for Aurora DB clusters and Multi-AZ DB clusters.</p>
5513
5516
  * @public
5514
5517
  */
5515
5518
  AutoMinorVersionUpgrade?: boolean | undefined;
5516
5519
  /**
5517
5520
  * <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.</p>
5518
- * <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
5521
+ * <p>This setting is only for -Aurora DB clusters and Multi-AZ DB clusters.</p>
5519
5522
  * @public
5520
5523
  */
5521
5524
  MonitoringInterval?: number | undefined;
5522
5525
  /**
5523
5526
  * <p>The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.</p>
5524
- * <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
5527
+ * <p>This setting is only for Aurora DB clusters and Multi-AZ DB clusters.</p>
5525
5528
  * @public
5526
5529
  */
5527
5530
  MonitoringRoleArn?: string | undefined;
5528
5531
  /**
5529
- * <p>The mode of Database Insights that is enabled for the cluster.</p>
5532
+ * <p>The mode of Database Insights that is enabled for the DB cluster.</p>
5530
5533
  * @public
5531
5534
  */
5532
5535
  DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
5533
5536
  /**
5534
5537
  * <p>Indicates whether Performance Insights is enabled for the DB cluster.</p>
5535
- * <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
5538
+ * <p>This setting is only for Aurora DB clusters and Multi-AZ DB clusters.</p>
5536
5539
  * @public
5537
5540
  */
5538
5541
  PerformanceInsightsEnabled?: boolean | undefined;
5539
5542
  /**
5540
5543
  * <p>The Amazon Web Services KMS key identifier for encryption of Performance Insights data.</p>
5541
5544
  * <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
5542
- * <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
5545
+ * <p>This setting is only for Aurora DB clusters and Multi-AZ DB clusters.</p>
5543
5546
  * @public
5544
5547
  */
5545
5548
  PerformanceInsightsKMSKeyId?: string | undefined;
5546
5549
  /**
5547
5550
  * <p>The number of days to retain Performance Insights data.</p>
5548
- * <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
5551
+ * <p>This setting is only for Aurora DB clusters and Multi-AZ DB clusters.</p>
5549
5552
  * <p>Valid Values:</p>
5550
5553
  * <ul>
5551
5554
  * <li>
@@ -7277,7 +7280,11 @@ export interface CreateDBInstanceMessage {
7277
7280
  */
7278
7281
  EnableIAMDatabaseAuthentication?: boolean | undefined;
7279
7282
  /**
7280
- * <p>Specifies the mode of Database Insights to enable for the instance.</p>
7283
+ * <p>The mode of Database Insights to enable for the DB instance.</p>
7284
+ * <p>This setting only applies to Amazon Aurora DB instances.</p>
7285
+ * <note>
7286
+ * <p>Currently, this value is inherited from the DB cluster and can't be changed.</p>
7287
+ * </note>
7281
7288
  * @public
7282
7289
  */
7283
7290
  DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
@@ -9049,7 +9056,10 @@ export interface CreateDBInstanceReadReplicaMessage {
9049
9056
  */
9050
9057
  EnableIAMDatabaseAuthentication?: boolean | undefined;
9051
9058
  /**
9052
- * <p>Specifies the mode of Database Insights.</p>
9059
+ * <p>The mode of Database Insights to enable for the read replica.</p>
9060
+ * <note>
9061
+ * <p>Currently, this setting is not supported.</p>
9062
+ * </note>
9053
9063
  * @public
9054
9064
  */
9055
9065
  DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
@@ -9288,6 +9298,7 @@ export interface CreateDBInstanceReadReplicaMessage {
9288
9298
  /**
9289
9299
  * <p>The amount of storage (in gibibytes) to allocate initially for the read replica.
9290
9300
  * Follow the allocation rules specified in <code>CreateDBInstance</code>.</p>
9301
+ * <p>This setting isn't valid for RDS for SQL Server.</p>
9291
9302
  * <note>
9292
9303
  * <p>Be sure to allocate enough storage for your read replica so that the create operation can succeed.
9293
9304
  * You can also allocate additional storage for future growth.</p>
@@ -832,17 +832,17 @@ export interface DescribeDBClusterParametersMessage {
832
832
  * <ul>
833
833
  * <li>
834
834
  * <p>
835
- * <code>customer</code>
835
+ * <code>engine-default</code>
836
836
  * </p>
837
837
  * </li>
838
838
  * <li>
839
839
  * <p>
840
- * <code>engine</code>
840
+ * <code>system</code>
841
841
  * </p>
842
842
  * </li>
843
843
  * <li>
844
844
  * <p>
845
- * <code>service</code>
845
+ * <code>user</code>
846
846
  * </p>
847
847
  * </li>
848
848
  * </ul>
@@ -850,7 +850,8 @@ export interface DescribeDBClusterParametersMessage {
850
850
  */
851
851
  Source?: string | undefined;
852
852
  /**
853
- * <p>This parameter isn't currently supported.</p>
853
+ * <p>A filter that specifies one or more DB cluster parameters to describe.</p>
854
+ * <p>The only supported filter is <code>parameter-name</code>. The results list only includes information about the DB cluster parameters with these names.</p>
854
855
  * @public
855
856
  */
856
857
  Filters?: Filter[] | undefined;
@@ -1848,7 +1849,8 @@ export interface DescribeDBParametersMessage {
1848
1849
  */
1849
1850
  Source?: string | undefined;
1850
1851
  /**
1851
- * <p>This parameter isn't currently supported.</p>
1852
+ * <p>A filter that specifies one or more DB parameters to describe.</p>
1853
+ * <p>The only supported filter is <code>parameter-name</code>. The results list only includes information about the DB parameters with these names.</p>
1852
1854
  * @public
1853
1855
  */
1854
1856
  Filters?: Filter[] | undefined;
@@ -3980,7 +3982,8 @@ export interface DescribeEngineDefaultParametersMessage {
3980
3982
  */
3981
3983
  DBParameterGroupFamily: string | undefined;
3982
3984
  /**
3983
- * <p>This parameter isn't currently supported.</p>
3985
+ * <p>A filter that specifies one or more parameters to describe.</p>
3986
+ * <p>The only supported filter is <code>parameter-name</code>. The results list only includes information about the parameters with these names.</p>
3984
3987
  * @public
3985
3988
  */
3986
3989
  Filters?: Filter[] | undefined;
@@ -6663,11 +6666,49 @@ export interface ModifyCustomDBEngineVersionMessage {
6663
6666
  export interface CloudwatchLogsExportConfiguration {
6664
6667
  /**
6665
6668
  * <p>The list of log types to enable.</p>
6669
+ * <p>The following values are valid for each DB engine:</p>
6670
+ * <ul>
6671
+ * <li>
6672
+ * <p>Aurora MySQL - <code>audit | error | general | slowquery</code>
6673
+ * </p>
6674
+ * </li>
6675
+ * <li>
6676
+ * <p>Aurora PostgreSQL - <code>postgresql</code>
6677
+ * </p>
6678
+ * </li>
6679
+ * <li>
6680
+ * <p>RDS for MySQL - <code>error | general | slowquery</code>
6681
+ * </p>
6682
+ * </li>
6683
+ * <li>
6684
+ * <p>RDS for PostgreSQL - <code>postgresql | upgrade</code>
6685
+ * </p>
6686
+ * </li>
6687
+ * </ul>
6666
6688
  * @public
6667
6689
  */
6668
6690
  EnableLogTypes?: string[] | undefined;
6669
6691
  /**
6670
6692
  * <p>The list of log types to disable.</p>
6693
+ * <p>The following values are valid for each DB engine:</p>
6694
+ * <ul>
6695
+ * <li>
6696
+ * <p>Aurora MySQL - <code>audit | error | general | slowquery</code>
6697
+ * </p>
6698
+ * </li>
6699
+ * <li>
6700
+ * <p>Aurora PostgreSQL - <code>postgresql</code>
6701
+ * </p>
6702
+ * </li>
6703
+ * <li>
6704
+ * <p>RDS for MySQL - <code>error | general | slowquery</code>
6705
+ * </p>
6706
+ * </li>
6707
+ * <li>
6708
+ * <p>RDS for PostgreSQL - <code>postgresql | upgrade</code>
6709
+ * </p>
6710
+ * </li>
6711
+ * </ul>
6671
6712
  * @public
6672
6713
  */
6673
6714
  DisableLogTypes?: string[] | undefined;
@@ -7083,7 +7124,7 @@ export interface ModifyDBClusterMessage {
7083
7124
  /**
7084
7125
  * <p>Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
7085
7126
  * By default, minor engine upgrades are applied automatically.</p>
7086
- * <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
7127
+ * <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
7087
7128
  * @public
7088
7129
  */
7089
7130
  AutoMinorVersionUpgrade?: boolean | undefined;
@@ -7112,7 +7153,13 @@ export interface ModifyDBClusterMessage {
7112
7153
  */
7113
7154
  MonitoringRoleArn?: string | undefined;
7114
7155
  /**
7115
- * <p>Specifies the mode of Database Insights to enable for the cluster.</p>
7156
+ * <p>Specifies the mode of Database Insights to enable for the DB cluster.</p>
7157
+ * <p>If you change the value from <code>standard</code> to <code>advanced</code>, you must set the
7158
+ * <code>PerformanceInsightsEnabled</code> parameter to <code>true</code> and the
7159
+ * <code>PerformanceInsightsRetentionPeriod</code> parameter to 465.</p>
7160
+ * <p>If you change the value from <code>advanced</code> to <code>standard</code>, you must
7161
+ * set the <code>PerformanceInsightsEnabled</code> parameter to <code>false</code>.</p>
7162
+ * <p>Valid for Cluster Type: Aurora DB clusters only</p>
7116
7163
  * @public
7117
7164
  */
7118
7165
  DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
@@ -7130,13 +7177,13 @@ export interface ModifyDBClusterMessage {
7130
7177
  * <p>If you don't specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS
7131
7178
  * uses your default KMS key. There is a default KMS key for your Amazon Web Services account.
7132
7179
  * Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
7133
- * <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
7180
+ * <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
7134
7181
  * @public
7135
7182
  */
7136
7183
  PerformanceInsightsKMSKeyId?: string | undefined;
7137
7184
  /**
7138
7185
  * <p>The number of days to retain Performance Insights data.</p>
7139
- * <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
7186
+ * <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
7140
7187
  * <p>Valid Values:</p>
7141
7188
  * <ul>
7142
7189
  * <li>
@@ -8206,7 +8253,11 @@ export interface ModifyDBInstanceMessage {
8206
8253
  */
8207
8254
  EnableIAMDatabaseAuthentication?: boolean | undefined;
8208
8255
  /**
8209
- * <p>Specifies the mode of Database Insights to enable for the instance.</p>
8256
+ * <p>Specifies the mode of Database Insights to enable for the DB instance.</p>
8257
+ * <p>This setting only applies to Amazon Aurora DB instances.</p>
8258
+ * <note>
8259
+ * <p>Currently, this value is inherited from the DB cluster and can't be changed.</p>
8260
+ * </note>
8210
8261
  * @public
8211
8262
  */
8212
8263
  DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
@@ -8260,6 +8311,28 @@ export interface ModifyDBInstanceMessage {
8260
8311
  * <p>A change to the <code>CloudwatchLogsExportConfiguration</code> parameter is always applied to the DB instance
8261
8312
  * immediately. Therefore, the <code>ApplyImmediately</code> parameter has no effect.</p>
8262
8313
  * <p>This setting doesn't apply to RDS Custom DB instances.</p>
8314
+ * <p>The following values are valid for each DB engine:</p>
8315
+ * <ul>
8316
+ * <li>
8317
+ * <p>Aurora MySQL - <code>audit | error | general | slowquery</code>
8318
+ * </p>
8319
+ * </li>
8320
+ * <li>
8321
+ * <p>Aurora PostgreSQL - <code>postgresql</code>
8322
+ * </p>
8323
+ * </li>
8324
+ * <li>
8325
+ * <p>RDS for MySQL - <code>error | general | slowquery</code>
8326
+ * </p>
8327
+ * </li>
8328
+ * <li>
8329
+ * <p>RDS for PostgreSQL - <code>postgresql | upgrade</code>
8330
+ * </p>
8331
+ * </li>
8332
+ * </ul>
8333
+ * <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">
8334
+ * Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p>
8335
+ * <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p>
8263
8336
  * @public
8264
8337
  */
8265
8338
  CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration | undefined;
@@ -11949,6 +12022,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
11949
12022
  /**
11950
12023
  * <p>The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in
11951
12024
  * CreateDBInstance.</p>
12025
+ * <p>This setting isn't valid for RDS for SQL Server.</p>
11952
12026
  * <note>
11953
12027
  * <p>Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also
11954
12028
  * allocate additional storage for future growth.</p>
@@ -12037,6 +12111,7 @@ export interface RestoreDBInstanceFromS3Message {
12037
12111
  /**
12038
12112
  * <p>The amount of storage (in gibibytes) to allocate initially for the DB instance.
12039
12113
  * Follow the allocation rules specified in <code>CreateDBInstance</code>.</p>
12114
+ * <p>This setting isn't valid for RDS for SQL Server.</p>
12040
12115
  * <note>
12041
12116
  * <p>Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.
12042
12117
  * You can also allocate additional storage for future growth.</p>
@@ -12388,7 +12463,11 @@ export interface RestoreDBInstanceFromS3Message {
12388
12463
  */
12389
12464
  S3IngestionRoleArn: string | undefined;
12390
12465
  /**
12391
- * <p>Specifies the mode of Database Insights to enable for the instance.</p>
12466
+ * <p>Specifies the mode of Database Insights to enable for the DB instance.</p>
12467
+ * <p>This setting only applies to Amazon Aurora DB instances.</p>
12468
+ * <note>
12469
+ * <p>Currently, this value is inherited from the DB cluster and can't be changed.</p>
12470
+ * </note>
12392
12471
  * @public
12393
12472
  */
12394
12473
  DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
@@ -13204,6 +13283,7 @@ export interface RestoreDBInstanceToPointInTimeMessage {
13204
13283
  /**
13205
13284
  * <p>The amount of storage (in gibibytes) to allocate initially for the DB instance.
13206
13285
  * Follow the allocation rules specified in <code>CreateDBInstance</code>.</p>
13286
+ * <p>This setting isn't valid for RDS for SQL Server.</p>
13207
13287
  * <note>
13208
13288
  * <p>Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.
13209
13289
  * You can also allocate additional storage for future growth.</p>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-rds",
3
3
  "description": "AWS SDK for JavaScript Rds Client for Node.js, Browser and React Native",
4
- "version": "3.716.0",
4
+ "version": "3.719.1",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-rds",