You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sdk/src/Services/RDS/Generated/Model/CreateDBInstanceReadReplicaRequest.cs
+61-17Lines changed: 61 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -32,23 +32,28 @@ namespace Amazon.RDS.Model
32
32
/// <summary>
33
33
/// Container for the parameters to the CreateDBInstanceReadReplica operation.
34
34
/// 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
38
38
/// 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
39
39
/// from a Multi-AZ DB cluster to a DB instance using a read replica</a> in the <i>Amazon
40
40
/// RDS User Guide</i>.
41
41
///
42
42
///
43
43
/// <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>
44
49
/// Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora
45
50
/// DB cluster, use the <c>CreateDBInstance</c> operation.
46
51
/// </para>
47
52
///
48
53
/// <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.
52
57
/// </para>
53
58
/// <important>
54
59
/// <para>
@@ -114,7 +119,7 @@ public CreateDBInstanceReadReplicaRequest() { }
114
119
/// Instantiates CreateDBInstanceReadReplicaRequest with the parameterized properties
115
120
/// </summary>
116
121
/// <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>
/// 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
+
///
1715
1717
/// </para>
1716
1718
/// <note>
1717
1719
/// <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
0 commit comments