Skip to content

Commit bb7a56d

Browse files
author
awstools
committed
docs(client-rds): Updates Amazon RDS documentation for Amazon RDS for Db2 cross-Region replicas in standby mode.
1 parent 0f90991 commit bb7a56d

File tree

3 files changed

+109
-31
lines changed

3 files changed

+109
-31
lines changed

‎clients/client-rds/src/commands/CreateDBInstanceReadReplicaCommand.ts

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,16 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
3131
/**
3232
* <p>Creates a new DB instance that acts as a read replica for an existing source DB
3333
* instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running
34-
* Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a
34+
* MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a
3535
* 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
36-
* 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>
36+
* 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>
37+
* in the <i>Amazon RDS User Guide</i>.</p>
38+
* <p>Amazon RDS for Db2 supports this operation for standby replicas. To create a standby
39+
* replica for a DB instance running Db2, you must set <code>ReplicaMode</code> to
40+
* <code>mounted</code>.</p>
3741
* <p>Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the <code>CreateDBInstance</code>
3842
* operation.</p>
39-
* <p>All read replica DB instances are created with backups disabled. All other attributes
43+
* <p>RDS creates read replicas with backups disabled. All other attributes
4044
* (including DB security groups and DB parameter groups) are inherited from the source DB
4145
* instance or cluster, except as specified.</p>
4246
* <important>

‎clients/client-rds/src/models/models_0.ts

Lines changed: 60 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9468,11 +9468,13 @@ export interface DBInstance {
94689468
ReadReplicaDBClusterIdentifiers?: string[] | undefined;
94699469

94709470
/**
9471-
* <p>The open mode of an Oracle read replica. The default is <code>open-read-only</code>.
9472-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with Oracle Read Replicas for Amazon RDS</a>
9473-
* in the <i>Amazon RDS User Guide</i>.</p>
9471+
* <p>The open mode of a Db2 or an Oracle read replica. The default is
9472+
* <code>open-read-only</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html">Working with read replicas for
9473+
* Amazon RDS for Db2</a> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with read replicas
9474+
* for Amazon RDS for Oracle</a> in the <i>Amazon RDS User Guide</i>. </p>
94749475
* <note>
9475-
* <p>This attribute is only supported in RDS for Oracle.</p>
9476+
* <p>This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom
9477+
* for Oracle.</p>
94769478
* </note>
94779479
* @public
94789480
*/
@@ -10083,8 +10085,19 @@ export interface CreateDBInstanceReadReplicaMessage {
1008310085

1008410086
/**
1008510087
* <p>The identifier of the DB instance that will act as the source for the read replica.
10086-
* Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL
10087-
* Server, which can have up to five.</p>
10088+
* Each DB instance can have up to 15 read replicas, except for the following
10089+
* engines:</p>
10090+
* <ul>
10091+
* <li>
10092+
* <p>Db2 - Can have up to three replicas.</p>
10093+
* </li>
10094+
* <li>
10095+
* <p>Oracle - Can have up to five read replicas.</p>
10096+
* </li>
10097+
* <li>
10098+
* <p>SQL Server - Can have up to five read replicas.</p>
10099+
* </li>
10100+
* </ul>
1008810101
* <p>Constraints:</p>
1008910102
* <ul>
1009010103
* <li>
@@ -10190,6 +10203,14 @@ export interface CreateDBInstanceReadReplicaMessage {
1019010203
/**
1019110204
* <p>The name of the DB parameter group to associate with this read replica DB
1019210205
* instance.</p>
10206+
* <p>For the Db2 DB engine, if your source DB instance uses the Bring Your Own License
10207+
* model, then a custom parameter group must be associated with the replica. For a same
10208+
* Amazon Web Services Region replica, if you don't specify a custom parameter group, Amazon RDS
10209+
* associates the custom parameter group associated with the source DB instance. For a
10210+
* cross-Region replica, you must specify a custom parameter group. This custom parameter
10211+
* group must include your IBM Site ID and IBM Customer ID. For more information, see
10212+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html#db2-prereqs-ibm-info"> IBM IDs
10213+
* for Bring Your Own License for Db2</a>. </p>
1019310214
* <p>For Single-AZ or Multi-AZ DB instance read replica instances, if you don't specify a
1019410215
* value for <code>DBParameterGroupName</code>, then Amazon RDS uses the
1019510216
* <code>DBParameterGroup</code> of the source DB instance for a same Region read
@@ -10200,8 +10221,8 @@ export interface CreateDBInstanceReadReplicaMessage {
1020010221
* <code>DBParameterGroup</code>.</p>
1020110222
* <p>Specifying a parameter group for this operation is only supported for MySQL DB
1020210223
* instances for cross-Region read replicas, for Multi-AZ DB cluster read replica
10203-
* instances, and for Oracle DB instances. It isn't supported for MySQL DB instances for
10204-
* same Region read replicas or for RDS Custom.</p>
10224+
* instances, for Db2 DB instances, and for Oracle DB instances. It isn't supported for
10225+
* MySQL DB instances for same Region read replicas or for RDS Custom.</p>
1020510226
* <p>Constraints:</p>
1020610227
* <ul>
1020710228
* <li>
@@ -10586,19 +10607,39 @@ export interface CreateDBInstanceReadReplicaMessage {
1058610607
DomainDnsIps?: string[] | undefined;
1058710608

1058810609
/**
10589-
* <p>The open mode of the replica database: mounted or read-only.</p>
10610+
* <p>The open mode of the replica database.</p>
1059010611
* <note>
10591-
* <p>This parameter is only supported for Oracle DB instances.</p>
10612+
* <p>This parameter is only supported for Db2 DB instances and Oracle DB
10613+
* instances.</p>
1059210614
* </note>
10593-
* <p>Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for
10594-
* mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active
10595-
* Data Guard to transmit information to the mounted replica. Because it doesn't accept
10596-
* user connections, a mounted replica can't serve a read-only workload.</p>
10597-
* <p>You can create a combination of mounted and read-only DB replicas for the same primary DB instance.
10598-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with Oracle Read Replicas for Amazon RDS</a>
10599-
* in the <i>Amazon RDS User Guide</i>.</p>
10600-
* <p>For RDS Custom, you must specify this parameter and set it to <code>mounted</code>. The value won't be set by default.
10601-
* After replica creation, you can manage the open mode manually.</p>
10615+
* <dl>
10616+
* <dt>Db2</dt>
10617+
* <dd>
10618+
* <p>Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2
10619+
* Standard Edition (SE). The main use case for standby replicas is
10620+
* cross-Region disaster recovery. Because it doesn't accept user
10621+
* connections, a standby replica can't serve a read-only workload.</p>
10622+
* <p>You can create a combination of standby and read-only DB replicas for the
10623+
* same primary DB instance. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html">Working with read
10624+
* replicas for Amazon RDS for Db2</a> in the <i>Amazon RDS User
10625+
* Guide</i>.</p>
10626+
* <p>To create standby DB replicas for RDS for Db2, set this parameter to
10627+
* <code>mounted</code>.</p>
10628+
* </dd>
10629+
* <dt>Oracle</dt>
10630+
* <dd>
10631+
* <p>Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for
10632+
* mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active
10633+
* Data Guard to transmit information to the mounted replica. Because it doesn't accept
10634+
* user connections, a mounted replica can't serve a read-only workload.</p>
10635+
* <p>You can create a combination of mounted and read-only DB replicas for the same primary DB instance.
10636+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with read replicas for Amazon RDS for Oracle</a>
10637+
* in the <i>Amazon RDS User Guide</i>.</p>
10638+
* <p>For RDS Custom, you must specify this parameter and set it to
10639+
* <code>mounted</code>. The value won't be set by default. After replica
10640+
* creation, you can manage the open mode manually.</p>
10641+
* </dd>
10642+
* </dl>
1060210643
* @public
1060310644
*/
1060410645
ReplicaMode?: ReplicaMode | undefined;

‎clients/client-rds/src/models/models_1.ts

Lines changed: 42 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2546,6 +2546,11 @@ export interface ConnectionPoolConfigurationInfo {
25462546
* This is an optional field.</p>
25472547
* <p>For example: <code>SET variable1=value1, variable2=value2</code>
25482548
* </p>
2549+
* <important>
2550+
* <p>Since you can access initialization query as part of target group configuration, it is not protected by authentication or cryptographic methods.
2551+
* Anyone with access to view or manage your proxy target group configuration can view the initialization query.
2552+
* You should not add sensitive data, such as passwords or long-lived encryption keys, to this option.</p>
2553+
* </important>
25492554
* @public
25502555
*/
25512556
InitQuery?: string | undefined;
@@ -9526,17 +9531,40 @@ export interface ModifyDBInstanceMessage {
95269531
CertificateRotationRestart?: boolean | undefined;
95279532

95289533
/**
9529-
* <p>A value that sets the open mode of a replica database to either mounted or read-only.</p>
9534+
* <p>The open mode of a replica database.</p>
95309535
* <note>
9531-
* <p>Currently, this parameter is only supported for Oracle DB instances.</p>
9536+
* <p>This parameter is only supported for Db2 DB instances and Oracle DB
9537+
* instances.</p>
95329538
* </note>
9533-
* <p>Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for
9534-
* mounted replicas is cross-Region disaster recovery. The primary database doesn't use
9535-
* Active Data Guard to transmit information to the mounted replica. Because it doesn't
9536-
* accept user connections, a mounted replica can't serve a read-only workload.
9537-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with Oracle Read Replicas for Amazon RDS</a>
9538-
* in the <i>Amazon RDS User Guide</i>.</p>
9539-
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
9539+
* <dl>
9540+
* <dt>Db2</dt>
9541+
* <dd>
9542+
* <p>Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2
9543+
* Standard Edition (SE). The main use case for standby replicas is
9544+
* cross-Region disaster recovery. Because it doesn't accept user
9545+
* connections, a standby replica can't serve a read-only workload.</p>
9546+
* <p>You can create a combination of standby and read-only DB replicas for the
9547+
* same primary DB instance. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html">Working with read
9548+
* replicas for Amazon RDS for Db2</a> in the <i>Amazon RDS User
9549+
* Guide</i>.</p>
9550+
* <p>To create standby DB replicas for RDS for Db2, set this parameter to
9551+
* <code>mounted</code>.</p>
9552+
* </dd>
9553+
* <dt>Oracle</dt>
9554+
* <dd>
9555+
* <p>Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for
9556+
* mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active
9557+
* Data Guard to transmit information to the mounted replica. Because it doesn't accept
9558+
* user connections, a mounted replica can't serve a read-only workload.</p>
9559+
* <p>You can create a combination of mounted and read-only DB replicas for the
9560+
* same primary DB instance. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with
9561+
* read replicas for Amazon RDS for Oracle</a> in the <i>Amazon
9562+
* RDS User Guide</i>.</p>
9563+
* <p>For RDS Custom, you must specify this parameter and set it to
9564+
* <code>mounted</code>. The value won't be set by default. After replica
9565+
* creation, you can manage the open mode manually.</p>
9566+
* </dd>
9567+
* </dl>
95409568
* @public
95419569
*/
95429570
ReplicaMode?: ReplicaMode | undefined;
@@ -9997,6 +10025,11 @@ export interface ConnectionPoolConfiguration {
999710025
* <p>For example: <code>SET variable1=value1, variable2=value2</code>
999810026
* </p>
999910027
* <p>Default: no initialization query</p>
10028+
* <important>
10029+
* <p>Since you can access initialization query as part of target group configuration, it is not protected by authentication or cryptographic methods.
10030+
* Anyone with access to view or manage your proxy target group configuration can view the initialization query.
10031+
* You should not add sensitive data, such as passwords or long-lived encryption keys, to this option.</p>
10032+
* </important>
1000010033
* @public
1000110034
*/
1000210035
InitQuery?: string | undefined;

0 commit comments

Comments
 (0)