@aws-sdk/client-rds 3.441.0 → 3.445.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 (103) hide show
  1. package/README.md +40 -0
  2. package/dist-cjs/RDS.js +10 -0
  3. package/dist-cjs/commands/CreateTenantDatabaseCommand.js +52 -0
  4. package/dist-cjs/commands/DeleteTenantDatabaseCommand.js +52 -0
  5. package/dist-cjs/commands/DescribeDBSnapshotTenantDatabasesCommand.js +51 -0
  6. package/dist-cjs/commands/DescribeTenantDatabasesCommand.js +52 -0
  7. package/dist-cjs/commands/ModifyTenantDatabaseCommand.js +52 -0
  8. package/dist-cjs/commands/index.js +5 -0
  9. package/dist-cjs/models/models_0.js +83 -20
  10. package/dist-cjs/models/models_1.js +37 -1
  11. package/dist-cjs/pagination/DescribeDBSnapshotTenantDatabasesPaginator.js +29 -0
  12. package/dist-cjs/pagination/DescribeTenantDatabasesPaginator.js +29 -0
  13. package/dist-cjs/pagination/index.js +2 -0
  14. package/dist-cjs/protocols/Aws_query.js +653 -7
  15. package/dist-cjs/waiters/index.js +2 -0
  16. package/dist-cjs/waiters/waitForTenantDatabaseAvailable.js +89 -0
  17. package/dist-cjs/waiters/waitForTenantDatabaseDeleted.js +39 -0
  18. package/dist-es/RDS.js +10 -0
  19. package/dist-es/commands/CreateTenantDatabaseCommand.js +48 -0
  20. package/dist-es/commands/DeleteTenantDatabaseCommand.js +48 -0
  21. package/dist-es/commands/DescribeDBSnapshotTenantDatabasesCommand.js +47 -0
  22. package/dist-es/commands/DescribeTenantDatabasesCommand.js +48 -0
  23. package/dist-es/commands/ModifyTenantDatabaseCommand.js +48 -0
  24. package/dist-es/commands/index.js +5 -0
  25. package/dist-es/models/models_0.js +71 -16
  26. package/dist-es/models/models_1.js +32 -0
  27. package/dist-es/pagination/DescribeDBSnapshotTenantDatabasesPaginator.js +25 -0
  28. package/dist-es/pagination/DescribeTenantDatabasesPaginator.js +25 -0
  29. package/dist-es/pagination/index.js +2 -0
  30. package/dist-es/protocols/Aws_query.js +637 -2
  31. package/dist-es/waiters/index.js +2 -0
  32. package/dist-es/waiters/waitForTenantDatabaseAvailable.js +84 -0
  33. package/dist-es/waiters/waitForTenantDatabaseDeleted.js +34 -0
  34. package/dist-types/RDS.d.ts +35 -0
  35. package/dist-types/RDSClient.d.ts +7 -2
  36. package/dist-types/commands/AddTagsToResourceCommand.d.ts +6 -0
  37. package/dist-types/commands/CopyDBSnapshotCommand.d.ts +1 -0
  38. package/dist-types/commands/CreateDBInstanceCommand.d.ts +7 -0
  39. package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +6 -0
  40. package/dist-types/commands/CreateDBSnapshotCommand.d.ts +1 -0
  41. package/dist-types/commands/CreateTenantDatabaseCommand.d.ts +122 -0
  42. package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts +1 -0
  43. package/dist-types/commands/DeleteDBInstanceCommand.d.ts +2 -0
  44. package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +1 -0
  45. package/dist-types/commands/DeleteTenantDatabaseCommand.d.ts +111 -0
  46. package/dist-types/commands/DescribeDBClusterAutomatedBackupsCommand.d.ts +2 -1
  47. package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +1 -1
  48. package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +1 -1
  49. package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +1 -1
  50. package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +1 -0
  51. package/dist-types/commands/DescribeDBInstancesCommand.d.ts +2 -0
  52. package/dist-types/commands/DescribeDBSnapshotTenantDatabasesCommand.d.ts +117 -0
  53. package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +1 -0
  54. package/dist-types/commands/DescribeTenantDatabasesCommand.d.ts +114 -0
  55. package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -0
  56. package/dist-types/commands/ModifyDBInstanceCommand.d.ts +7 -0
  57. package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +1 -0
  58. package/dist-types/commands/ModifyTenantDatabaseCommand.d.ts +114 -0
  59. package/dist-types/commands/PromoteReadReplicaCommand.d.ts +2 -0
  60. package/dist-types/commands/RebootDBInstanceCommand.d.ts +2 -0
  61. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +6 -0
  62. package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +6 -0
  63. package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +2 -0
  64. package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +6 -0
  65. package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +1 -0
  66. package/dist-types/commands/StartDBInstanceCommand.d.ts +2 -0
  67. package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +1 -0
  68. package/dist-types/commands/StopDBInstanceCommand.d.ts +2 -0
  69. package/dist-types/commands/SwitchoverReadReplicaCommand.d.ts +2 -0
  70. package/dist-types/commands/index.d.ts +5 -0
  71. package/dist-types/index.d.ts +2 -0
  72. package/dist-types/models/models_0.d.ts +333 -388
  73. package/dist-types/models/models_1.d.ts +1132 -335
  74. package/dist-types/pagination/DescribeDBSnapshotTenantDatabasesPaginator.d.ts +7 -0
  75. package/dist-types/pagination/DescribeTenantDatabasesPaginator.d.ts +7 -0
  76. package/dist-types/pagination/index.d.ts +2 -0
  77. package/dist-types/protocols/Aws_query.d.ts +45 -0
  78. package/dist-types/ts3.4/RDS.d.ts +91 -0
  79. package/dist-types/ts3.4/RDSClient.d.ts +30 -0
  80. package/dist-types/ts3.4/commands/CreateTenantDatabaseCommand.d.ts +42 -0
  81. package/dist-types/ts3.4/commands/DeleteTenantDatabaseCommand.d.ts +42 -0
  82. package/dist-types/ts3.4/commands/DescribeDBClusterAutomatedBackupsCommand.d.ts +2 -4
  83. package/dist-types/ts3.4/commands/DescribeDBClusterBacktracksCommand.d.ts +1 -1
  84. package/dist-types/ts3.4/commands/DescribeDBClusterEndpointsCommand.d.ts +1 -1
  85. package/dist-types/ts3.4/commands/DescribeDBClusterParameterGroupsCommand.d.ts +1 -1
  86. package/dist-types/ts3.4/commands/DescribeDBSnapshotTenantDatabasesCommand.d.ts +42 -0
  87. package/dist-types/ts3.4/commands/DescribeTenantDatabasesCommand.d.ts +42 -0
  88. package/dist-types/ts3.4/commands/ModifyTenantDatabaseCommand.d.ts +42 -0
  89. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  90. package/dist-types/ts3.4/index.d.ts +2 -0
  91. package/dist-types/ts3.4/models/models_0.d.ts +97 -67
  92. package/dist-types/ts3.4/models/models_1.d.ts +129 -1
  93. package/dist-types/ts3.4/pagination/DescribeDBSnapshotTenantDatabasesPaginator.d.ts +11 -0
  94. package/dist-types/ts3.4/pagination/DescribeTenantDatabasesPaginator.d.ts +11 -0
  95. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  96. package/dist-types/ts3.4/protocols/Aws_query.d.ts +60 -0
  97. package/dist-types/ts3.4/waiters/index.d.ts +2 -0
  98. package/dist-types/ts3.4/waiters/waitForTenantDatabaseAvailable.d.ts +11 -0
  99. package/dist-types/ts3.4/waiters/waitForTenantDatabaseDeleted.d.ts +11 -0
  100. package/dist-types/waiters/index.d.ts +2 -0
  101. package/dist-types/waiters/waitForTenantDatabaseAvailable.d.ts +14 -0
  102. package/dist-types/waiters/waitForTenantDatabaseDeleted.d.ts +14 -0
  103. package/package.json +4 -4
