@aws-sdk/client-rds 3.458.0 → 3.460.0

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.
Files changed (27) hide show
  1. package/README.md +1 -1
  2. package/dist-types/RDS.d.ts +1 -1
  3. package/dist-types/RDSClient.d.ts +1 -1
  4. package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +1 -1
  5. package/dist-types/commands/DescribeOptionGroupOptionsCommand.d.ts +1 -1
  6. package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +1 -1
  7. package/dist-types/commands/ModifyCurrentDBClusterCapacityCommand.d.ts +1 -1
  8. package/dist-types/commands/ModifyDBClusterEndpointCommand.d.ts +1 -1
  9. package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +1 -1
  10. package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +1 -1
  11. package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +2 -2
  12. package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +1 -1
  13. package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +4 -4
  14. package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +3 -3
  15. package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +3 -3
  16. package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +2 -2
  17. package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +1 -1
  18. package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +1 -1
  19. package/dist-types/commands/StartDBClusterCommand.d.ts +2 -2
  20. package/dist-types/commands/StartDBInstanceCommand.d.ts +1 -1
  21. package/dist-types/commands/StartExportTaskCommand.d.ts +1 -1
  22. package/dist-types/commands/StopActivityStreamCommand.d.ts +1 -1
  23. package/dist-types/commands/StopDBClusterCommand.d.ts +1 -1
  24. package/dist-types/index.d.ts +1 -1
  25. package/dist-types/models/models_0.d.ts +207 -135
  26. package/dist-types/models/models_1.d.ts +175 -58
  27. package/package.json +13 -13
