Skip to content

Commit d966d5f

Browse files
Updates Amazon RDS documentation for Amazon RDS for Db2 cross-Region replicas in standby mode.
1 parent 0462f7a commit d966d5f

File tree

11 files changed

+201
-83
lines changed

11 files changed

+201
-83
lines changed

generator/ServiceModels/rds/rds-2014-10-31.docs.json

Lines changed: 8 additions & 8 deletions
Large diffs are not rendered by default.

generator/ServiceModels/rds/rds-2014-10-31.normal.json

Lines changed: 8 additions & 8 deletions
Large diffs are not rendered by default.

sdk/src/Services/RDS/Generated/Model/ConnectionPoolConfiguration.cs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,15 @@ internal bool IsSetConnectionBorrowTimeout()
9292
/// <para>
9393
/// Default: no initialization query
9494
/// </para>
95+
/// <important>
96+
/// <para>
97+
/// Since you can access initialization query as part of target group configuration, it
98+
/// is not protected by authentication or cryptographic methods. Anyone with access to
99+
/// view or manage your proxy target group configuration can view the initialization query.
100+
/// You should not add sensitive data, such as passwords or long-lived encryption keys,
101+
/// to this option.
102+
/// </para>
103+
/// </important>
95104
/// </summary>
96105
public string InitQuery
97106
{

sdk/src/Services/RDS/Generated/Model/ConnectionPoolConfigurationInfo.cs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,15 @@ internal bool IsSetConnectionBorrowTimeout()
7373
/// <para>
7474
/// For example: <c>SET variable1=value1, variable2=value2</c>
7575
/// </para>
76+
/// <important>
77+
/// <para>
78+
/// Since you can access initialization query as part of target group configuration, it
79+
/// is not protected by authentication or cryptographic methods. Anyone with access to
80+
/// view or manage your proxy target group configuration can view the initialization query.
81+
/// You should not add sensitive data, such as passwords or long-lived encryption keys,
82+
/// to this option.
83+
/// </para>
84+
/// </important>
7685
/// </summary>
7786
public string InitQuery
7887
{

sdk/src/Services/RDS/Generated/Model/CreateDBInstanceReadReplicaRequest.cs

Lines changed: 61 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -32,23 +32,28 @@ namespace Amazon.RDS.Model
3232
/// <summary>
3333
/// Container for the parameters to the CreateDBInstanceReadReplica operation.
3434
/// Creates a new DB instance that acts as a read replica for an existing source DB instance
35-
/// or Multi-AZ DB cluster. You can create a read replica for a DB instance running Db2,
36-
/// MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for
37-
/// a 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
35+
/// or Multi-AZ DB cluster. You can create a read replica for a DB instance running MariaDB,
36+
/// MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ
37+
/// DB cluster running MySQL or PostgreSQL. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html">Working
3838
/// 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
3939
/// from a Multi-AZ DB cluster to a DB instance using a read replica</a> in the <i>Amazon
4040
/// RDS User Guide</i>.
4141
///
4242
///
4343
/// <para>
44+
/// Amazon RDS for Db2 supports this operation for standby replicas. To create a standby
45+
/// replica for a DB instance running Db2, you must set <c>ReplicaMode</c> to <c>mounted</c>.
46+
/// </para>
47+
///
48+
/// <para>
4449
/// Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora
4550
/// DB cluster, use the <c>CreateDBInstance</c> operation.
4651
/// </para>
4752
///
4853
/// <para>
49-
/// All read replica DB instances are created with backups disabled. All other attributes
50-
/// (including DB security groups and DB parameter groups) are inherited from the source
51-
/// DB instance or cluster, except as specified.
54+
/// RDS creates read replicas with backups disabled. All other attributes (including DB
55+
/// security groups and DB parameter groups) are inherited from the source DB instance
56+
/// or cluster, except as specified.
5257
/// </para>
5358
/// <important>
5459
/// <para>
@@ -114,7 +119,7 @@ public CreateDBInstanceReadReplicaRequest() { }
114119
/// Instantiates CreateDBInstanceReadReplicaRequest with the parameterized properties
115120
/// </summary>
116121
/// <param name="dbInstanceIdentifier">The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.</param>
117-
/// <param name="sourceDBInstanceIdentifier">The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL Server, which can have up to five. Constraints: <ul> <li> Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB instance. </li> <li> Can't be specified if the <c>SourceDBClusterIdentifier</c> parameter is also specified. </li> <li> 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 <i>Amazon RDS User Guide</i>. </li> <li> 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>. </li> <li> The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0. </li> <li> If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier. </li> <li> If the source DB instance is in a different Amazon Web Services Region from the read 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 Guide</i>. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas. </li> </ul></param>
122+
/// <param name="sourceDBInstanceIdentifier">The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, except for the following engines: <ul> <li> Db2 - Can have up to three replicas. </li> <li> Oracle - Can have up to five read replicas. </li> <li> SQL Server - Can have up to five read replicas. </li> </ul> Constraints: <ul> <li> Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB instance. </li> <li> Can't be specified if the <c>SourceDBClusterIdentifier</c> parameter is also specified. </li> <li> 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 <i>Amazon RDS User Guide</i>. </li> <li> 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>. </li> <li> The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0. </li> <li> If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier. </li> <li> If the source DB instance is in a different Amazon Web Services Region from the read 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 Guide</i>. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas. </li> </ul></param>
118123
public CreateDBInstanceReadReplicaRequest(string dbInstanceIdentifier, string sourceDBInstanceIdentifier)
119124
{
120125
_dbInstanceIdentifier = dbInstanceIdentifier;
@@ -375,6 +380,17 @@ internal bool IsSetDBInstanceIdentifier()
375380
/// </para>
376381
///
377382
/// <para>
383+
/// For the Db2 DB engine, if your source DB instance uses the Bring Your Own License
384+
/// model, then a custom parameter group must be associated with the replica. For a same
385+
/// Amazon Web Services Region replica, if you don't specify a custom parameter group,
386+
/// Amazon RDS associates the custom parameter group associated with the source DB instance.
387+
/// For a cross-Region replica, you must specify a custom parameter group. This custom
388+
/// parameter group must include your IBM Site ID and IBM Customer ID. For more information,
389+
/// see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html#db2-prereqs-ibm-info">
390+
/// IBM IDs for Bring Your Own License for Db2</a>.
391+
/// </para>
392+
///
393+
/// <para>
378394
/// For Single-AZ or Multi-AZ DB instance read replica instances, if you don't specify
379395
/// a value for <c>DBParameterGroupName</c>, then Amazon RDS uses the <c>DBParameterGroup</c>
380396
/// of the source DB instance for a same Region read replica, or the default <c>DBParameterGroup</c>
@@ -388,9 +404,9 @@ internal bool IsSetDBInstanceIdentifier()
388404
///
389405
/// <para>
390406
/// Specifying a parameter group for this operation is only supported for MySQL DB instances
391-
/// for cross-Region read replicas, for Multi-AZ DB cluster read replica instances, and
392-
/// for Oracle DB instances. It isn't supported for MySQL DB instances for same Region
393-
/// read replicas or for RDS Custom.
407+
/// for cross-Region read replicas, for Multi-AZ DB cluster read replica instances, for
408+
/// Db2 DB instances, and for Oracle DB instances. It isn't supported for MySQL DB instances
409+
/// for same Region read replicas or for RDS Custom.
394410
/// </para>
395411
///
396412
/// <para>
@@ -1323,13 +1339,29 @@ internal bool IsSetPubliclyAccessible()
13231339
/// <summary>
13241340
/// Gets and sets the property ReplicaMode.
13251341
/// <para>
1326-
/// The open mode of the replica database: mounted or read-only.
1342+
/// The open mode of the replica database.
13271343
/// </para>
13281344
/// <note>
13291345
/// <para>
1330-
/// This parameter is only supported for Oracle DB instances.
1346+
/// This parameter is only supported for Db2 DB instances and Oracle DB instances.
13311347
/// </para>
1332-
/// </note>
1348+
/// </note> <dl> <dt>Db2</dt> <dd>
1349+
/// <para>
1350+
/// Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2 Standard Edition
1351+
/// (SE). The main use case for standby replicas is cross-Region disaster recovery. Because
1352+
/// it doesn't accept user connections, a standby replica can't serve a read-only workload.
1353+
/// </para>
1354+
///
1355+
/// <para>
1356+
/// You can create a combination of standby and read-only DB replicas for the same primary
1357+
/// DB instance. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html">Working
1358+
/// with read replicas for Amazon RDS for Db2</a> in the <i>Amazon RDS User Guide</i>.
1359+
/// </para>
1360+
///
1361+
/// <para>
1362+
/// To create standby DB replicas for RDS for Db2, set this parameter to <c>mounted</c>.
1363+
/// </para>
1364+
/// </dd> <dt>Oracle</dt> <dd>
13331365
/// <para>
13341366
/// Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use
13351367
/// case for mounted replicas is cross-Region disaster recovery. The primary database
@@ -1340,14 +1372,15 @@ internal bool IsSetPubliclyAccessible()
13401372
/// <para>
13411373
/// You can create a combination of mounted and read-only DB replicas for the same primary
13421374
/// DB instance. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working
1343-
/// with Oracle Read Replicas for Amazon RDS</a> in the <i>Amazon RDS User Guide</i>.
1375+
/// with read replicas for Amazon RDS for Oracle</a> in the <i>Amazon RDS User Guide</i>.
13441376
/// </para>
13451377
///
13461378
/// <para>
13471379
/// For RDS Custom, you must specify this parameter and set it to <c>mounted</c>. The
13481380
/// value won't be set by default. After replica creation, you can manage the open mode
13491381
/// manually.
13501382
/// </para>
1383+
/// </dd> </dl>
13511384
/// </summary>
13521385
public ReplicaMode ReplicaMode
13531386
{
@@ -1407,10 +1440,21 @@ internal bool IsSetSourceDBClusterIdentifier()
14071440
/// Gets and sets the property SourceDBInstanceIdentifier.
14081441
/// <para>
14091442
/// The identifier of the DB instance that will act as the source for the read replica.
1410-
/// Each DB instance can have up to 15 read replicas, with the exception of Oracle and
1411-
/// SQL Server, which can have up to five.
1443+
/// Each DB instance can have up to 15 read replicas, except for the following engines:
14121444
/// </para>
1413-
///
1445+
/// <ul> <li>
1446+
/// <para>
1447+
/// Db2 - Can have up to three replicas.
1448+
/// </para>
1449+
/// </li> <li>
1450+
/// <para>
1451+
/// Oracle - Can have up to five read replicas.
1452+
/// </para>
1453+
/// </li> <li>
1454+
/// <para>
1455+
/// SQL Server - Can have up to five read replicas.
1456+
/// </para>
1457+
/// </li> </ul>
14141458
/// <para>
14151459
/// Constraints:
14161460
/// </para>

sdk/src/Services/RDS/Generated/Model/DBInstance.cs

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1709,13 +1709,16 @@ internal bool IsSetReadReplicaSourceDBInstanceIdentifier()
17091709
/// <summary>
17101710
/// Gets and sets the property ReplicaMode.
17111711
/// <para>
1712-
/// The open mode of an Oracle read replica. The default is <c>open-read-only</c>. For
1713-
/// more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working
1714-
/// with Oracle Read Replicas for Amazon RDS</a> in the <i>Amazon RDS User Guide</i>.
1712+
/// The open mode of a Db2 or an Oracle read replica. The default is <c>open-read-only</c>.
1713+
/// For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html">Working
1714+
/// with read replicas for Amazon RDS for Db2</a> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working
1715+
/// with read replicas for Amazon RDS for Oracle</a> in the <i>Amazon RDS User Guide</i>.
1716+
///
17151717
/// </para>
17161718
/// <note>
17171719
/// <para>
1718-
/// This attribute is only supported in RDS for Oracle.
1720+
/// This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for
1721+
/// Oracle.
17191722
/// </para>
17201723
/// </note>
17211724
/// </summary>

sdk/src/Services/RDS/Generated/Model/ModifyDBInstanceRequest.cs

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2165,25 +2165,48 @@ internal bool IsSetPubliclyAccessible()
21652165
/// <summary>
21662166
/// Gets and sets the property ReplicaMode.
21672167
/// <para>
2168-
/// A value that sets the open mode of a replica database to either mounted or read-only.
2168+
/// The open mode of a replica database.
21692169
/// </para>
21702170
/// <note>
21712171
/// <para>
2172-
/// Currently, this parameter is only supported for Oracle DB instances.
2172+
/// This parameter is only supported for Db2 DB instances and Oracle DB instances.
21732173
/// </para>
2174-
/// </note>
2174+
/// </note> <dl> <dt>Db2</dt> <dd>
21752175
/// <para>
2176-
/// Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for
2177-
/// mounted replicas is cross-Region disaster recovery. The primary database doesn't use
2178-
/// Active Data Guard to transmit information to the mounted replica. Because it doesn't
2179-
/// accept user connections, a mounted replica can't serve a read-only workload. For more
2180-
/// information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working
2181-
/// with Oracle Read Replicas for Amazon RDS</a> in the <i>Amazon RDS User Guide</i>.
2176+
/// Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2 Standard Edition
2177+
/// (SE). The main use case for standby replicas is cross-Region disaster recovery. Because
2178+
/// it doesn't accept user connections, a standby replica can't serve a read-only workload.
21822179
/// </para>
21832180
///
21842181
/// <para>
2185-
/// This setting doesn't apply to RDS Custom DB instances.
2182+
/// You can create a combination of standby and read-only DB replicas for the same primary
2183+
/// DB instance. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html">Working
2184+
/// with read replicas for Amazon RDS for Db2</a> in the <i>Amazon RDS User Guide</i>.
2185+
/// </para>
2186+
///
2187+
/// <para>
2188+
/// To create standby DB replicas for RDS for Db2, set this parameter to <c>mounted</c>.
2189+
/// </para>
2190+
/// </dd> <dt>Oracle</dt> <dd>
2191+
/// <para>
2192+
/// Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use
2193+
/// case for mounted replicas is cross-Region disaster recovery. The primary database
2194+
/// doesn't use Active Data Guard to transmit information to the mounted replica. Because
2195+
/// it doesn't accept user connections, a mounted replica can't serve a read-only workload.
2196+
/// </para>
2197+
///
2198+
/// <para>
2199+
/// You can create a combination of mounted and read-only DB replicas for the same primary
2200+
/// DB instance. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working
2201+
/// with read replicas for Amazon RDS for Oracle</a> in the <i>Amazon RDS User Guide</i>.
2202+
/// </para>
2203+
///
2204+
/// <para>
2205+
/// For RDS Custom, you must specify this parameter and set it to <c>mounted</c>. The
2206+
/// value won't be set by default. After replica creation, you can manage the open mode
2207+
/// manually.
21862208
/// </para>
2209+
/// </dd> </dl>
21872210
/// </summary>
21882211
public ReplicaMode ReplicaMode
21892212
{

0 commit comments

Comments
 (0)