@@ -414,7 +414,7 @@ export interface EventSubscription {
414
414
  EventCategoriesList?: string[];
415
415
  /**
416
416
  * @public
417
- * <p>A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.</p>
417
+ * <p>Specifies whether the subscription is enabled. True indicates the subscription is enabled.</p>
418
418
  */
419
419
  Enabled?: boolean;
420
420
  /**
@@ -545,6 +545,18 @@ export declare class DBSnapshotNotFoundFault extends __BaseException {
545
545
  */
546
546
  constructor(opts: __ExceptionOptionType<DBSnapshotNotFoundFault, __BaseException>);
547
547
  }
548
+ /**
549
+ * @public
550
+ * <p>The specified snapshot tenant database wasn't found.</p>
551
+ */
552
+ export declare class DBSnapshotTenantDatabaseNotFoundFault extends __BaseException {
553
+ readonly name: "DBSnapshotTenantDatabaseNotFoundFault";
554
+ readonly $fault: "client";
555
+ /**
556
+ * @internal
557
+ */
558
+ constructor(opts: __ExceptionOptionType<DBSnapshotTenantDatabaseNotFoundFault, __BaseException>);
559
+ }
548
560
  /**
549
561
  * @public
550
562
  * <p>The specified integration could not be found.</p>
@@ -557,6 +569,18 @@ export declare class IntegrationNotFoundFault extends __BaseException {
557
569
  */
558
570
  constructor(opts: __ExceptionOptionType<IntegrationNotFoundFault, __BaseException>);
559
571
  }
572
+ /**
573
+ * @public
574
+ * <p>The specified tenant database wasn't found in the DB instance.</p>
575
+ */
576
+ export declare class TenantDatabaseNotFoundFault extends __BaseException {
577
+ readonly name: "TenantDatabaseNotFoundFault";
578
+ readonly $fault: "client";
579
+ /**
580
+ * @internal
581
+ */
582
+ constructor(opts: __ExceptionOptionType<TenantDatabaseNotFoundFault, __BaseException>);
583
+ }
560
584
  /**
561
585
  * @public
562
586
  * <p></p>
@@ -2235,6 +2259,12 @@ export interface DBSnapshot {
2235
2259
  * <p>Indicates whether the DB instance has a dedicated log volume (DLV) enabled.</p>
2236
2260
  */
2237
2261
  DedicatedLogVolume?: boolean;
2262
+ /**
2263
+ * @public
2264
+ * <p>Indicates whether the snapshot is of a DB instance using the multi-tenant
2265
+ * configuration (TRUE) or the single-tenant configuration (FALSE).</p>
2266
+ */
2267
+ MultiTenant?: boolean;
2238
2268
  }
