Skip to content

Commit 58b024d

Browse files
authored
docs(rds): improve docs about serverless v1 (#30316)
### Issue # (if applicable) Closes #30309. ### Reason for this change The rds.ServerlessCluster is for Serverless v1, but this is not explicitly stated in the documentation, which could be misleading as it may imply that it is for Serverless v2. ### Description of changes Added to the README and TSdocs that rds.ServerlessCluster is for v1 of Aurora Serverless ### Description of how you validated changes Do nothing because only documentation improvements ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 4857239 commit 58b024d

File tree

2 files changed

+23
-21
lines changed

2 files changed

+23
-21
lines changed

packages/aws-cdk-lib/aws-rds/README.md

+16-14
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ cluster.metricACUUtilization({
182182
There are some things to take into consideration with Aurora Serverless v2.
183183

184184
To create a cluster that can support serverless v2 instances you configure a
185-
minimum and maximum capacity range on the cluster. This is an example showing
185+
minimum and maximum capacity range on the cluster. This is an example showing
186186
the default values:
187187

188188
```ts
@@ -491,7 +491,7 @@ const gp3Instance = new rds.DatabaseInstance(this, 'Gp3Instance', {
491491
});
492492
```
493493

494-
Use the `allocatedStorage` property to specify the amount of storage (in gigabytes) that is initially allocated for the instance
494+
Use the `allocatedStorage` property to specify the amount of storage (in gigabytes) that is initially allocated for the instance
495495
to use for the instance:
496496

497497
```ts
@@ -972,7 +972,7 @@ new rds.DatabaseCluster(this, 'dbcluster', {
972972
## Creating a Database Proxy
973973

974974
Amazon RDS Proxy sits between your application and your relational database to efficiently manage
975-
connections to the database and improve scalability of the application. Learn more about at [Amazon RDS Proxy](https://aws.amazon.com/rds/proxy/).
975+
connections to the database and improve scalability of the application. Learn more about at [Amazon RDS Proxy](https://aws.amazon.com/rds/proxy/).
976976

977977
RDS Proxy is supported for MySQL, MariaDB, Postgres, and SQL Server.
978978

@@ -1016,7 +1016,7 @@ const cluster = new rds.DatabaseCluster(this, 'Database', {
10161016
// ...
10171017
});
10181018

1019-
// When 'cloudwatchLogsExports' is set, each export value creates its own log group in DB cluster.
1019+
// When 'cloudwatchLogsExports' is set, each export value creates its own log group in DB cluster.
10201020
// Specify an export value to access its log group.
10211021
const errorLogGroup = cluster.cloudwatchLogGroups['error'];
10221022
const auditLogGroup = cluster.cloudwatchLogGroups.audit;
@@ -1032,7 +1032,7 @@ const instance = new rds.DatabaseInstance(this, 'Instance', {
10321032
// ...
10331033
});
10341034

1035-
// When 'cloudwatchLogsExports' is set, each export value creates its own log group in DB instance.
1035+
// When 'cloudwatchLogsExports' is set, each export value creates its own log group in DB instance.
10361036
// Specify an export value to access its log group.
10371037
const postgresqlLogGroup = instance.cloudwatchLogGroups['postgresql'];
10381038
```
@@ -1108,14 +1108,14 @@ new rds.DatabaseInstance(this, 'Database', {
11081108

11091109
You cannot specify a parameter map and a parameter group at the same time.
11101110

1111-
## Serverless
1111+
## Serverless v1
11121112

1113-
[Amazon Aurora Serverless](https://aws.amazon.com/rds/aurora/serverless/) is an on-demand, auto-scaling configuration for Amazon
1113+
[Amazon Aurora Serverless v1](https://aws.amazon.com/rds/aurora/serverless/) is an on-demand, auto-scaling configuration for Amazon
11141114
Aurora. The database will automatically start up, shut down, and scale capacity
11151115
up or down based on your application's needs. It enables you to run your database
11161116
in the cloud without managing any database instances.
11171117

1118-
The following example initializes an Aurora Serverless PostgreSql cluster.
1118+
The following example initializes an Aurora Serverless v1 PostgreSql cluster.
11191119
Aurora Serverless clusters can specify scaling properties which will be used to
11201120
automatically scale the database cluster seamlessly based on the workload.
11211121

@@ -1137,7 +1137,9 @@ const cluster = new rds.ServerlessCluster(this, 'AnotherCluster', {
11371137
});
11381138
```
11391139

1140-
Aurora Serverless Clusters do not support the following features:
1140+
**Note**: The `rds.ServerlessCluster` class is for Aurora Serverless v1. If you want to use Aurora Serverless v2, use the `rds.DatabaseCluster` class.
1141+
1142+
Aurora Serverless v1 Clusters do not support the following features:
11411143

11421144
* Loading data from an Amazon S3 bucket
11431145
* Saving data to an Amazon S3 bucket
@@ -1152,9 +1154,9 @@ Aurora Serverless Clusters do not support the following features:
11521154
* Performance Insights
11531155
* RDS Proxy
11541156

1155-
Read more about the [limitations of Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)
1157+
Read more about the [limitations of Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)
11561158

1157-
Learn more about using Amazon Aurora Serverless by reading the [documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html)
1159+
Learn more about using Amazon Aurora Serverless v1 by reading the [documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html)
11581160

11591161
Use `ServerlessClusterFromSnapshot` to create a serverless cluster from a snapshot:
11601162

@@ -1167,7 +1169,7 @@ new rds.ServerlessClusterFromSnapshot(this, 'Cluster', {
11671169
});
11681170
```
11691171

1170-
### Data API
1172+
## Data API
11711173

11721174
You can access your Aurora DB cluster using the built-in Data API. The Data API doesn't require a persistent connection to the DB cluster. Instead, it provides a secure HTTP endpoint and integration with AWS SDKs.
11731175

@@ -1198,15 +1200,15 @@ cluster.grantDataApiAccess(fn);
11981200

11991201
To learn more about using the Data API, see the [documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html).
12001202

1201-
### Default VPC
1203+
## Default VPC
12021204

12031205
The `vpc` parameter is optional.
12041206

12051207
If not provided, the cluster will be created in the default VPC of the account and region.
12061208
As this VPC is not deployed with AWS CDK, you can't configure the `vpcSubnets`, `subnetGroup` or `securityGroups` of the Aurora Serverless Cluster.
12071209
If you want to provide one of `vpcSubnets`, `subnetGroup` or `securityGroups` parameter, please provide a `vpc`.
12081210

1209-
### Preferred Maintenance Window
1211+
## Preferred Maintenance Window
12101212

12111213
When creating an RDS cluster, it is possible to (optionally) specify a preferred maintenance window for the cluster as well as the instances under the cluster.
12121214
See [AWS docs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) for more information regarding maintenance windows.

packages/aws-cdk-lib/aws-rds/lib/serverless-cluster.ts

+7-7
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ export interface IServerlessCluster extends IResource, ec2.IConnectable, secrets
5050
grantDataApiAccess(grantee: iam.IGrantable): iam.Grant;
5151
}
5252
/**
53-
* Common Properties to configure new Aurora Serverless Cluster or Aurora Serverless Cluster from snapshot
53+
* Common Properties to configure new Aurora Serverless v1 Cluster or Aurora Serverless v1 Cluster from snapshot
5454
*/
5555
interface ServerlessClusterNewProps {
5656
/**
@@ -98,7 +98,7 @@ interface ServerlessClusterNewProps {
9898
readonly enableDataApi?: boolean;
9999

100100
/**
101-
* The VPC that this Aurora Serverless cluster has been created in.
101+
* The VPC that this Aurora Serverless v1 Cluster has been created in.
102102
*
103103
* @default - the default VPC in the account and region will be used
104104
*/
@@ -260,7 +260,7 @@ export enum TimeoutAction {
260260
}
261261

262262
/**
263-
* Options for configuring scaling on an Aurora Serverless cluster
263+
* Options for configuring scaling on an Aurora Serverless v1 Cluster
264264
*
265265
*/
266266
export interface ServerlessScalingOptions {
@@ -387,7 +387,7 @@ abstract class ServerlessClusterBase extends Resource implements IServerlessClus
387387
}
388388

389389
/**
390-
* Create an Aurora Serverless Cluster
390+
* Create an Aurora Serverless v1 Cluster
391391
*
392392
* @resource AWS::RDS::DBCluster
393393
*/
@@ -508,7 +508,7 @@ abstract class ServerlessClusterNew extends ServerlessClusterBase {
508508
}
509509

510510
/**
511-
* Properties for a new Aurora Serverless Cluster
511+
* Properties for a new Aurora Serverless v1 Cluster
512512
*/
513513
export interface ServerlessClusterProps extends ServerlessClusterNewProps {
514514
/**
@@ -527,7 +527,7 @@ export interface ServerlessClusterProps extends ServerlessClusterNewProps {
527527
}
528528

529529
/**
530-
* Create an Aurora Serverless Cluster
530+
* Create an Aurora Serverless v1 Cluster
531531
*
532532
* @resource AWS::RDS::DBCluster
533533
*
@@ -709,7 +709,7 @@ export interface ServerlessClusterFromSnapshotProps extends ServerlessClusterNew
709709
}
710710

711711
/**
712-
* A Aurora Serverless Cluster restored from a snapshot.
712+
* A Aurora Serverless v1 Cluster restored from a snapshot.
713713
*
714714
* @resource AWS::RDS::DBCluster
715715
*/

0 commit comments

Comments
 (0)