Skip to content

Commit 3918268

Browse files
author
awstools
committed
docs(client-rds): Updates Amazon RDS documentation to specify an eventual consistency model for DescribePendingMaintenanceActions.
1 parent 71e6e59 commit 3918268

File tree

5 files changed

+40
-39
lines changed

5 files changed

+40
-39
lines changed

clients/client-rds/src/auth/httpAuthSchemeProvider.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ function createAwsAuthSigv4HttpAuthOption(authParameters: RDSHttpAuthSchemeParam
6060
name: "rds",
6161
region: authParameters.region,
6262
},
63-
propertiesExtractor: (config: RDSClientConfig, context) => ({
63+
propertiesExtractor: (config: Partial<RDSClientConfig>, context) => ({
6464
/**
6565
* @internal
6666
*/

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ export interface DescribePendingMaintenanceActionsCommandOutput
3434

3535
/**
3636
* <p>Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.</p>
37+
* <p>This API follows an eventual consistency model. This means that the result of the
38+
* <code>DescribePendingMaintenanceActions</code> command might not be immediately
39+
* visible to all subsequent RDS commands. Keep this in mind when you use
40+
* <code>DescribePendingMaintenanceActions</code> immediately after using a previous
41+
* API command such as <code>ApplyPendingMaintenanceActions</code>.</p>
3742
* @example
3843
* Use a bare-bones client and the command you need to make an API call.
3944
* ```javascript

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

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5005,12 +5005,10 @@ export interface CreateDBClusterMessage {
50055005

50065006
/**
50075007
* <p>Specifies whether the DB cluster is publicly accessible.</p>
5008-
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
5009-
* resolves to the private IP address from within the DB cluster's virtual private cloud
5010-
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
5011-
* to the DB cluster is ultimately controlled by the security group it uses. That public
5012-
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
5013-
* it.</p>
5008+
* <p>When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC),
5009+
* its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster,
5010+
* the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public
5011+
* access isn't permitted if the security group assigned to the DB cluster doesn't permit it.</p>
50145012
* <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>
50155013
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
50165014
* <p>Default: The default behavior varies depending on whether <code>DBSubnetGroupName</code> is specified.</p>
@@ -6173,12 +6171,10 @@ export interface DBCluster {
61736171

61746172
/**
61756173
* <p>Indicates whether the DB cluster is publicly accessible.</p>
6176-
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
6177-
* resolves to the private IP address from within the DB cluster's virtual private cloud
6178-
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
6179-
* to the DB cluster is ultimately controlled by the security group it uses. That public
6180-
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
6181-
* it.</p>
6174+
* <p>When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC),
6175+
* its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster,
6176+
* the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public
6177+
* access isn't permitted if the security group assigned to the DB cluster doesn't permit it.</p>
61826178
* <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>
61836179
* <p>For more information, see <a>CreateDBCluster</a>.</p>
61846180
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
@@ -7917,10 +7913,10 @@ export interface CreateDBInstanceMessage {
79177913

79187914
/**
79197915
* <p>Specifies whether the DB instance is publicly accessible.</p>
7920-
* <p>When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from
7921-
* within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC.
7922-
* Access to the DB instance is ultimately controlled by the security group it uses.
7923-
* That public access is not permitted if the security group assigned to the DB instance doesn't permit it.</p>
7916+
* <p>When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC),
7917+
* its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance,
7918+
* the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses.
7919+
* That public access is not permitted if the security group assigned to the DB instance doesn't permit it.</p>
79247920
* <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>
79257921
* <p>Default: The default behavior varies depending on whether <code>DBSubnetGroupName</code> is specified.</p>
79267922
* <p>If <code>DBSubnetGroupName</code> isn't specified, and <code>PubliclyAccessible</code> isn't specified, the following applies:</p>
@@ -9227,12 +9223,10 @@ export interface DBInstance {
92279223

92289224
/**
92299225
* <p>Indicates whether the DB instance is publicly accessible.</p>
9230-
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
9231-
* resolves to the private IP address from within the DB cluster's virtual private cloud
9232-
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
9233-
* to the DB cluster is ultimately controlled by the security group it uses. That public
9234-
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
9235-
* it.</p>
9226+
* <p>When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC),
9227+
* its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance,
9228+
* the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public
9229+
* access isn't permitted if the security group assigned to the DB cluster doesn't permit it.</p>
92369230
* <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>
92379231
* <p>For more information, see <a>CreateDBInstance</a>.</p>
92389232
* @public
@@ -13192,7 +13186,11 @@ export interface DeleteDBClusterMessage {
1319213186
/**
1319313187
* <p>Specifies whether to remove automated backups immediately after the DB
1319413188
* cluster is deleted. This parameter isn't case-sensitive. The default is to remove
13195-
* automated backups immediately after the DB cluster is deleted.</p>
13189+
* automated backups immediately after the DB cluster is deleted.
13190+
* </p>
13191+
* <note>
13192+
* <p>You must delete automated backups for Amazon RDS Multi-AZ DB clusters. For more information about managing automated backups for RDS Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ManagingAutomatedBackups.html">Managing automated backups</a>.</p>
13193+
* </note>
1319613194
* @public
1319713195
*/
1319813196
DeleteAutomatedBackups?: boolean;

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

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -913,7 +913,7 @@ export interface DescribeDBClusterParametersMessage {
913913
* <ul>
914914
* <li>
915915
* <p>
916-
* <code>customer</code>
916+
* <code>user</code>
917917
* </p>
918918
* </li>
919919
* <li>
@@ -8916,12 +8916,10 @@ export interface ModifyDBInstanceMessage {
89168916

89178917
/**
89188918
* <p>Specifies whether the DB instance is publicly accessible.</p>
8919-
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
8920-
* resolves to the private IP address from within the DB cluster's virtual private cloud
8921-
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
8922-
* to the DB cluster is ultimately controlled by the security group it uses. That public
8923-
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
8924-
* it.</p>
8919+
* <p>When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC),
8920+
* its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance,
8921+
* the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public
8922+
* access isn't permitted if the security group assigned to the DB instance doesn't permit it.</p>
89258923
* <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>
89268924
* <p>
89278925
* <code>PubliclyAccessible</code> only applies to DB instances in a VPC. The DB instance must be part of a

0 commit comments

Comments
 (0)