2239
2269
  /**
2240
2270
  * @public
@@ -6902,6 +6932,25 @@ export interface CreateDBInstanceMessage {
6902
6932
  * <p>Indicates whether the DB instance has a dedicated log volume (DLV) enabled.</p>
6903
6933
  */
6904
6934
  DedicatedLogVolume?: boolean;
6935
+ /**
6936
+ * @public
6937
+ * <p>Specifies whether to use the multi-tenant configuration or the single-tenant
6938
+ * configuration (default). This parameter only applies to RDS for Oracle container
6939
+ * database (CDB) engines.</p>
6940
+ * <p>Note the following restrictions: </p>
6941
+ * <ul>
6942
+ * <li>
6943
+ * <p>The DB engine that you specify in the request must support the multi-tenant
6944
+ * configuration. If you attempt to enable the multi-tenant configuration on a DB
6945
+ * engine that doesn't support it, the request fails.</p>
6946
+ * </li>
6947
+ * <li>
6948
+ * <p>If you specify the multi-tenant configuration when you create your DB instance,
6949
+ * you can't later modify this DB instance to use the single-tenant configuration.</p>
6950
+ * </li>
6951
+ * </ul>
6952
+ */
6953
+ MultiTenant?: boolean;
6905
6954
  }
6906
6955
  /**
6907
6956
  * @public
@@ -7345,6 +7394,12 @@ export interface PendingModifiedValues {
7345
7394
  * <p>Indicates whether the DB instance has a dedicated log volume (DLV) enabled.></p>
7346
7395
  */
7347
7396
  DedicatedLogVolume?: boolean;
7397
+ /**
7398
+ * @public
7399
+ * <p>Indicates whether the DB instance will change to the multi-tenant configuration (TRUE)
7400
+ * or the single-tenant configuration (FALSE). </p>
7401
+ */
7402
+ MultiTenant?: boolean;
7348
7403
  }
7349
7404
  /**
7350
7405
  * @public
@@ -7370,7 +7425,7 @@ export interface DBInstanceStatusInfo {
7370
7425
  StatusType?: string;
7371
7426
  /**
7372
7427
  * @public
7373
- * <p>A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.</p>
7428
+ * <p>Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE).</p>
7374
7429
  */
7375
7430
  Normal?: boolean;
7376
7431
  /**
@@ -7432,7 +7487,7 @@ export interface DBInstance {
7432
7487
  MasterUsername?: string;
7433
7488
  /**
7434
7489
  * @public
7435
- * <p>Contains the initial database name that you provided (if required) when you created
7490
+ * <p>The initial database name that you provided (if required) when you created
7436
7491
  * the DB instance. This name is returned for the life of your DB instance. For an RDS for
7437
7492
  * Oracle CDB instance, the name identifies the PDB rather than the CDB.</p>
7438
7493
  */
@@ -7953,6 +8008,12 @@ export interface DBInstance {
7953
8008
  * information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.UpgradeFileSystem">Upgrading the storage file system for a DB instance</a>.</p>
7954
8009
  */
7955
8010
  IsStorageConfigUpgradeAvailable?: boolean;
8011
+ /**
8012
+ * @public
8013
+ * <p>Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the
8014
+ * single-tenant configuration (FALSE).</p>
8015
+ */
8016
+ MultiTenant?: boolean;
7956
8017
  }
7957
8018
  /**
7958
8019
  * @public
@@ -8030,6 +8091,19 @@ export declare class StorageTypeNotSupportedFault extends __BaseException {
8030
8091
  */
8031
8092
  constructor(opts: __ExceptionOptionType<StorageTypeNotSupportedFault, __BaseException>);
8032
8093
  }
8094
+ /**
8095
+ * @public
8096
+ * <p>You attempted to create more tenant databases than are permitted in your Amazon Web Services
8097
+ * account.</p>
8098
+ */
8099
+ export declare class TenantDatabaseQuotaExceededFault extends __BaseException {
8100
+ readonly name: "TenantDatabaseQuotaExceededFault";
8101
+ readonly $fault: "client";
8102
+ /**
8103
+ * @internal
8104
+ */
8105
+ constructor(opts: __ExceptionOptionType<TenantDatabaseQuotaExceededFault, __BaseException>);
8106
+ }
8033
8107
  /**
8034
8108
  * @public
8035
8109
  */