package/dist-types/models/models_0.d.ts CHANGED
@@ -5747,133 +5747,148 @@ export interface CreateDBInstanceMessage {
5747
5747
  /**
5748
5748
  * @public
5749
5749
  * <p>The meaning of this parameter differs according to the database engine you use.</p>
5750
- * <p>
5751
- * <b>MySQL</b>
5752
- * </p>
5753
- * <p>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.</p>
5754
- * <p>Constraints:</p>
5755
- * <ul>
5756
- * <li>
5757
- * <p>Must contain 1 to 64 letters or numbers.</p>
5758
- * </li>
5759
- * <li>
5760
- * <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p>
5761
- * </li>
5762
- * <li>
5763
- * <p>Can't be a word reserved by the specified database engine</p>
5764
- * </li>
5765
- * </ul>
5766
- * <p>
5767
- * <b>MariaDB</b>
5768
- * </p>
5769
- * <p>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.</p>
5770
- * <p>Constraints:</p>
5771
- * <ul>
5772
- * <li>
5773
- * <p>Must contain 1 to 64 letters or numbers.</p>
5774
- * </li>
5775
- * <li>
5776
- * <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p>
5777
- * </li>
5778
- * <li>
5779
- * <p>Can't be a word reserved by the specified database engine</p>
5780
- * </li>
5781
- * </ul>
5782
- * <p>
5783
- * <b>PostgreSQL</b>
5784
- * </p>
5785
- * <p>The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named <code>postgres</code>
5786
- * is created in the DB instance.</p>
5787
- * <p>Constraints:</p>
5788
- * <ul>
5789
- * <li>
5790
- * <p>Must contain 1 to 63 letters, numbers, or underscores.</p>
5791
- * </li>
5792
- * <li>
5793
- * <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p>
5794
- * </li>
5795
- * <li>
5796
- * <p>Can't be a word reserved by the specified database engine</p>
5797
- * </li>
5798
- * </ul>
5799
- * <p>
5800
- * <b>Oracle</b>
5801
- * </p>
5802
- * <p>The Oracle System ID (SID) of the created DB instance. If you don't specify a value,
5803
- * the default value is <code>ORCL</code>. You can't specify the
5804
- * string <code>null</code>, or any other reserved word, for <code>DBName</code>.</p>
5805
- * <p>Default: <code>ORCL</code>
5806
- * </p>
5807
- * <p>Constraints:</p>
5808
- * <ul>
5809
- * <li>
5810
- * <p>Can't be longer than 8 characters</p>
5811
- * </li>
5812
- * </ul>
5813
- * <p>
5814
- * <b>Amazon RDS Custom for Oracle</b>
5815
- * </p>
5816
- * <p>The Oracle System ID (SID) of the created RDS Custom DB instance.
5817
- * If you don't specify a value, the default value is <code>ORCL</code> for non-CDBs and
5818
- * <code>RDSCDB</code> for CDBs.</p>
5819
- * <p>Default: <code>ORCL</code>
5820
- * </p>
5821
- * <p>Constraints:</p>
5822
- * <ul>
5823
- * <li>
5824
- * <p>It must contain 1 to 8 alphanumeric characters.</p>
5825
- * </li>
5826
- * <li>
5827
- * <p>It must contain a letter.</p>
5828
- * </li>
5829
- * <li>
5830
- * <p>It can't be a word reserved by the database engine.</p>
5831
- * </li>
5832
- * </ul>
5833
- * <p>
5834
- * <b>Amazon RDS Custom for SQL Server</b>
5835
- * </p>
5836
- * <p>Not applicable. Must be null.</p>
5837
- * <p>
5838
- * <b>SQL Server</b>
5839
- * </p>
5840
- * <p>Not applicable. Must be null.</p>
5841
- * <p>
5842
- * <b>Amazon Aurora MySQL</b>
5843
- * </p>
5844
- * <p>The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is
5845
- * created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created
5846
- * in the DB cluster.</p>
5847
- * <p>Constraints:</p>
5848
- * <ul>
5849
- * <li>
5850
- * <p>It must contain 1 to 64 alphanumeric characters.</p>
5851
- * </li>
5852
- * <li>
5853
- * <p>It can't be a word reserved by the database engine.</p>
5854
- * </li>
5855
- * </ul>
5856
- * <p>
5857
- * <b>Amazon Aurora PostgreSQL</b>
5858
- * </p>
5859
- * <p>The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is
5860
- * created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster,
5861
- * a database named <code>postgres</code> is created in the DB cluster.</p>
5862
- * <p>Constraints:</p>
5863
- * <ul>
5864
- * <li>
5865
- * <p>It must contain 1 to 63 alphanumeric characters.</p>
5866
- * </li>
5867
- * <li>
5868
- * <p>It must begin with a letter.
5869
- * Subsequent characters can be letters, underscores, or digits
5870
- * (0 to 9).</p>
5871
- * </li>
5872
- * <li>
5873
- * <p>It can't be a word reserved by the
5874
- * database engine.</p>
5875
- * </li>
5876
- * </ul>
5750
+ * <dl>
5751
+ * <dt>Amazon Aurora MySQL</dt>
5752
+ * <dd>
5753
+ * <p>The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is
5754
+ * created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created
5755
+ * in the DB cluster.</p>
5756
+ * <p>Constraints:</p>
5757
+ * <ul>
5758
+ * <li>
5759
+ * <p>Must contain 1 to 64 alphanumeric characters.</p>
5760
+ * </li>
5761
+ * <li>
5762
+ * <p>Can't be a word reserved by the database engine.</p>
5763
+ * </li>
5764
+ * </ul>
5765
+ * </dd>
5766
+ * <dt>Amazon Aurora PostgreSQL</dt>
5767
+ * <dd>
5768
+ * <p>The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is
5769
+ * created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster,
5770
+ * a database named <code>postgres</code> is created in the DB cluster.</p>
5771
+ * <p>Constraints:</p>
5772
+ * <ul>
5773
+ * <li>
5774
+ * <p>It must contain 1 to 63 alphanumeric characters.</p>
5775
+ * </li>
5776
+ * <li>
5777
+ * <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits
5778
+ * (0 to 9).</p>
5779
+ * </li>
5780
+ * <li>
5781
+ * <p>Can't be a word reserved by the database engine.</p>
5782
+ * </li>
5783
+ * </ul>
5784
+ * </dd>
5785
+ * <dt>Amazon RDS Custom for Oracle</dt>
5786
+ * <dd>
5787
+ * <p>The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is <code>ORCL</code> for non-CDBs and
5788
+ * <code>RDSCDB</code> for CDBs.</p>
5789
+ * <p>Default: <code>ORCL</code>
5790
+ * </p>
5791
+ * <p>Constraints:</p>
5792
+ * <ul>
5793
+ * <li>
5794
+ * <p>Must contain 1 to 8 alphanumeric characters.</p>
5795
+ * </li>
5796
+ * <li>
5797
+ * <p>Must contain a letter.</p>
5798
+ * </li>
5799
+ * <li>
5800
+ * <p>Can't be a word reserved by the database engine.</p>
5801
+ * </li>
5802
+ * </ul>
5803
+ * </dd>
5804
+ * <dt>Amazon RDS Custom for SQL Server</dt>
5805
+ * <dd>
5806
+ * <p>Not applicable. Must be null.</p>
5807
+ * </dd>
5808
+ * <dt>RDS for Db2</dt>
5809
+ * <dd>
5810
+ * <p>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.</p>
5811
+ * <p>Constraints:</p>
5812
+ * <ul>
5813
+ * <li>
5814
+ * <p>Must contain 1 to 64 letters or numbers.</p>
5815
+ * </li>
5816
+ * <li>
5817
+ * <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p>
5818
+ * </li>
5819
+ * <li>
5820
+ * <p>Can't be a word reserved by the specified database engine.</p>
5821
+ * </li>
5822
+ * </ul>
5823
+ * </dd>
5824
+ * <dt>RDS for MariaDB</dt>
5825
+ * <dd>
5826
+ * <p>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.</p>
5827
+ * <p>Constraints:</p>
5828
+ * <ul>
5829
+ * <li>
5830
+ * <p>Must contain 1 to 64 letters or numbers.</p>
5831
+ * </li>
5832
+ * <li>
5833
+ * <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p>
5834
+ * </li>
5835
+ * <li>
5836
+ * <p>Can't be a word reserved by the specified database engine.</p>
5837
+ * </li>
5838
+ * </ul>
5839
+ * </dd>
5840
+ * <dt>RDS for MySQL</dt>
5841
+ * <dd>
5842
+ * <p>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.</p>
5843
+ * <p>Constraints:</p>
5844
+ * <ul>
5845
+ * <li>
5846
+ * <p>Must contain 1 to 64 letters or numbers.</p>
5847
+ * </li>
5848
+ * <li>
5849
+ * <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p>
5850
+ * </li>
5851
+ * <li>
5852
+ * <p>Can't be a word reserved by the specified database engine.</p>
5853
+ * </li>
5854
+ * </ul>
5855
+ * </dd>
5856
+ * <dt>RDS for Oracle</dt>
5857
+ * <dd>
5858
+ * <p>The Oracle System ID (SID) of the created DB instance. If you don't specify a value,
5859
+ * the default value is <code>ORCL</code>. You can't specify the
5860
+ * string <code>null</code>, or any other reserved word, for <code>DBName</code>.</p>
5861
+ * <p>Default: <code>ORCL</code>
5862
+ * </p>
5863
+ * <p>Constraints:</p>
5864
+ * <ul>
5865
+ * <li>
5866
+ * <p>Can't be longer than 8 characters.</p>
5867
+ * </li>
5868
+ * </ul>
5869
+ * </dd>
5870
+ * <dt>RDS for PostgreSQL</dt>
5871
+ * <dd>
5872
+ * <p>The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named <code>postgres</code>
5873
+ * is created in the DB instance.</p>
5874
+ * <p>Constraints:</p>
5875
+ * <ul>
5876
+ * <li>
5877
+ * <p>Must contain 1 to 63 letters, numbers, or underscores.</p>
5878
+ * </li>
5879
+ * <li>
5880
+ * <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p>
5881
+ * </li>
5882
+ * <li>
5883
+ * <p>Can't be a word reserved by the specified database engine.</p>
5884
+ * </li>
5885
+ * </ul>
5886
+ * </dd>
5887
+ * <dt>RDS for SQL Server</dt>
5888
+ * <dd>
5889
+ * <p>Not applicable. Must be null.</p>
5890
+ * </dd>
5891
+ * </dl>
5877
5892
  */
5878
5893
  DBName?: string;
5879
5894
  /**
@@ -5915,6 +5930,18 @@ export interface CreateDBInstanceMessage {
5915
5930
  * </li>
5916
5931
  * </ul>
5917
5932
  * </dd>
5933
+ * <dt>RDS for Db2</dt>
5934
+ * <dd>
5935
+ * <p>Constraints to the amount of storage for each storage type are the following:</p>
5936
+ * <ul>
5937
+ * <li>
5938
+ * <p>General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 64000.</p>
5939
+ * </li>
5940
+ * <li>
5941
+ * <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.</p>
5942
+ * </li>
5943
+ * </ul>
5944
+ * </dd>
5918
5945
  * <dt>RDS for MariaDB</dt>
5919
5946
  * <dd>
5920
5947
  * <p>Constraints to the amount of storage for each storage type are the following:</p>
@@ -6064,6 +6091,16 @@ export interface CreateDBInstanceMessage {
6064
6091
  * </li>
6065
6092
  * <li>
6066
6093
  * <p>
6094
+ * <code>db2-ae</code>
6095
+ * </p>
6096
+ * </li>
6097
+ * <li>
6098
+ * <p>
6099
+ * <code>db2-se</code>
6100
+ * </p>
6101
+ * </li>
6102
+ * <li>
6103
+ * <p>
6067
6104
  * <code>mariadb</code>
6068
6105
  * </p>
6069
6106
  * </li>
@@ -6156,6 +6193,9 @@ export interface CreateDBInstanceMessage {
6156
6193
  * <p>Length Constraints:</p>
6157
6194
  * <ul>
6158
6195
  * <li>
6196
+ * <p>RDS for Db2 - Must contain from 8 to 255 characters.</p>
6197
+ * </li>
6198
+ * <li>
6159
6199
  * <p>RDS for MariaDB - Must contain from 8 to 41 characters.</p>
6160
6200
  * </li>
6161
6201
  * <li>
@@ -6330,6 +6370,10 @@ export interface CreateDBInstanceMessage {
6330
6370
  * <p>Default:</p>
6331
6371
  * <ul>
6332
6372
  * <li>
6373
+ * <p>RDS for Db2 - <code>50000</code>
6374
+ * </p>
6375
+ * </li>
6376
+ * <li>
6333
6377
  * <p>RDS for MariaDB - <code>3306</code>
6334
6378
  * </p>
6335
6379
  * </li>
@@ -6397,6 +6441,11 @@ export interface CreateDBInstanceMessage {
6397
6441
  * <p>See <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html">RDS Custom for SQL Server general requirements</a>
6398
6442
  * in the <i>Amazon RDS User Guide</i>.</p>
6399
6443
  * </dd>
6444
+ * <dt>RDS for Db2</dt>
6445
+ * <dd>
6446
+ * <p>For information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt">Db2 on Amazon RDS versions</a> in the
6447
+ * <i>Amazon RDS User Guide</i>.</p>
6448
+ * </dd>
6400
6449
  * <dt>RDS for MariaDB</dt>
6401
6450
  * <dd>
6402
6451
  * <p>For information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt">MariaDB on Amazon RDS versions</a> in the
@@ -6440,6 +6489,10 @@ export interface CreateDBInstanceMessage {
6440
6489
  * <p>Valid Values:</p>
6441
6490
  * <ul>
6442
6491
  * <li>
6492
+ * <p>RDS for Db2 - <code>bring-your-own-license</code>
6493
+ * </p>
6494
+ * </li>
6495
+ * <li>
6443
6496
  * <p>RDS for MariaDB - <code>general-public-license</code>
6444
6497
  * </p>
6445
6498
  * </li>
@@ -6472,7 +6525,7 @@ export interface CreateDBInstanceMessage {
6472
6525
  * <p>Constraints:</p>
6473
6526
  * <ul>
6474
6527
  * <li>
6475
- * <p>For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50
6528
+ * <p>For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50
6476
6529
  * of the storage amount for the DB instance.</p>
6477
6530
  * </li>
6478
6531
  * <li>
@@ -6602,8 +6655,8 @@ export interface CreateDBInstanceMessage {
6602
6655
  KmsKeyId?: string;
6603
6656
  /**
6604
6657
  * @public
6605
- * <p>The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL
6606
- * Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.</p>
6658
+ * <p>The Active Directory directory ID to create the DB instance in. Currently, you can create only Db2, MySQL, Microsoft SQL
6659
+ * Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.</p>
6607
6660
  * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html">
6608
6661
  * Kerberos Authentication</a> in the <i>Amazon RDS User Guide</i>.</p>
6609
6662
  * <p>This setting doesn't apply to the following DB instances:</p>
@@ -6793,7 +6846,7 @@ export interface CreateDBInstanceMessage {
6793
6846
  PerformanceInsightsRetentionPeriod?: number;
6794
6847
  /**
6795
6848
  * @public
6796
- * <p>The list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see
6849
+ * <p>The list of log types to enable for exporting to CloudWatch Logs. For more information, see
6797
6850
  * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">
6798
6851
  * Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p>
6799
6852
  * <p>This setting doesn't apply to the following DB instances:</p>
@@ -6808,6 +6861,10 @@ export interface CreateDBInstanceMessage {
6808
6861
  * <p>The following values are valid for each DB engine:</p>
6809
6862
  * <ul>
6810
6863
  * <li>
6864
+ * <p>RDS for Db2 - <code>diag.log | notify.log</code>
6865
+ * </p>
6866
+ * </li>
6867
+ * <li>
6811
6868
  * <p>RDS for MariaDB - <code>audit | error | general | slowquery</code>
6812
6869
  * </p>
6813
6870
  * </li>
@@ -6905,7 +6962,7 @@ export interface CreateDBInstanceMessage {
6905
6962
  /**
6906
6963
  * @public
6907
6964
  * <p>The location for storing automated backups and manual snapshots.</p>
6908
- * <p>Valie Values:</p>
6965
+ * <p>Valid Values:</p>
6909
6966
  * <ul>
6910
6967
  * <li>
6911
6968
  * <p>
@@ -8176,7 +8233,7 @@ export interface CreateDBInstanceReadReplicaMessage {
8176
8233
  * <p>Constraints:</p>
8177
8234
  * <ul>
8178
8235
  * <li>
8179
- * <p>Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB
8236
+ * <p>Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB
8180
8237
  * instance.</p>
8181
8238
  * </li>
8182
8239
  * <li>
@@ -8841,7 +8898,12 @@ export interface CreateDBParameterGroupMessage {
8841
8898
  * </li>
8842
8899
  * <li>
8843
8900
  * <p>
8844
- * <code>mariadb</code>
8901
+ * <code>db2-ae</code>
8902
+ * </p>
8903
+ * </li>
8904
+ * <li>
8905
+ * <p>
8906
+ * <code>db2-se</code>
8845
8907
  * </p>
8846
8908
  * </li>
8847
8909
  * <li>
@@ -10357,11 +10419,21 @@ export interface CreateOptionGroupMessage {
10357
10419
  OptionGroupName: string | undefined;
10358
10420
  /**
10359
10421
  * @public
10360
- * <p>Specifies the name of the engine that this option group should be associated with.</p>
10422
+ * <p>The name of the engine to associate this option group with.</p>
10361
10423
  * <p>Valid Values:</p>
10362
10424
  * <ul>
10363
10425
  * <li>
10364
10426
  * <p>
10427
+ * <code>db2-ae</code>
10428
+ * </p>
10429
+ * </li>
10430
+ * <li>
10431
+ * <p>
10432
+ * <code>db2-se</code>
10433
+ * </p>
10434
+ * </li>
10435
+ * <li>
10436
+ * <p>
10365
10437
  * <code>mariadb</code>
10366
10438
  * </p>
10367
10439
  * </li>