From 3918268688cb3b8b48c5759f9156a7a360af06d8 Mon Sep 17 00:00:00 2001 From: awstools Date: Thu, 18 Jul 2024 19:31:29 +0000 Subject: [PATCH] docs(client-rds): Updates Amazon RDS documentation to specify an eventual consistency model for DescribePendingMaintenanceActions. --- .../src/auth/httpAuthSchemeProvider.ts | 2 +- ...escribePendingMaintenanceActionsCommand.ts | 5 +++ clients/client-rds/src/models/models_0.ts | 44 +++++++++---------- clients/client-rds/src/models/models_1.ts | 12 +++-- codegen/sdk-codegen/aws-models/rds.json | 16 +++---- 5 files changed, 40 insertions(+), 39 deletions(-) diff --git a/clients/client-rds/src/auth/httpAuthSchemeProvider.ts b/clients/client-rds/src/auth/httpAuthSchemeProvider.ts index 81038cd3bc85..0358dbd5e23d 100644 --- a/clients/client-rds/src/auth/httpAuthSchemeProvider.ts +++ b/clients/client-rds/src/auth/httpAuthSchemeProvider.ts @@ -60,7 +60,7 @@ function createAwsAuthSigv4HttpAuthOption(authParameters: RDSHttpAuthSchemeParam name: "rds", region: authParameters.region, }, - propertiesExtractor: (config: RDSClientConfig, context) => ({ + propertiesExtractor: (config: Partial, context) => ({ /** * @internal */ diff --git a/clients/client-rds/src/commands/DescribePendingMaintenanceActionsCommand.ts b/clients/client-rds/src/commands/DescribePendingMaintenanceActionsCommand.ts index 8b5a68147dba..5b0fe43b6b48 100644 --- a/clients/client-rds/src/commands/DescribePendingMaintenanceActionsCommand.ts +++ b/clients/client-rds/src/commands/DescribePendingMaintenanceActionsCommand.ts @@ -34,6 +34,11 @@ export interface DescribePendingMaintenanceActionsCommandOutput /** *

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

+ *

This API follows an eventual consistency model. This means that the result of the + * DescribePendingMaintenanceActions command might not be immediately + * visible to all subsequent RDS commands. Keep this in mind when you use + * DescribePendingMaintenanceActions immediately after using a previous + * API command such as ApplyPendingMaintenanceActions.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/models/models_0.ts b/clients/client-rds/src/models/models_0.ts index 574d14f1e421..6de39cbf4a90 100644 --- a/clients/client-rds/src/models/models_0.ts +++ b/clients/client-rds/src/models/models_0.ts @@ -5005,12 +5005,10 @@ export interface CreateDBClusterMessage { /** *

Specifies whether the DB cluster is publicly accessible.

- *

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.

+ *

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.

*

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.

*

Valid for Cluster Type: Multi-AZ DB clusters only

*

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

@@ -6173,12 +6171,10 @@ export interface DBCluster { /** *

Indicates whether the DB cluster is publicly accessible.

- *

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.

+ *

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.

*

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.

*

For more information, see CreateDBCluster.

*

This setting is only for non-Aurora Multi-AZ DB clusters.

@@ -7917,10 +7913,10 @@ export interface CreateDBInstanceMessage { /** *

Specifies whether the DB instance is publicly accessible.

- *

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.

+ *

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.

*

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.

*

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

*

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

@@ -9227,12 +9223,10 @@ export interface DBInstance { /** *

Indicates whether the DB instance is publicly accessible.

- *

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.

+ *

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.

*

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.

*

For more information, see CreateDBInstance.

* @public @@ -13192,7 +13186,11 @@ export interface DeleteDBClusterMessage { /** *

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.

+ * automated backups immediately after the DB cluster is deleted. + *

+ * + *

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 Managing automated backups.

+ * * @public */ DeleteAutomatedBackups?: boolean; diff --git a/clients/client-rds/src/models/models_1.ts b/clients/client-rds/src/models/models_1.ts index fdf986682633..35b75cdafcf8 100644 --- a/clients/client-rds/src/models/models_1.ts +++ b/clients/client-rds/src/models/models_1.ts @@ -913,7 +913,7 @@ export interface DescribeDBClusterParametersMessage { *