@@ -9862,13 +9936,16 @@ export interface FailoverState {
9862
9936
  * starts.</p>
9863
9937
  * </li>
9864
9938
  * <li>
9865
- * <p>failing-over – This status covers the range of Aurora internal operations that take place during the switchover or failover process, such
9866
- * as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.</p>
9939
+ * <p>failing-over – Aurora is promoting the chosen secondary Aurora DB cluster to become the new primary DB cluster to fail over the global cluster.</p>
9867
9940
  * </li>
9868
9941
  * <li>
9869
9942
  * <p>cancelling – The request to switch over or fail over the global cluster was cancelled and the primary
9870
9943
  * Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.</p>
9871
9944
  * </li>
9945
+ * <li>
9946
+ * <p>switching-over – This status covers the range of Aurora internal operations that take place during the switchover process, such
9947
+ * as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.</p>
9948
+ * </li>
9872
9949
  * </ul>
9873
9950
  */
9874
9951
  Status?: FailoverStatus;
@@ -10328,6 +10405,192 @@ export interface CreateOptionGroupResult {
10328
10405
  */
10329
10406
  OptionGroup?: OptionGroup;
10330
10407
  }
10408
+ /**
10409
+ * @public
10410
+ */
10411
+ export interface CreateTenantDatabaseMessage {
10412
+ /**
10413
+ * @public
10414
+ * <p>The user-supplied DB instance identifier. RDS creates your tenant database in this DB
10415
+ * instance. This parameter isn't case-sensitive.</p>
10416
+ */
10417
+ DBInstanceIdentifier: string | undefined;
10418
+ /**
10419
+ * @public
10420
+ * <p>The user-supplied name of the tenant database that you want to create in your DB
10421
+ * instance. This parameter has the same constraints as <code>DBName</code> in
10422
+ * <code>CreateDBInstance</code>.</p>
10423
+ */
10424
+ TenantDBName: string | undefined;
10425
+ /**
10426
+ * @public
10427
+ * <p>The name for the master user account in your tenant database. RDS creates this user
10428
+ * account in the tenant database and grants privileges to the master user. This parameter
10429
+ * is case-sensitive.</p>
10430
+ * <p>Constraints:</p>
10431
+ * <ul>
10432
+ * <li>
10433
+ * <p>Must be 1 to 16 letters, numbers, or underscores.</p>
10434
+ * </li>
10435
+ * <li>
10436
+ * <p>First character must be a letter.</p>
10437
+ * </li>
10438
+ * <li>
10439
+ * <p>Can't be a reserved word for the chosen database engine.</p>
10440
+ * </li>
10441
+ * </ul>
10442
+ */
10443
+ MasterUsername: string | undefined;
10444
+ /**
10445
+ * @public
10446
+ * <p>The password for the master user in your tenant database.</p>
10447
+ * <p>Constraints:</p>
10448
+ * <ul>
10449
+ * <li>
10450
+ * <p>Must be 8 to 30 characters.</p>
10451
+ * </li>
10452
+ * <li>
10453
+ * <p>Can include any printable ASCII character except forward slash
10454
+ * (<code>/</code>), double quote (<code>"</code>), at symbol (<code>@</code>),
10455
+ * ampersand (<code>&</code>), or single quote (<code>'</code>).</p>
10456
+ * </li>
10457
+ * </ul>
10458
+ */
10459
+ MasterUserPassword: string | undefined;
10460
+ /**
10461
+ * @public
10462
+ * <p>The character set for your tenant database. If you don't specify a value, the
10463
+ * character set name defaults to <code>AL32UTF8</code>.</p>
10464
+ */
10465
+ CharacterSetName?: string;
10466
+ /**
10467
+ * @public
10468
+ * <p>The <code>NCHAR</code> value for the tenant database.</p>
10469
+ */
10470
+ NcharCharacterSetName?: string;
10471
+ /**
10472
+ * @public
10473
+ * <p>A list of tags.
10474
+ * For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html">Tagging Amazon RDS Resources</a> in the <i>Amazon RDS User Guide.</i>
10475
+ * </p>
10476
+ */
10477
+ Tags?: Tag[];
10478
+ }
10479
+ /**
10480
+ * @public
10481
+ * <p>A response element in the <code>ModifyTenantDatabase</code> operation that describes
10482
+ * changes that will be applied. Specific changes are identified by subelements.</p>
10483
+ */
10484
+ export interface TenantDatabasePendingModifiedValues {
10485
+ /**
10486
+ * @public
10487
+ * <p>The master password for the tenant database.</p>
10488
+ */
10489
+ MasterUserPassword?: string;
10490
+ /**
10491
+ * @public
10492
+ * <p>The name of the tenant database.</p>
10493
+ */
10494
+ TenantDBName?: string;
10495
+ }
10496
+ /**
10497
+ * @public
10498
+ * <p>A tenant database in the DB instance. This data type is an element in the response to
10499
+ * the <code>DescribeTenantDatabases</code> action.</p>
10500
+ */
10501
+ export interface TenantDatabase {
10502
+ /**
10503
+ * @public
10504
+ * <p>The creation time of the tenant database.</p>
10505
+ */
10506
+ TenantDatabaseCreateTime?: Date;
10507
+ /**
10508
+ * @public
10509
+ * <p>The ID of the DB instance that contains the tenant database.</p>
10510
+ */
10511
+ DBInstanceIdentifier?: string;
10512
+ /**
10513
+ * @public
10514
+ * <p>The database name of the tenant database.</p>
10515
+ */
10516
+ TenantDBName?: string;
10517
+ /**
10518
+ * @public
10519
+ * <p>The status of the tenant database.</p>
10520
+ */
10521
+ Status?: string;
10522
+ /**
10523
+ * @public
10524
+ * <p>The master username of the tenant database.</p>
10525
+ */
10526
+ MasterUsername?: string;
10527
+ /**
10528
+ * @public
10529
+ * <p>The Amazon Web Services Region-unique, immutable identifier for the DB instance.</p>
10530
+ */
10531
+ DbiResourceId?: string;
10532
+ /**
10533
+ * @public
10534
+ * <p>The Amazon Web Services Region-unique, immutable identifier for the tenant database.</p>
10535
+ */
10536
+ TenantDatabaseResourceId?: string;
10537
+ /**
10538
+ * @public
10539
+ * <p>The Amazon Resource Name (ARN) for the tenant database.</p>
10540
+ */
10541
+ TenantDatabaseARN?: string;
10542
+ /**
10543
+ * @public
10544
+ * <p>The character set of the tenant database.</p>
10545
+ */
10546
+ CharacterSetName?: string;
10547
+ /**
10548
+ * @public
10549
+ * <p>The <code>NCHAR</code> character set name of the tenant database.</p>
10550
+ */
10551
+ NcharCharacterSetName?: string;
10552
+ /**
10553
+ * @public
10554
+ * <p>Specifies whether deletion protection is enabled for the DB instance.</p>
10555
+ */
10556
+ DeletionProtection?: boolean;
10557
+ /**
10558
+ * @public
10559
+ * <p>Information about pending changes for a tenant database.</p>
10560
+ */
10561
+ PendingModifiedValues?: TenantDatabasePendingModifiedValues;
10562
+ /**
10563
+ * @public
10564
+ * <p>A list of tags.
10565
+ * For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html">Tagging Amazon RDS Resources</a> in the <i>Amazon RDS User Guide.</i>
10566
+ * </p>
10567
+ */
10568
+ TagList?: Tag[];
10569
+ }
10570
+ /**
10571
+ * @public
10572
+ */
10573
+ export interface CreateTenantDatabaseResult {
10574
+ /**
10575
+ * @public
10576
+ * <p>A tenant database in the DB instance. This data type is an element in the response to
10577
+ * the <code>DescribeTenantDatabases</code> action.</p>
10578
+ */
10579
+ TenantDatabase?: TenantDatabase;
10580
+ }
10581
+ /**
10582
+ * @public
10583
+ * <p>You attempted to either create a tenant database that already exists or
10584
+ * modify a tenant database to use the name of an existing tenant database.</p>
10585
+ */
10586
+ export declare class TenantDatabaseAlreadyExistsFault extends __BaseException {
10587
+ readonly name: "TenantDatabaseAlreadyExistsFault";
10588
+ readonly $fault: "client";
10589
+ /**
10590
+ * @internal
10591
+ */
10592
+ constructor(opts: __ExceptionOptionType<TenantDatabaseAlreadyExistsFault, __BaseException>);
10593
+ }
10331
10594
  /**
10332
10595
  * @public
10333
10596
  */
@@ -11123,6 +11386,12 @@ export interface DBInstanceAutomatedBackup {
11123
11386
  * <p>Indicates whether the DB instance has a dedicated log volume (DLV) enabled.</p>
11124
11387
  */
11125
11388
  DedicatedLogVolume?: boolean;
11389
+ /**
11390
+ * @public
11391
+ * <p>Specifies whether the automatic backup is for a DB instance in the multi-tenant
11392
+ * configuration (TRUE) or the single-tenant configuration (FALSE). </p>
11393
+ */
11394
+ MultiTenant?: boolean;
11126
11395
  }
11127
11396
  /**
11128
11397
  * @public
@@ -11418,6 +11687,55 @@ export declare class InvalidOptionGroupStateFault extends __BaseException {
11418
11687
  */
11419
11688
  constructor(opts: __ExceptionOptionType<InvalidOptionGroupStateFault, __BaseException>);
11420
11689
  }
