# ServerlessClusterProps

Properties for a new Aurora Serverless v1 Cluster.

Extends: ServerlessClusterProps
Used as props by: ServerlessCluster

- Source: [`aws-rds/lib/serverless-cluster.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-rds/lib/serverless-cluster.ts#L559)
- Type last changed: v2.235.0 · 15 Jan 2026

## Example

```ts
// Create username and password secret for DB Cluster
const secret = new rds.DatabaseSecret(this, 'AuroraSecret', {
  username: 'clusteradmin',
});

// The VPC to place the cluster in
const vpc = new ec2.Vpc(this, 'AuroraVpc');

// Create the serverless cluster, provide all values needed to customise the database.
const cluster = new rds.ServerlessCluster(this, 'AuroraCluster', {
  engine: rds.DatabaseClusterEngine.AURORA_MYSQL,
  vpc,
  credentials: { username: 'clusteradmin' },
  clusterIdentifier: 'db-endpoint-test',
  defaultDatabaseName: 'demos',
});

// Build a data source for AppSync to access the database.
declare const api: appsync.GraphqlApi;
const rdsDS = api.addRdsDataSource('rds', cluster, secret, 'demos');

// Set up a resolver for an RDS query.
rdsDS.createResolver('QueryGetDemosRdsResolver', {
  typeName: 'Query',
  fieldName: 'getDemosRds',
  requestMappingTemplate: appsync.MappingTemplate.fromString(`
  {
    "version": "2018-05-29",
    "statements": [
      "SELECT * FROM demos"
    ]
  }
  `),
  responseMappingTemplate: appsync.MappingTemplate.fromString(`
    $utils.toJson($utils.rds.toJsonObject($ctx.result)[0])
  `),
});

// Set up a resolver for an RDS mutation.
rdsDS.createResolver('MutationAddDemoRdsResolver', {
  typeName: 'Mutation',
  fieldName: 'addDemoRds',
  requestMappingTemplate: appsync.MappingTemplate.fromString(`
  {
    "version": "2018-05-29",
    "statements": [
      "INSERT INTO demos VALUES (:id, :version)",
      "SELECT * WHERE id = :id"
    ],
    "variableMap": {
      ":id": $util.toJson($util.autoId()),
      ":version": $util.toJson($ctx.args.version)
    }
  }
  `),
  responseMappingTemplate: appsync.MappingTemplate.fromString(`
    $utils.toJson($utils.rds.toJsonObject($ctx.result)[1][0])
  `),
});
```

## Properties

- `backupRetention`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = Duration.days(1) — The 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.

- `clusterIdentifier`: string — An optional identifier for the cluster.

  **Default:** A name is automatically generated.

- `copyTagsToSnapshot`: boolean = true — Whether to copy tags to the snapshot when a snapshot is created.

- `credentials`: [Credentials](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.Credentials.html) — Credentials for the administrative user.

  **Default:** A username of 'admin' and SecretsManager-generated password

- `defaultDatabaseName`: string — Name of a database which is automatically created inside the cluster.

  **Default:** Database is not created in cluster.

- `deletionProtection`: boolean — Indicates whether the DB cluster should have deletion protection enabled.

  **Default:** true if removalPolicy is RETAIN, false otherwise

- `enableDataApi`: boolean = false — Whether to enable the Data API.

- `engine`: [IClusterEngine](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.IClusterEngine.html) (required) — What kind of database to start.

- `parameterGroup`: [IParameterGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.IParameterGroup.html) — Additional parameters to pass to the database engine.

  **Default:** no parameter group.

- `removalPolicy`: [RemovalPolicy](/cdk/api/v2/docs/aws-cdk-lib.RemovalPolicy.html) — The 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)

- `scaling`: [ServerlessScalingOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.ServerlessScalingOptions.html) — Scaling 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

- `securityGroups`: [ISecurityGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.ISecurityGroup.html)[] — 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.

- `storageEncryptionKey`: [IKey](/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html) — The KMS key for storage encryption.

  **Default:** the default master key will be used for storage encryption

- `subnetGroup`: [IDBSubnetGroupRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_rds.IDBSubnetGroupRef.html) — Existing 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

- `vpc`: [IVpc](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) — The VPC that this Aurora Serverless v1 Cluster has been created in.

  **Default:** the default VPC in the account and region will be used

- `vpcSubnets`: [SubnetSelection](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.SubnetSelection.html) — Where to place the instances within the VPC.

  **Default:** the VPC default strategy if not specified.

  If provided, the `vpc` property must also be specified.