Skip to content

Commit 23a4236

Browse files
author
awstools
committed
docs(client-rds): Updated the text in the Important section of the ModifyDBClusterParameterGroup page.
1 parent dd8408b commit 23a4236

File tree

4 files changed

+56
-25
lines changed

4 files changed

+56
-25
lines changed

clients/client-rds/src/commands/ModifyDBClusterParameterGroupCommand.ts

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,11 @@ export interface ModifyDBClusterParameterGroupCommandOutput
3838
* and <code>ApplyMethod</code>. A maximum of 20
3939
* parameters can be modified in a single request.</p>
4040
* <important>
41-
* <p>After you create a DB cluster parameter group, you should wait at least 5 minutes
42-
* before creating your first DB cluster that uses that DB cluster parameter group as the default parameter
43-
* group. This allows Amazon RDS to fully complete the create operation before the parameter
44-
* group is used as the default for a new DB cluster. This is especially important for parameters
45-
* that are critical when creating the default database for a DB cluster, such as the character set
46-
* for the default database defined by the <code>character_set_database</code> parameter. You can use the
41+
* <p>There are two types of parameters - dynamic parameters and static parameters. Changes to dynamic parameters are applied to the DB cluster immediately without a reboot.
42+
* Changes to static parameters are applied only after the DB cluster is rebooted, which can be done using <code>RebootDBCluster</code> operation. You can use the
4743
* <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the
4844
* <code>DescribeDBClusterParameters</code> operation to verify
4945
* that your DB cluster parameter group has been created or modified.</p>
50-
* <p>If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora
51-
* applies the update immediately. The cluster restart might interrupt your workload. In that case,
52-
* your application must reopen any connections and retry any transactions that were active
53-
* when the parameter changes took effect.</p>
5446
* </important>
5547
* <p>For more information on Amazon Aurora DB clusters, see
5648
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">

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

Lines changed: 47 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5292,13 +5292,31 @@ export interface CreateDBClusterMessage {
52925292

52935293
/**
52945294
* <p>Specifies whether the DB cluster is publicly accessible.</p>
5295-
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
5296-
* <p>When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its domain name system (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is controlled by its security group settings.</p>
5295+
* <p>When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC),
5296+
* its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster,
5297+
* the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public
5298+
* access isn't permitted if the security group assigned to the DB cluster doesn't permit it.</p>
52975299
* <p>When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.</p>
5298-
* <p>The default behavior when <code>PubliclyAccessible</code> is not specified depends on whether a <code>DBSubnetGroup</code> is specified.</p>
5299-
* <p>If <code>DBSubnetGroup</code> isn't specified, <code>PubliclyAccessible</code> defaults to <code>true</code>.</p>
5300-
* <p>If <code>DBSubnetGroup</code> is specified, <code>PubliclyAccessible</code> defaults to <code>false</code> unless the value of <code>DBSubnetGroup</code> is <code>default</code>, in which case <code>PubliclyAccessible</code> defaults to <code>true</code>.</p>
5301-
* <p>If <code>PubliclyAccessible</code> is true and the VPC that the <code>DBSubnetGroup</code> is in doesn't have an internet gateway attached to it, Amazon RDS returns an error.</p>
5300+
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
5301+
* <p>Default: The default behavior varies depending on whether <code>DBSubnetGroupName</code> is specified.</p>
5302+
* <p>If <code>DBSubnetGroupName</code> isn't specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
5303+
* <ul>
5304+
* <li>
5305+
* <p>If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.</p>
5306+
* </li>
5307+
* <li>
5308+
* <p>If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.</p>
5309+
* </li>
5310+
* </ul>
5311+
* <p>If <code>DBSubnetGroupName</code> is specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
5312+
* <ul>
5313+
* <li>
5314+
* <p>If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.</p>
5315+
* </li>
5316+
* <li>
5317+
* <p>If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.</p>
5318+
* </li>
5319+
* </ul>
53025320
* @public
53035321
*/
53045322
PubliclyAccessible?: boolean | undefined;
@@ -8371,12 +8389,30 @@ export interface CreateDBInstanceMessage {
83718389

83728390
/**
83738391
* <p>Specifies whether the DB instance is publicly accessible.</p>
8374-
* <p>When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its domain name system (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is controlled by its security group settings.</p>
8392+
* <p>When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC),
8393+
* its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance,
8394+
* the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses.
8395+
* That public access is not permitted if the security group assigned to the DB instance doesn't permit it.</p>
83758396
* <p>When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.</p>
8376-
* <p>The default behavior when <code>PubliclyAccessible</code> is not specified depends on whether a <code>DBSubnetGroup</code> is specified.</p>
8377-
* <p>If <code>DBSubnetGroup</code> isn't specified, <code>PubliclyAccessible</code> defaults to <code>false</code> for Aurora instances and <code>true</code> for non-Aurora instances.</p>
8378-
* <p>If <code>DBSubnetGroup</code> is specified, <code>PubliclyAccessible</code> defaults to <code>false</code> unless the value of <code>DBSubnetGroup</code> is <code>default</code>, in which case <code>PubliclyAccessible</code> defaults to <code>true</code>.</p>
8379-
* <p>If <code>PubliclyAccessible</code> is true and the VPC that the <code>DBSubnetGroup</code> is in doesn't have an internet gateway attached to it, Amazon RDS returns an error.</p>
8397+
* <p>Default: The default behavior varies depending on whether <code>DBSubnetGroupName</code> is specified.</p>
8398+
* <p>If <code>DBSubnetGroupName</code> isn't specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
8399+
* <ul>
8400+
* <li>
8401+
* <p>If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.</p>
8402+
* </li>
8403+
* <li>
8404+
* <p>If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.</p>
8405+
* </li>
8406+
* </ul>
8407+
* <p>If <code>DBSubnetGroupName</code> is specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
8408+
* <ul>
8409+
* <li>
8410+
* <p>If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.</p>
8411+
* </li>
8412+
* <li>
8413+
* <p>If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.</p>
8414+
* </li>
8415+
* </ul>
83808416
* @public
83818417
*/
83828418
PubliclyAccessible?: boolean | undefined;

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9297,6 +9297,9 @@ export interface ModifyDBInstanceMessage {
92979297
* <li>
92989298
* <p>Must be in the distinguished name format.</p>
92999299
* </li>
9300+
* <li>
9301+
* <p>Can't be longer than 64 characters.</p>
9302+
* </li>
93009303
* </ul>
93019304
* <p>Example: <code>OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain</code>
93029305
* </p>

0 commit comments

Comments
 (0)