ServerlessCluster
Create an Aurora Serverless v1 Cluster.
Import
import { ServerlessCluster } from 'aws-cdk-lib/aws-rds';Or use the module namespace:
import * as rds from 'aws-cdk-lib/aws-rds';
// rds.ServerlessClusterProperties
Configuration passed to the constructor as ServerlessClusterProps.
engineRequiredIClusterEngineWhat kind of database to start.
backupRetentionOptionalDurationThe number of days during which automatic DB snapshots are retained. Automatic backup retention cannot be disabled on serverless clusters. Must be a value from 1 day to 35 days.
Default: Duration.days(1)
clusterIdentifierOptionalstringAn optional identifier for the cluster.
Default: - A name is automatically generated.
copyTagsToSnapshotOptionalbooleanWhether to copy tags to the snapshot when a snapshot is created.
Default: - true
credentialsOptionalCredentialsCredentials for the administrative user.
Default: - A username of 'admin' and SecretsManager-generated password
defaultDatabaseNameOptionalstringName of a database which is automatically created inside the cluster.
Default: - Database is not created in cluster.
deletionProtectionOptionalbooleanIndicates whether the DB cluster should have deletion protection enabled.
Default: - true if removalPolicy is RETAIN, false otherwise
enableDataApiOptionalbooleanWhether to enable the Data API.
Default: false
parameterGroupOptionalIParameterGroupAdditional parameters to pass to the database engine.
Default: - no parameter group.
removalPolicyOptionalRemovalPolicyThe removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
Default: - RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data)
scalingOptionalServerlessScalingOptionsScaling configuration of an Aurora Serverless database cluster.
Default: - Serverless cluster is automatically paused after 5 minutes of being idle.
minimum capacity: 2 ACU
maximum capacity: 16 ACU
securityGroupsOptionalISecurityGroup[]Security group.
Default: - a new security group is created if `vpc` was provided.
If the `vpc` property was not provided, no VPC security groups will be associated with the DB cluster.
storageEncryptionKeyOptionalIKeyThe KMS key for storage encryption.
Default: - the default master key will be used for storage encryption
subnetGroupOptionalIDBSubnetGroupRefExisting subnet group for the cluster.
Default: - a new subnet group is created if `vpc` was provided.
If the `vpc` property was not provided, no subnet group will be associated with the DB cluster
vpcOptionalIVpcThe VPC that this Aurora Serverless v1 Cluster has been created in.
Default: - the default VPC in the account and region will be used
vpcSubnetsOptionalSubnetSelectionWhere to place the instances within the VPC. If provided, the `vpc` property must also be specified.
Default: - the VPC default strategy if not specified.
Get the Amazon RDS Cheat Sheet
Everything you need to know about Amazon RDS on one page. HD quality, print-friendly.
Download Free InfographicQuick Facts
aws-rds