ServerlessClusterProps

class aws_cdk.aws_rds.ServerlessClusterProps(*, engine, vpc, backup_retention=None, cluster_identifier=None, credentials=None, default_database_name=None, deletion_protection=None, enable_data_api=None, parameter_group=None, removal_policy=None, scaling=None, security_groups=None, storage_encryption_key=None, subnet_group=None, vpc_subnets=None)

Bases: object

Properties to configure an Aurora Serverless Cluster.

Parameters
  • engine (IClusterEngine) – What kind of database to start.

  • vpc (IVpc) – The VPC that this Aurora Serverless cluster has been created in.

  • backup_retention (Optional[Duration]) – 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. Default: Duration.days(1)

  • cluster_identifier (Optional[str]) – An optional identifier for the cluster. Default: - A name is automatically generated.

  • credentials (Optional[Credentials]) – Credentials for the administrative user. Default: - A username of ‘admin’ and SecretsManager-generated password

  • default_database_name (Optional[str]) – Name of a database which is automatically created inside the cluster. Default: - Database is not created in cluster.

  • deletion_protection (Optional[bool]) – Indicates whether the DB cluster should have deletion protection enabled. Default: - true if removalPolicy is RETAIN, false otherwise

  • enable_data_api (Optional[bool]) – Whether to enable the Data API. Default: false

  • parameter_group (Optional[IParameterGroup]) – Additional parameters to pass to the database engine. Default: - no parameter group.

  • removal_policy (Optional[RemovalPolicy]) – 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 (Optional[ServerlessScalingOptions]) – 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

  • security_groups (Optional[Sequence[ISecurityGroup]]) – Security group. Default: - a new security group is created.

  • storage_encryption_key (Optional[IKey]) – The KMS key for storage encryption. Default: - the default master key will be used for storage encryption

  • subnet_group (Optional[ISubnetGroup]) – Existing subnet group for the cluster. Default: - a new subnet group will be created.

  • vpc_subnets (Optional[SubnetSelection]) – Where to place the instances within the VPC. Default: - the VPC default strategy if not specified.

Attributes

backup_retention

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.

Default

Duration.days(1)

Return type

Optional[Duration]

cluster_identifier

An optional identifier for the cluster.

Default
  • A name is automatically generated.

Return type

Optional[str]

credentials

Credentials for the administrative user.

Default
  • A username of ‘admin’ and SecretsManager-generated password

Return type

Optional[Credentials]

default_database_name

Name of a database which is automatically created inside the cluster.

Default
  • Database is not created in cluster.

Return type

Optional[str]

deletion_protection

Indicates whether the DB cluster should have deletion protection enabled.

Default
  • true if removalPolicy is RETAIN, false otherwise

Return type

Optional[bool]

enable_data_api

Whether to enable the Data API.

Default

false

See

https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html

Return type

Optional[bool]

engine

What kind of database to start.

Return type

IClusterEngine

parameter_group

Additional parameters to pass to the database engine.

Default
  • no parameter group.

Return type

Optional[IParameterGroup]

removal_policy

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)

Return type

Optional[RemovalPolicy]

scaling

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

Return type

Optional[ServerlessScalingOptions]

security_groups

Security group.

Default
  • a new security group is created.

Return type

Optional[List[ISecurityGroup]]

storage_encryption_key

The KMS key for storage encryption.

Default
  • the default master key will be used for storage encryption

Return type

Optional[IKey]

subnet_group

Existing subnet group for the cluster.

Default
  • a new subnet group will be created.

Return type

Optional[ISubnetGroup]

vpc

The VPC that this Aurora Serverless cluster has been created in.

Return type

IVpc

vpc_subnets

Where to place the instances within the VPC.

Default
  • the VPC default strategy if not specified.

Return type

Optional[SubnetSelection]