Skip to content

Commit

Permalink
docs(client-rds): Updates Amazon RDS documentation to specify an even…
Browse files Browse the repository at this point in the history
…tual consistency model for DescribePendingMaintenanceActions.
  • Loading branch information
awstools committed Jul 18, 2024
1 parent 71e6e59 commit 3918268
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 39 deletions.
2 changes: 1 addition & 1 deletion clients/client-rds/src/auth/httpAuthSchemeProvider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ function createAwsAuthSigv4HttpAuthOption(authParameters: RDSHttpAuthSchemeParam
name: "rds",
region: authParameters.region,
},
propertiesExtractor: (config: RDSClientConfig, context) => ({
propertiesExtractor: (config: Partial<RDSClientConfig>, context) => ({
/**
* @internal
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ export interface DescribePendingMaintenanceActionsCommandOutput

/**
* <p>Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.</p>
* <p>This API follows an eventual consistency model. This means that the result of the
* <code>DescribePendingMaintenanceActions</code> command might not be immediately
* visible to all subsequent RDS commands. Keep this in mind when you use
* <code>DescribePendingMaintenanceActions</code> immediately after using a previous
* API command such as <code>ApplyPendingMaintenanceActions</code>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
44 changes: 21 additions & 23 deletions clients/client-rds/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5005,12 +5005,10 @@ export interface CreateDBClusterMessage {

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

/**
* <p>Indicates whether the DB cluster is publicly accessible.</p>
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
* resolves to the private IP address from within the DB cluster's virtual private cloud
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
* to the DB cluster is ultimately controlled by the security group it uses. That public
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
* it.</p>
* <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 ultimately controlled by the security group it uses. That public
* access isn't permitted if the security group assigned to the DB cluster doesn't permit it.</p>
* <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>
* <p>For more information, see <a>CreateDBCluster</a>.</p>
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
Expand Down Expand Up @@ -7917,10 +7913,10 @@ export interface CreateDBInstanceMessage {

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

/**
* <p>Indicates whether the DB instance is publicly accessible.</p>
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
* resolves to the private IP address from within the DB cluster's virtual private cloud
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
* to the DB cluster is ultimately controlled by the security group it uses. That public
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
* it.</p>
* <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 cluster is ultimately controlled by the security group it uses. That public
* access isn't permitted if the security group assigned to the DB cluster doesn't permit it.</p>
* <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>
* <p>For more information, see <a>CreateDBInstance</a>.</p>
* @public
Expand Down Expand Up @@ -13192,7 +13186,11 @@ export interface DeleteDBClusterMessage {
/**
* <p>Specifies whether to remove automated backups immediately after the DB
* cluster is deleted. This parameter isn't case-sensitive. The default is to remove
* automated backups immediately after the DB cluster is deleted.</p>
* automated backups immediately after the DB cluster is deleted.
* </p>
* <note>
* <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>
* </note>
* @public
*/
DeleteAutomatedBackups?: boolean;
Expand Down
12 changes: 5 additions & 7 deletions clients/client-rds/src/models/models_1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -913,7 +913,7 @@ export interface DescribeDBClusterParametersMessage {
* <ul>
* <li>
* <p>
* <code>customer</code>
* <code>user</code>
* </p>
* </li>
* <li>
Expand Down Expand Up @@ -8916,12 +8916,10 @@ export interface ModifyDBInstanceMessage {

/**
* <p>Specifies whether the DB instance is publicly accessible.</p>
* <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
* resolves to the private IP address from within the DB cluster's virtual private cloud
* (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access
* to the DB cluster is ultimately controlled by the security group it uses. That public
* access isn't permitted if the security group assigned to the DB cluster doesn't permit
* it.</p>
* <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 ultimately controlled by the security group it uses. That public
* access isn't permitted if the security group assigned to the DB instance doesn't permit it.</p>
* <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>
* <p>
* <code>PubliclyAccessible</code> only applies to DB instances in a VPC. The DB instance must be part of a
Expand Down
Loading

0 comments on commit 3918268

Please sign in to comment.