@aws-sdk/client-rds 3.301.0 → 3.302.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.
@@ -2825,6 +2825,9 @@ const deserializeAws_queryCreateDBInstanceReadReplicaCommandError = async (outpu
2825
2825
  };
2826
2826
  const errorCode = loadQueryErrorCode(output, parsedOutput.body);
2827
2827
  switch (errorCode) {
2828
+ case "DBClusterNotFoundFault":
2829
+ case "com.amazonaws.rds#DBClusterNotFoundFault":
2830
+ throw await deserializeAws_queryDBClusterNotFoundFaultResponse(parsedOutput, context);
2828
2831
  case "DBInstanceAlreadyExists":
2829
2832
  case "com.amazonaws.rds#DBInstanceAlreadyExistsFault":
2830
2833
  throw await deserializeAws_queryDBInstanceAlreadyExistsFaultResponse(parsedOutput, context);
@@ -2855,6 +2858,9 @@ const deserializeAws_queryCreateDBInstanceReadReplicaCommandError = async (outpu
2855
2858
  case "InsufficientDBInstanceCapacity":
2856
2859
  case "com.amazonaws.rds#InsufficientDBInstanceCapacityFault":
2857
2860
  throw await deserializeAws_queryInsufficientDBInstanceCapacityFaultResponse(parsedOutput, context);
2861
+ case "InvalidDBClusterStateFault":
2862
+ case "com.amazonaws.rds#InvalidDBClusterStateFault":
2863
+ throw await deserializeAws_queryInvalidDBClusterStateFaultResponse(parsedOutput, context);
2858
2864
  case "InvalidDBInstanceState":
2859
2865
  case "com.amazonaws.rds#InvalidDBInstanceStateFault":
2860
2866
  throw await deserializeAws_queryInvalidDBInstanceStateFaultResponse(parsedOutput, context);
@@ -9985,6 +9991,9 @@ const serializeAws_queryCreateDBInstanceReadReplicaMessage = (input, context) =>
9985
9991
  if (input.AllocatedStorage != null) {
9986
9992
  entries["AllocatedStorage"] = input.AllocatedStorage;
9987
9993
  }
9994
+ if (input.SourceDBClusterIdentifier != null) {
9995
+ entries["SourceDBClusterIdentifier"] = input.SourceDBClusterIdentifier;
9996
+ }
9988
9997
  return entries;
9989
9998
  };
9990
9999
  const serializeAws_queryCreateDBParameterGroupMessage = (input, context) => {
@@ -15545,6 +15554,9 @@ const deserializeAws_queryDBInstance = (output, context) => {
15545
15554
  if (output["CertificateDetails"] !== undefined) {
15546
15555
  contents.CertificateDetails = deserializeAws_queryCertificateDetails(output["CertificateDetails"], context);
15547
15556
  }
15557
+ if (output["ReadReplicaSourceDBClusterIdentifier"] !== undefined) {
15558
+ contents.ReadReplicaSourceDBClusterIdentifier = (0, smithy_client_1.expectString)(output["ReadReplicaSourceDBClusterIdentifier"]);
15559
+ }
15548
15560
  return contents;
15549
15561
  };
15550
15562
  const deserializeAws_queryDBInstanceAlreadyExistsFault = (output, context) => {
@@ -2655,6 +2655,9 @@ const deserializeAws_queryCreateDBInstanceReadReplicaCommandError = async (outpu
2655
2655
  };
2656
2656
  const errorCode = loadQueryErrorCode(output, parsedOutput.body);
2657
2657
  switch (errorCode) {
2658
+ case "DBClusterNotFoundFault":
2659
+ case "com.amazonaws.rds#DBClusterNotFoundFault":
2660
+ throw await deserializeAws_queryDBClusterNotFoundFaultResponse(parsedOutput, context);
2658
2661
  case "DBInstanceAlreadyExists":
2659
2662
  case "com.amazonaws.rds#DBInstanceAlreadyExistsFault":
2660
2663
  throw await deserializeAws_queryDBInstanceAlreadyExistsFaultResponse(parsedOutput, context);
@@ -2685,6 +2688,9 @@ const deserializeAws_queryCreateDBInstanceReadReplicaCommandError = async (outpu
2685
2688
  case "InsufficientDBInstanceCapacity":
2686
2689
  case "com.amazonaws.rds#InsufficientDBInstanceCapacityFault":
2687
2690
  throw await deserializeAws_queryInsufficientDBInstanceCapacityFaultResponse(parsedOutput, context);
2691
+ case "InvalidDBClusterStateFault":
2692
+ case "com.amazonaws.rds#InvalidDBClusterStateFault":
2693
+ throw await deserializeAws_queryInvalidDBClusterStateFaultResponse(parsedOutput, context);
2688
2694
  case "InvalidDBInstanceState":
2689
2695
  case "com.amazonaws.rds#InvalidDBInstanceStateFault":
2690
2696
  throw await deserializeAws_queryInvalidDBInstanceStateFaultResponse(parsedOutput, context);
@@ -9695,6 +9701,9 @@ const serializeAws_queryCreateDBInstanceReadReplicaMessage = (input, context) =>
9695
9701
  if (input.AllocatedStorage != null) {
9696
9702
  entries["AllocatedStorage"] = input.AllocatedStorage;
9697
9703
  }
9704
+ if (input.SourceDBClusterIdentifier != null) {
9705
+ entries["SourceDBClusterIdentifier"] = input.SourceDBClusterIdentifier;
9706
+ }
9698
9707
  return entries;
9699
9708
  };
9700
9709
  const serializeAws_queryCreateDBParameterGroupMessage = (input, context) => {
@@ -15255,6 +15264,9 @@ const deserializeAws_queryDBInstance = (output, context) => {
15255
15264
  if (output["CertificateDetails"] !== undefined) {
15256
15265
  contents.CertificateDetails = deserializeAws_queryCertificateDetails(output["CertificateDetails"], context);
15257
15266
  }
15267
+ if (output["ReadReplicaSourceDBClusterIdentifier"] !== undefined) {
15268
+ contents.ReadReplicaSourceDBClusterIdentifier = __expectString(output["ReadReplicaSourceDBClusterIdentifier"]);
15269
+ }
15258
15270
  return contents;
15259
15271
  };
15260
15272
  const deserializeAws_queryDBInstanceAlreadyExistsFault = (output, context) => {
@@ -396,13 +396,14 @@ export declare class RDS extends RDSClient {
396
396
  * request creates a writer and two reader DB instances for you, each in a different
397
397
  * Availability Zone.</p>
398
398
  * <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create an Amazon
399
- * Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or
399
+ * Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or
400
400
  * PostgreSQL DB instance. For more information about Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">What is Amazon Aurora?</a> in the <i>Amazon Aurora User
401
- * Guide</i>.</p>
401
+ * Guide</i>.</p>
402
402
  * <p>You can also use the <code>ReplicationSourceIdentifier</code> parameter to create a
403
- * Multi-AZ DB cluster read replica with an RDS for PostgreSQL DB instance as the source.
404
- * For more information about Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">Multi-AZ DB cluster deployments</a> in the <i>Amazon
405
- * RDS User Guide</i>.</p>
403
+ * Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the
404
+ * source. For more information about Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">Multi-AZ DB
405
+ * cluster deployments</a> in the <i>Amazon RDS User
406
+ * Guide</i>.</p>
406
407
  */
407
408
  createDBCluster(args: CreateDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBClusterCommandOutput>;
408
409
  createDBCluster(args: CreateDBClusterCommandInput, cb: (err: any, data?: CreateDBClusterCommandOutput) => void): void;
@@ -483,16 +484,17 @@ export declare class RDS extends RDSClient {
483
484
  /**
484
485
  * @public
485
486
  * <p>Creates a new DB instance that acts as a read replica for an existing source DB
486
- * instance. You can create a read replica for a DB instance running MySQL, MariaDB,
487
- * Oracle, PostgreSQL, or SQL Server. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html">Working with Read
488
- * Replicas</a> in the <i>Amazon RDS User Guide</i>.</p>
487
+ * instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running
488
+ * MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a
489
+ * Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html">Working
490
+ * with read replicas</a> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html#multi-az-db-clusters-migrating-to-instance-with-read-replica">Migrating from a Multi-AZ DB cluster to a DB instance using a read replica</a> in the <i>Amazon RDS User Guide</i>.</p>
489
491
  * <p>Amazon Aurora doesn't support this operation. Call the <code>CreateDBInstance</code>
490
492
  * operation to create a DB instance for an Aurora DB cluster.</p>
491
- * <p>All read replica DB instances are created with backups disabled. All other DB
492
- * instance attributes (including DB security groups and DB parameter groups) are inherited
493
- * from the source DB instance, except as specified.</p>
493
+ * <p>All read replica DB instances are created with backups disabled. All other attributes
494
+ * (including DB security groups and DB parameter groups) are inherited from the source DB
495
+ * instance or cluster, except as specified.</p>
494
496
  * <important>
495
- * <p>Your source DB instance must have backup retention enabled.</p>
497
+ * <p>Your source DB instance or cluster must have backup retention enabled.</p>
496
498
  * </important>
497
499
  */
498
500
  createDBInstanceReadReplica(args: CreateDBInstanceReadReplicaCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBInstanceReadReplicaCommandOutput>;
@@ -671,6 +673,8 @@ export declare class RDS extends RDSClient {
671
673
  * <p>The DeleteDBCluster action deletes a previously provisioned DB cluster.
672
674
  * When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered.
673
675
  * Manual DB cluster snapshots of the specified DB cluster are not deleted.</p>
676
+ * <p>If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are
677
+ * terminated and read replicas are promoted to standalone instances.</p>
674
678
  * <p>For more information on Amazon Aurora, see
675
679
  * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
676
680
  * What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
@@ -25,13 +25,14 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
25
25
  * request creates a writer and two reader DB instances for you, each in a different
26
26
  * Availability Zone.</p>
27
27
  * <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create an Amazon
28
- * Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or
28
+ * Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or
29
29
  * PostgreSQL DB instance. For more information about Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">What is Amazon Aurora?</a> in the <i>Amazon Aurora User
30
- * Guide</i>.</p>
30
+ * Guide</i>.</p>
31
31
  * <p>You can also use the <code>ReplicationSourceIdentifier</code> parameter to create a
32
- * Multi-AZ DB cluster read replica with an RDS for PostgreSQL DB instance as the source.
33
- * For more information about Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">Multi-AZ DB cluster deployments</a> in the <i>Amazon
34
- * RDS User Guide</i>.</p>
32
+ * Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the
33
+ * source. For more information about Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">Multi-AZ DB
34
+ * cluster deployments</a> in the <i>Amazon RDS User
35
+ * Guide</i>.</p>
35
36
  * @example
36
37
  * Use a bare-bones client and the command you need to make an API call.
37
38
  * ```javascript
@@ -20,16 +20,17 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
20
20
  /**
21
21
  * @public
22
22
  * <p>Creates a new DB instance that acts as a read replica for an existing source DB
23
- * instance. You can create a read replica for a DB instance running MySQL, MariaDB,
24
- * Oracle, PostgreSQL, or SQL Server. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html">Working with Read
25
- * Replicas</a> in the <i>Amazon RDS User Guide</i>.</p>
23
+ * instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running
24
+ * MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a
25
+ * Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html">Working
26
+ * with read replicas</a> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html#multi-az-db-clusters-migrating-to-instance-with-read-replica">Migrating from a Multi-AZ DB cluster to a DB instance using a read replica</a> in the <i>Amazon RDS User Guide</i>.</p>
26
27
  * <p>Amazon Aurora doesn't support this operation. Call the <code>CreateDBInstance</code>
27
28
  * operation to create a DB instance for an Aurora DB cluster.</p>
28
- * <p>All read replica DB instances are created with backups disabled. All other DB
29
- * instance attributes (including DB security groups and DB parameter groups) are inherited
30
- * from the source DB instance, except as specified.</p>
29
+ * <p>All read replica DB instances are created with backups disabled. All other attributes
30
+ * (including DB security groups and DB parameter groups) are inherited from the source DB
31
+ * instance or cluster, except as specified.</p>
31
32
  * <important>
32
- * <p>Your source DB instance must have backup retention enabled.</p>
33
+ * <p>Your source DB instance or cluster must have backup retention enabled.</p>
33
34
  * </important>
34
35
  * @example
35
36
  * Use a bare-bones client and the command you need to make an API call.
@@ -39,7 +40,7 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
39
40
  * const client = new RDSClient(config);
40
41
  * const input = { // CreateDBInstanceReadReplicaMessage
41
42
  * DBInstanceIdentifier: "STRING_VALUE", // required
42
- * SourceDBInstanceIdentifier: "STRING_VALUE", // required
43
+ * SourceDBInstanceIdentifier: "STRING_VALUE",
43
44
  * DBInstanceClass: "STRING_VALUE",
44
45
  * AvailabilityZone: "STRING_VALUE",
45
46
  * Port: Number("int"),
@@ -89,6 +90,7 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
89
90
  * StorageThroughput: Number("int"),
90
91
  * EnableCustomerOwnedIp: true || false,
91
92
  * AllocatedStorage: Number("int"),
93
+ * SourceDBClusterIdentifier: "STRING_VALUE",
92
94
  * };
93
95
  * const command = new CreateDBInstanceReadReplicaCommand(input);
94
96
  * const response = await client.send(command);
@@ -100,6 +102,10 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
100
102
  * @see {@link CreateDBInstanceReadReplicaCommandOutput} for command's `response` shape.
101
103
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
102
104
  *
105
+ * @throws {@link DBClusterNotFoundFault} (client fault)
106
+ * <p>
107
+ * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
108
+ *
103
109
  * @throws {@link DBInstanceAlreadyExistsFault} (client fault)
104
110
  * <p>The user already has a DB instance with the given identifier.</p>
105
111
  *
@@ -139,6 +145,9 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
139
145
  * <p>The specified DB instance class isn't available in the specified Availability
140
146
  * Zone.</p>
141
147
  *
148
+ * @throws {@link InvalidDBClusterStateFault} (client fault)
149
+ * <p>The requested operation can't be performed while the cluster is in this state.</p>
150
+ *
142
151
  * @throws {@link InvalidDBInstanceStateFault} (client fault)
143
152
  * <p>The DB instance isn't in a valid state.</p>
144
153
  *
@@ -22,6 +22,8 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
22
22
  * <p>The DeleteDBCluster action deletes a previously provisioned DB cluster.
23
23
  * When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered.
24
24
  * Manual DB cluster snapshots of the specified DB cluster are not deleted.</p>
25
+ * <p>If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are
26
+ * terminated and read replicas are promoted to standalone instances.</p>
25
27
  * <p>For more information on Amazon Aurora, see
26
28
  * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
27
29
  * What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
@@ -3364,7 +3364,7 @@ export interface CreateDBClusterMessage {
3364
3364
  /**
3365
3365
  * <p>The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB
3366
3366
  * cluster is created as a read replica.</p>
3367
- * <p>Valid for: Aurora DB clusters and RDS for PostgreSQL Multi-AZ DB clusters</p>
3367
+ * <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
3368
3368
  */
3369
3369
  ReplicationSourceIdentifier?: string;
3370
3370
  /**
@@ -7031,6 +7031,11 @@ export interface DBInstance {
7031
7031
  * <p>The details of the DB instance's server certificate.</p>
7032
7032
  */
7033
7033
  CertificateDetails?: CertificateDetails;
7034
+ /**
7035
+ * <p>Contains the identifier of the source DB cluster if this DB instance is a read
7036
+ * replica.</p>
7037
+ */
7038
+ ReadReplicaSourceDBClusterIdentifier?: string;
7034
7039
  }
7035
7040
  /**
7036
7041
  * @public
@@ -7119,7 +7124,8 @@ export interface CreateDBInstanceReadReplicaMessage {
7119
7124
  DBInstanceIdentifier: string | undefined;
7120
7125
  /**
7121
7126
  * <p>The identifier of the DB instance that will act as the source for the read replica.
7122
- * Each DB instance can have up to five read replicas.</p>
7127
+ * Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL
7128
+ * Server, which can have up to five.</p>
7123
7129
  * <p>Constraints:</p>
7124
7130
  * <ul>
7125
7131
  * <li>
@@ -7127,20 +7133,15 @@ export interface CreateDBInstanceReadReplicaMessage {
7127
7133
  * instance.</p>
7128
7134
  * </li>
7129
7135
  * <li>
7130
- * <p>Can specify a DB instance that is a MySQL read replica only if the source is running MySQL
7131
- * 5.6 or later.</p>
7136
+ * <p>Can't be specified if the <code>SourceDBClusterIdentifier</code> parameter is
7137
+ * also specified.</p>
7132
7138
  * </li>
7133
7139
  * <li>
7134
- * <p>For the limitations of Oracle read replicas, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Read Replica Limitations with Oracle</a> in the
7140
+ * <p>For the limitations of Oracle read replicas, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.limitations.html#oracle-read-replicas.limitations.versions-and-licenses">Version and licensing considerations for RDS for Oracle replicas</a> in the
7135
7141
  * <i>Amazon RDS User Guide</i>.</p>
7136
7142
  * </li>
7137
7143
  * <li>
7138
- * <p>For the limitations of SQL Server read replicas, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.Limitations.html">Read Replica
7139
- * Limitations with Microsoft SQL Server</a> in the <i>Amazon RDS User Guide</i>.</p>
7140
- * </li>
7141
- * <li>
7142
- * <p>Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or
7143
- * later (9.4.7 and higher for cross-Region replication).</p>
7144
+ * <p>For the limitations of SQL Server read replicas, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.html#SQLServer.ReadReplicas.Limitations">Read replica limitations with SQL Server</a> in the <i>Amazon RDS User Guide</i>.</p>
7144
7145
  * </li>
7145
7146
  * <li>
7146
7147
  * <p>The specified DB instance must have automatic backups enabled, that is, its backup
@@ -7151,14 +7152,14 @@ export interface CreateDBInstanceReadReplicaMessage {
7151
7152
  * instance identifier.</p>
7152
7153
  * </li>
7153
7154
  * <li>
7154
- * <p>If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN.
7155
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing">Constructing an ARN for Amazon RDS</a>
7156
- * in the <i>Amazon RDS User Guide</i>. This doesn't apply to SQL Server or RDS Custom, which don't support
7157
- * cross-Region replicas.</p>
7155
+ * <p>If the source DB instance is in a different Amazon Web Services Region from the read
7156
+ * replica, specify a valid DB instance ARN. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing">Constructing an ARN for Amazon RDS</a> in the <i>Amazon RDS User
7157
+ * Guide</i>. This doesn't apply to SQL Server or RDS Custom, which
7158
+ * don't support cross-Region replicas.</p>
7158
7159
  * </li>
7159
7160
  * </ul>
7160
7161
  */
7161
- SourceDBInstanceIdentifier: string | undefined;
7162
+ SourceDBInstanceIdentifier?: string;
7162
7163
  /**
7163
7164
  * <p>The compute and memory capacity of the read replica, for example
7164
7165
  * db.m4.large. Not all DB instance classes are available in all Amazon Web Services
@@ -7184,10 +7185,10 @@ export interface CreateDBInstanceReadReplicaMessage {
7184
7185
  Port?: number;
7185
7186
  /**
7186
7187
  * <p>A value that indicates whether the read replica is in a Multi-AZ deployment.</p>
7187
- * <p>You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of
7188
- * your replica in another Availability Zone for failover support for the replica. Creating
7189
- * your read replica as a Multi-AZ DB instance is independent of whether the source
7190
- * database is a Multi-AZ DB instance.</p>
7188
+ * <p>You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your
7189
+ * replica in another Availability Zone for failover support for the replica. Creating your
7190
+ * read replica as a Multi-AZ DB instance is independent of whether the source is a
7191
+ * Multi-AZ DB instance or a Multi-AZ DB cluster.</p>
7191
7192
  * <p>This setting doesn't apply to RDS Custom.</p>
7192
7193
  */
7193
7194
  MultiAZ?: boolean;
@@ -7203,10 +7204,10 @@ export interface CreateDBInstanceReadReplicaMessage {
7203
7204
  */
7204
7205
  Iops?: number;
7205
7206
  /**
7206
- * <p>The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.</p>
7207
+ * <p>The option group the DB instance is associated with. If omitted, the option group
7208
+ * associated with the source instance or cluster is used.</p>
7207
7209
  * <note>
7208
- * <p>For SQL Server, you must use the option group associated with the source
7209
- * instance.</p>
7210
+ * <p>For SQL Server, you must use the option group associated with the source.</p>
7210
7211
  * </note>
7211
7212
  * <p>This setting doesn't apply to RDS Custom.</p>
7212
7213
  */
@@ -7330,13 +7331,15 @@ export interface CreateDBInstanceReadReplicaMessage {
7330
7331
  * <p>The Amazon Web Services KMS key identifier for an encrypted read replica.</p>
7331
7332
  * <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
7332
7333
  * <p>If you create an encrypted read replica in the same Amazon Web Services Region as the source DB
7333
- * instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region
7334
- * is always encrypted with the same KMS key as the source DB instance.</p>
7334
+ * instance or Multi-AZ DB cluster, don't specify a value for this parameter. A read
7335
+ * replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source
7336
+ * DB instance or cluster.</p>
7335
7337
  * <p>If you create an encrypted read replica in a different Amazon Web Services Region, then you must
7336
7338
  * specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to
7337
7339
  * the Amazon Web Services Region that they are created in, and you can't use KMS keys from one
7338
7340
  * Amazon Web Services Region in another Amazon Web Services Region.</p>
7339
- * <p>You can't create an encrypted read replica from an unencrypted DB instance.</p>
7341
+ * <p>You can't create an encrypted read replica from an unencrypted DB instance or
7342
+ * Multi-AZ DB cluster.</p>
7340
7343
  * <p>This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary
7341
7344
  * replica.</p>
7342
7345
  */
@@ -7348,6 +7351,8 @@ export interface CreateDBInstanceReadReplicaMessage {
7348
7351
  * source Amazon Web Services Region that contains the source DB instance.</p>
7349
7352
  * <p>This setting applies only to Amazon Web Services GovCloud (US) Regions and
7350
7353
  * China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.</p>
7354
+ * <p>This setting applies only when replicating from a source DB
7355
+ * <i>instance</i>. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.</p>
7351
7356
  * <p>You must specify this parameter when you create an encrypted read replica from
7352
7357
  * another Amazon Web Services Region by using the Amazon RDS API. Don't specify
7353
7358
  * <code>PreSignedUrl</code> when you are creating an encrypted read replica in the
@@ -7381,11 +7386,11 @@ export interface CreateDBInstanceReadReplicaMessage {
7381
7386
  * </li>
7382
7387
  * <li>
7383
7388
  * <p>
7384
- * <code>SourceDBInstanceIdentifier</code> - The DB instance identifier for
7385
- * the encrypted DB instance to be replicated. This identifier must be in the
7386
- * Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you
7387
- * are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services
7388
- * Region, then your <code>SourceDBInstanceIdentifier</code> looks like the
7389
+ * <code>SourceDBInstanceIdentifier</code> - The DB instance identifier for the
7390
+ * encrypted DB instance to be replicated. This identifier must be in the Amazon
7391
+ * Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are
7392
+ * creating an encrypted read replica from a DB instance in the us-west-2
7393
+ * Amazon Web Services Region, then your <code>SourceDBInstanceIdentifier</code> looks like the
7389
7394
  * following example:
7390
7395
  * <code>arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115</code>.</p>
7391
7396
  * </li>
@@ -7500,7 +7505,8 @@ export interface CreateDBInstanceReadReplicaMessage {
7500
7505
  */
7501
7506
  Domain?: string;
7502
7507
  /**
7503
- * <p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>
7508
+ * <p>The name of the IAM role to be used when making API calls to the Directory
7509
+ * Service.</p>
7504
7510
  * <p>This setting doesn't apply to RDS Custom.</p>
7505
7511
  */
7506
7512
  DomainIAMRoleName?: string;
@@ -7599,6 +7605,29 @@ export interface CreateDBInstanceReadReplicaMessage {
7599
7605
  * </note>
7600
7606
  */
7601
7607
  AllocatedStorage?: number;
7608
+ /**
7609
+ * <p>The identifier of the Multi-AZ DB cluster that will act as the source for the read
7610
+ * replica. Each DB cluster can have up to 15 read replicas.</p>
7611
+ * <p>Constraints:</p>
7612
+ * <ul>
7613
+ * <li>
7614
+ * <p>Must be the identifier of an existing Multi-AZ DB cluster.</p>
7615
+ * </li>
7616
+ * <li>
7617
+ * <p>Can't be specified if the <code>SourceDBInstanceIdentifier</code> parameter is
7618
+ * also specified.</p>
7619
+ * </li>
7620
+ * <li>
7621
+ * <p>The specified DB cluster must have automatic backups enabled, that is, its
7622
+ * backup retention period must be greater than 0.</p>
7623
+ * </li>
7624
+ * <li>
7625
+ * <p>The source DB cluster must be in the same Amazon Web Services Region as the read replica.
7626
+ * Cross-Region replication isn't supported.</p>
7627
+ * </li>
7628
+ * </ul>
7629
+ */
7630
+ SourceDBClusterIdentifier?: string;
7602
7631
  }
7603
7632
  /**
7604
7633
  * @public
@@ -3361,13 +3361,21 @@ export interface ModifyDBClusterMessage {
3361
3361
  */
3362
3362
  CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
3363
3363
  /**
3364
- * <p>The version number of the database engine to which you want to upgrade.
3365
- * Changing this parameter results in an outage. The change is applied during
3366
- * the next maintenance window unless <code>ApplyImmediately</code> is enabled.</p>
3364
+ * <p>The version number of the database engine to which you want to upgrade. Changing this
3365
+ * parameter results in an outage. The change is applied during the next maintenance window
3366
+ * unless <code>ApplyImmediately</code> is enabled. </p>
3367
+ * <p>If the cluster that you're modifying has one or more read replicas, all replicas must
3368
+ * be running an engine version that's the same or later than the version you
3369
+ * specify.</p>
3367
3370
  * <p>To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible),
3368
3371
  * use the following command:</p>
3369
3372
  * <p>
3370
- * <code>aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"</code>
3373
+ * <code>aws rds describe-db-engine-versions --engine aurora-mysql --query
3374
+ * "DBEngineVersions[].EngineVersion"</code>
3375
+ * </p>
3376
+ * <p>To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:</p>
3377
+ * <p>
3378
+ * <code>aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"</code>
3371
3379
  * </p>
3372
3380
  * <p>To list all of the available engine versions for Aurora PostgreSQL, use the following command:</p>
3373
3381
  * <p>
@@ -4091,6 +4099,9 @@ export interface ModifyDBInstanceMessage {
4091
4099
  * default minor version if the current minor version is lower.
4092
4100
  * For information about valid engine versions, see <code>CreateDBInstance</code>,
4093
4101
  * or call <code>DescribeDBEngineVersions</code>.</p>
4102
+ * <p>If the instance that you're modifying is acting as a read replica, the engine version
4103
+ * that you specify must be the same or later than the version that the source DB instance
4104
+ * or cluster is running.</p>
4094
4105
  * <p>In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
4095
4106
  * <code>PATCH_DB_FAILURE</code> lifecycle.</p>
4096
4107
  */
@@ -8688,8 +8699,9 @@ export interface StopDBInstanceResult {
8688
8699
  */
8689
8700
  export interface StopDBInstanceAutomatedBackupsReplicationMessage {
8690
8701
  /**
8691
- * <p>The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automated backups, for example,
8692
- * <code>arn:aws:rds:us-west-2:123456789012:db:mydatabase</code>.</p>
8702
+ * <p>The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating
8703
+ * automate backups, for example,
8704
+ * <code>arn:aws:rds:us-west-2:123456789012:db:mydatabase</code>.</p>
8693
8705
  */
8694
8706
  SourceDBInstanceArn: string | undefined;
8695
8707
  }
@@ -1373,6 +1373,7 @@ export interface DBInstance {
1373
1373
  DBSystemId?: string;
1374
1374
  MasterUserSecret?: MasterUserSecret;
1375
1375
  CertificateDetails?: CertificateDetails;
1376
+ ReadReplicaSourceDBClusterIdentifier?: string;
1376
1377
  }
1377
1378
  export interface CreateDBInstanceResult {
1378
1379
  DBInstance?: DBInstance;
@@ -1420,7 +1421,7 @@ export declare class StorageTypeNotSupportedFault extends __BaseException {
1420
1421
  }
1421
1422
  export interface CreateDBInstanceReadReplicaMessage {
1422
1423
  DBInstanceIdentifier: string | undefined;
1423
- SourceDBInstanceIdentifier: string | undefined;
1424
+ SourceDBInstanceIdentifier?: string;
1424
1425
  DBInstanceClass?: string;
1425
1426
  AvailabilityZone?: string;
1426
1427
  Port?: number;
@@ -1456,6 +1457,7 @@ export interface CreateDBInstanceReadReplicaMessage {
1456
1457
  StorageThroughput?: number;
1457
1458
  EnableCustomerOwnedIp?: boolean;
1458
1459
  AllocatedStorage?: number;
1460
+ SourceDBClusterIdentifier?: string;
1459
1461
  }
1460
1462
  export interface CreateDBInstanceReadReplicaResult {
1461
1463
  DBInstance?: DBInstance;
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.301.0",
4
+ "version": "3.302.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",