11690
+ /**
11691
+ * @public
11692
+ */
11693
+ export interface DeleteTenantDatabaseMessage {
11694
+ /**
11695
+ * @public
11696
+ * <p>The user-supplied identifier for the DB instance that contains the tenant database
11697
+ * that you want to delete.</p>
11698
+ */
11699
+ DBInstanceIdentifier: string | undefined;
11700
+ /**
11701
+ * @public
11702
+ * <p>The user-supplied name of the tenant database that you want to remove from your DB
11703
+ * instance. Amazon RDS deletes the tenant database with this name. This parameter isn’t
11704
+ * case-sensitive.</p>
11705
+ */
11706
+ TenantDBName: string | undefined;
11707
+ /**
11708
+ * @public
11709
+ * <p>Specifies whether to skip the creation of a final DB snapshot before removing the
11710
+ * tenant database from your DB instance. If you enable this parameter, RDS doesn't create
11711
+ * a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before it
11712
+ * deletes the tenant database. By default, RDS doesn't skip the final snapshot. If you
11713
+ * don't enable this parameter, you must specify the <code>FinalDBSnapshotIdentifier</code>
11714
+ * parameter.</p>
11715
+ */
11716
+ SkipFinalSnapshot?: boolean;
11717
+ /**
11718
+ * @public
11719
+ * <p>The <code>DBSnapshotIdentifier</code> of the new <code>DBSnapshot</code> created when
11720
+ * the <code>SkipFinalSnapshot</code> parameter is disabled.</p>
11721
+ * <note>
11722
+ * <p>If you enable this parameter and also enable <code>SkipFinalShapshot</code>, the
11723
+ * command results in an error.</p>
11724
+ * </note>
11725
+ */
11726
+ FinalDBSnapshotIdentifier?: string;
11727
+ }
11728
+ /**
11729
+ * @public
11730
+ */
11731
+ export interface DeleteTenantDatabaseResult {
11732
+ /**
11733
+ * @public
11734
+ * <p>A tenant database in the DB instance. This data type is an element in the response to
11735
+ * the <code>DescribeTenantDatabases</code> action.</p>
11736
+ */
11737
+ TenantDatabase?: TenantDatabase;
11738
+ }
11421
11739
  /**
11422
11740
  * @public
11423
11741
  * <p>The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>
@@ -11744,395 +12062,22 @@ export interface DBClusterAutomatedBackupMessage {
11744
12062
  DBClusterAutomatedBackups?: DBClusterAutomatedBackup[];
11745
12063
  }
11746
12064
  /**
11747
- * @public
11748
- */
11749
- export interface DescribeDBClusterAutomatedBackupsMessage {
11750
- /**
11751
- * @public
11752
- * <p>The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.</p>
11753
- */
11754
- DbClusterResourceId?: string;
11755
- /**
11756
- * @public
11757
- * <p>(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must
11758
- * match the identifier of an existing DB cluster. It returns information from the
11759
- * specific DB cluster's automated backup. This parameter isn't case-sensitive.</p>
11760
- */
11761
- DBClusterIdentifier?: string;
11762
- /**
11763
- * @public
11764
- * <p>A filter that specifies which resources to return based on status.</p>
11765
- * <p>Supported filters are the following:</p>
11766
- * <ul>
11767
- * <li>
11768
- * <p>
11769
- * <code>status</code>
11770
- * </p>
11771
- * <ul>
11772
- * <li>
11773
- * <p>
11774
- * <code>retained</code> - Automated backups for deleted clusters and after backup replication is stopped.</p>
11775
- * </li>
11776
- * </ul>
11777
- * </li>
11778
- * <li>
11779
- * <p>
11780
- * <code>db-cluster-id</code> - Accepts DB cluster identifiers and Amazon Resource Names (ARNs).
11781
- * The results list includes only information about the DB cluster automated backups identified by these ARNs.</p>
11782
- * </li>
11783
- * <li>
11784
- * <p>
11785
- * <code>db-cluster-resource-id</code> - Accepts DB resource identifiers and Amazon Resource Names (ARNs).
11786
- * The results list includes only information about the DB cluster resources identified by these ARNs.</p>
11787
- * </li>
11788
- * </ul>
11789
- * <p>Returns all resources by default. The status for each resource is specified in the response.</p>
11790
- */
11791
- Filters?: Filter[];
11792
- /**
11793
- * @public
11794
- * <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code>
11795
- * value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.</p>
11796
- */
11797
- MaxRecords?: number;
11798
- /**
11799
- * @public
11800
- * <p>The pagination token provided in the previous request. If this parameter is specified the response includes only
11801
- * records beyond the marker, up to <code>MaxRecords</code>.</p>
11802
- */
11803
- Marker?: string;
11804
- }
11805
- /**
11806
- * @public
11807
- * <p>Contains the result of a successful invocation of the <code>DescribeDBClusterBacktracks</code> action.</p>
11808
- */
11809
- export interface DBClusterBacktrackMessage {
11810
- /**
11811
- * @public
11812
- * <p>A pagination token that can be used in a later <code>DescribeDBClusterBacktracks</code> request.</p>
11813
- */
11814
- Marker?: string;
11815
- /**
11816
- * @public
11817
- * <p>Contains a list of backtracks for the user.</p>
11818
- */
11819
- DBClusterBacktracks?: DBClusterBacktrack[];
11820
- }
11821
- /**
11822
- * @public
11823
- * <p>
11824
- * <code>BacktrackIdentifier</code> doesn't refer to an existing backtrack.</p>
11825
- */
11826
- export declare class DBClusterBacktrackNotFoundFault extends __BaseException {
11827
- readonly name: "DBClusterBacktrackNotFoundFault";
11828
- readonly $fault: "client";
11829
- /**
11830
- * @internal
11831
- */
11832
- constructor(opts: __ExceptionOptionType<DBClusterBacktrackNotFoundFault, __BaseException>);
11833
- }
11834
- /**
11835
- * @public
11836
- * <p></p>
11837
- */
11838
- export interface DescribeDBClusterBacktracksMessage {
11839
- /**
11840
- * @public
11841
- * <p>The DB cluster identifier of the DB cluster to be described. This parameter is
11842
- * stored as a lowercase string.</p>
11843
- * <p>Constraints:</p>
11844
- * <ul>
11845
- * <li>
11846
- * <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p>
11847
- * </li>
11848
- * <li>
11849
- * <p>First character must be a letter.</p>
11850
- * </li>
11851
- * <li>
11852
- * <p>Can't end with a hyphen or contain two consecutive hyphens.</p>
11853
- * </li>
11854
- * </ul>
11855
- * <p>Example: <code>my-cluster1</code>
11856
- * </p>
11857
- */
11858
- DBClusterIdentifier: string | undefined;
11859
- /**
11860
- * @public
11861
- * <p>If specified, this value is the backtrack identifier of the backtrack to be
11862
- * described.</p>
11863
- * <p>Constraints:</p>
11864
- * <ul>
11865
- * <li>
11866
- * <p>Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see
11867
- * <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">Universally unique
11868
- * identifier</a>.</p>
11869
- * </li>
11870
- * </ul>
11871
- * <p>Example: <code>123e4567-e89b-12d3-a456-426655440000</code>
11872
- * </p>
11873
- */
11874
- BacktrackIdentifier?: string;
11875
- /**
11876
- * @public
11877
- * <p>A filter that specifies one or more DB clusters to describe. Supported filters
11878
- * include the following:</p>
11879
- * <ul>
11880
- * <li>
11881
- * <p>
11882
- * <code>db-cluster-backtrack-id</code> - Accepts backtrack identifiers. The
11883
- * results list includes information about only the backtracks identified by these
11884
- * identifiers.</p>
11885
- * </li>
11886
- * <li>
11887
- * <p>
11888
- * <code>db-cluster-backtrack-status</code> - Accepts any of the following backtrack status values:</p>
11889
- * <ul>
11890
- * <li>
11891
- * <p>
11892
- * <code>applying</code>
11893
- * </p>
11894
- * </li>
11895
- * <li>
11896
- * <p>
11897
- * <code>completed</code>
11898
- * </p>
11899
- * </li>
11900
- * <li>
11901
- * <p>
11902
- * <code>failed</code>
11903
- * </p>
11904
- * </li>
11905
- * <li>
11906
- * <p>
11907
- * <code>pending</code>
11908
- * </p>
11909
- * </li>
11910
- * </ul>
11911
- * <p>The results list includes information about only the backtracks identified
11912
- * by these values.</p>
11913
- * </li>
11914
- * </ul>
11915
- */
11916
- Filters?: Filter[];
11917
- /**
11918
- * @public
11919
- * <p>The maximum number of records to include in the response.
11920
- * If more records exist than the specified <code>MaxRecords</code> value,
11921
- * a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
11922
- * <p>Default: 100</p>
11923
- * <p>Constraints: Minimum 20, maximum 100.</p>
11924
- */
11925
- MaxRecords?: number;
11926
- /**
11927
- * @public
11928
- * <p>An optional pagination token provided by a previous
11929
- * <code>DescribeDBClusterBacktracks</code> request.
11930
- * If this parameter is specified, the response includes
11931
- * only records beyond the marker,
11932
- * up to the value specified by <code>MaxRecords</code>.</p>
11933
- */
11934
- Marker?: string;
11935
- }
11936
- /**
11937
- * @public
11938
- */
11939
- export interface DBClusterEndpointMessage {
11940
- /**
11941
- * @public
11942
- * <p>An optional pagination token provided by a previous
11943
- * <code>DescribeDBClusterEndpoints</code> request.
11944
- * If this parameter is specified, the response includes
11945
- * only records beyond the marker,
11946
- * up to the value specified by <code>MaxRecords</code>.</p>
11947
- */
11948
- Marker?: string;
11949
- /**
11950
- * @public
11951
- * <p>Contains the details of the endpoints associated with the cluster
11952
- * and matching any filter conditions.</p>
11953
- */
11954
- DBClusterEndpoints?: DBClusterEndpoint[];
11955
- }
11956
- /**
11957
- * @public
11958
- */
11959
- export interface DescribeDBClusterEndpointsMessage {
11960
- /**
11961
- * @public
11962
- * <p>The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is
11963
- * stored as a lowercase string.</p>
11964
- */
11965
- DBClusterIdentifier?: string;
11966
- /**
11967
- * @public
11968
- * <p>The identifier of the endpoint to describe. This parameter is stored as a lowercase string.</p>
11969
- */
11970
- DBClusterEndpointIdentifier?: string;
11971
- /**
11972
- * @public
11973
- * <p>A set of name-value pairs that define which endpoints to include in the output.
11974
- * The filters are specified as name-value pairs, in the format
11975
- * <code>Name=<i>endpoint_type</i>,Values=<i>endpoint_type1</i>,<i>endpoint_type2</i>,...</code>.
11976
- * <code>Name</code> can be one of: <code>db-cluster-endpoint-type</code>, <code>db-cluster-endpoint-custom-type</code>, <code>db-cluster-endpoint-id</code>, <code>db-cluster-endpoint-status</code>.
11977
- * <code>Values</code> for the <code> db-cluster-endpoint-type</code> filter can be one or more of: <code>reader</code>, <code>writer</code>, <code>custom</code>.
11978
- * <code>Values</code> for the <code>db-cluster-endpoint-custom-type</code> filter can be one or more of: <code>reader</code>, <code>any</code>.
11979
- * <code>Values</code> for the <code>db-cluster-endpoint-status</code> filter can be one or more of: <code>available</code>, <code>creating</code>, <code>deleting</code>, <code>inactive</code>, <code>modifying</code>.</p>
11980
- */
11981
- Filters?: Filter[];
11982
- /**
11983
- * @public
11984
- * <p>The maximum number of records to include in the response.
11985
- * If more records exist than the specified <code>MaxRecords</code> value,
11986
- * a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
11987
- * <p>Default: 100</p>
11988
- * <p>Constraints: Minimum 20, maximum 100.</p>
11989
- */
11990
- MaxRecords?: number;
11991
- /**
11992
- * @public
11993
- * <p>An optional pagination token provided by a previous
11994
- * <code>DescribeDBClusterEndpoints</code> request.
11995
- * If this parameter is specified, the response includes
11996
- * only records beyond the marker,
11997
- * up to the value specified by <code>MaxRecords</code>.</p>
11998
- */
11999
- Marker?: string;
12000
- }
12001
- /**
12002
- * @public
12003
- * <p></p>
12065
+ * @internal
12004
12066
  */
