You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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*
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:
1141
1143
1142
1144
* Loading data from an Amazon S3 bucket
1143
1145
* Saving data to an Amazon S3 bucket
@@ -1152,9 +1154,9 @@ Aurora Serverless Clusters do not support the following features:
1152
1154
* Performance Insights
1153
1155
* RDS Proxy
1154
1156
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)
1156
1158
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)
1158
1160
1159
1161
Use `ServerlessClusterFromSnapshot` to create a serverless cluster from a snapshot:
1160
1162
@@ -1167,7 +1169,7 @@ new rds.ServerlessClusterFromSnapshot(this, 'Cluster', {
1167
1169
});
1168
1170
```
1169
1171
1170
-
###Data API
1172
+
## Data API
1171
1173
1172
1174
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.
To learn more about using the Data API, see the [documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html).
1200
1202
1201
-
###Default VPC
1203
+
## Default VPC
1202
1204
1203
1205
The `vpc` parameter is optional.
1204
1206
1205
1207
If not provided, the cluster will be created in the default VPC of the account and region.
1206
1208
As this VPC is not deployed with AWS CDK, you can't configure the `vpcSubnets`, `subnetGroup` or `securityGroups` of the Aurora Serverless Cluster.
1207
1209
If you want to provide one of `vpcSubnets`, `subnetGroup` or `securityGroups` parameter, please provide a `vpc`.
1208
1210
1209
-
###Preferred Maintenance Window
1211
+
## Preferred Maintenance Window
1210
1212
1211
1213
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.
1212
1214
See [AWS docs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) for more information regarding maintenance windows.
0 commit comments