12005
- export interface DBClusterParameterGroupsMessage {
12006
- /**
12007
- * @public
12008
- * <p>An optional pagination token provided by a previous
12009
- * <code>DescribeDBClusterParameterGroups</code> request.
12010
- * If this parameter is specified, the response includes
12011
- * only records beyond the marker,
12012
- * up to the value specified by <code>MaxRecords</code>.</p>
12013
- */
12014
- Marker?: string;
12015
- /**
12016
- * @public
12017
- * <p>A list of DB cluster parameter groups.</p>
12018
- */
12019
- DBClusterParameterGroups?: DBClusterParameterGroup[];
12020
- }
12067
+ export declare const CreateTenantDatabaseMessageFilterSensitiveLog: (obj: CreateTenantDatabaseMessage) => any;
12021
12068
  /**
12022
- * @public
12023
- * <p></p>
12069
+ * @internal
12024
12070
  */
12025
- export interface DescribeDBClusterParameterGroupsMessage {
12026
- /**
12027
- * @public
12028
- * <p>The name of a specific DB cluster parameter group to return details for.</p>
12029
- * <p>Constraints:</p>
12030
- * <ul>
12031
- * <li>
12032
- * <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p>
12033
- * </li>
12034
- * </ul>
12035
- */
12036
- DBClusterParameterGroupName?: string;
12037
- /**
12038
- * @public
12039
- * <p>This parameter isn't currently supported.</p>
12040
- */
12041
- Filters?: Filter[];
12042
- /**
12043
- * @public
12044
- * <p>The maximum number of records to include in the response.
12045
- * If more records exist than the specified <code>MaxRecords</code> value,
12046
- * a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
12047
- * <p>Default: 100</p>
12048
- * <p>Constraints: Minimum 20, maximum 100.</p>
12049
- */
12050
- MaxRecords?: number;
12051
- /**
12052
- * @public
12053
- * <p>An optional pagination token provided by a previous
12054
- * <code>DescribeDBClusterParameterGroups</code> request.
12055
- * If this parameter is specified, the response includes
12056
- * only records beyond the marker,
12057
- * up to the value specified by <code>MaxRecords</code>.</p>
12058
- */
12059
- Marker?: string;
12060
- }
12071
+ export declare const TenantDatabasePendingModifiedValuesFilterSensitiveLog: (obj: TenantDatabasePendingModifiedValues) => any;
12061
12072
  /**
12062
- * @public
12063
- * @enum
12073
+ * @internal
12064
12074
  */
12065
- export declare const ApplyMethod: {
12066
- readonly immediate: "immediate";
12067
- readonly pending_reboot: "pending-reboot";
12068
- };
12075
+ export declare const TenantDatabaseFilterSensitiveLog: (obj: TenantDatabase) => any;
12069
12076
  /**
12070
- * @public
12077
+ * @internal
12071
12078
  */
12072
- export type ApplyMethod = (typeof ApplyMethod)[keyof typeof ApplyMethod];
12079
+ export declare const CreateTenantDatabaseResultFilterSensitiveLog: (obj: CreateTenantDatabaseResult) => any;
12073
12080
  /**
12074
- * @public
12075
- * <p>This data type is used as a request parameter in the
12076
- * <code>ModifyDBParameterGroup</code> and <code>ResetDBParameterGroup</code> actions.</p>
12077
- * <p>This data type is used as a response element in the
12078
- * <code>DescribeEngineDefaultParameters</code> and <code>DescribeDBParameters</code> actions.</p>
12081
+ * @internal
12079
12082
  */
12080
- export interface Parameter {
12081
- /**
12082
- * @public
12083
- * <p>The name of the parameter.</p>
12084
- */
12085
- ParameterName?: string;
12086
- /**
12087
- * @public
12088
- * <p>The value of the parameter.</p>
12089
- */
12090
- ParameterValue?: string;
12091
- /**
12092
- * @public
12093
- * <p>Provides a description of the parameter.</p>
12094
- */
12095
- Description?: string;
12096
- /**
12097
- * @public
12098
- * <p>The source of the parameter value.</p>
12099
- */
12100
- Source?: string;
12101
- /**
12102
- * @public
12103
- * <p>Specifies the engine specific parameters type.</p>
12104
- */
12105
- ApplyType?: string;
12106
- /**
12107
- * @public
12108
- * <p>Specifies the valid data type for the parameter.</p>
12109
- */
12110
- DataType?: string;
12111
- /**
12112
- * @public
12113
- * <p>Specifies the valid range of values for the parameter.</p>
12114
- */
12115
- AllowedValues?: string;
12116
- /**
12117
- * @public
12118
- * <p>Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified.
12119
- * Some parameters have security or operational implications
12120
- * that prevent them from being changed.</p>
12121
- */
12122
- IsModifiable?: boolean;
12123
- /**
12124
- * @public
12125
- * <p>The earliest engine version to which the parameter can apply.</p>
12126
- */
12127
- MinimumEngineVersion?: string;
12128
- /**
12129
- * @public
12130
- * <p>Indicates when to apply parameter updates.</p>
12131
- */
12132
- ApplyMethod?: ApplyMethod;
12133
- /**
12134
- * @public
12135
- * <p>The valid DB engine modes.</p>
12136
- */
12137
- SupportedEngineModes?: string[];
12138
- }
12083
+ export declare const DeleteTenantDatabaseResultFilterSensitiveLog: (obj: DeleteTenantDatabaseResult) => any;