Aurora Serverless Cluster

Add an Aurora Serverless Cluster resource to your Altostra project

The Aurora Serverless Cluster resource creates an Amazon Aurora Serverless DB cluster (an Aurora Cluster in serverless DB engine mode).
To add an Aurora Serverless Cluster resource in the designer, go to the "Database" section and select the "Aurora Serverless Cluster" resource, or search "serverless" in the search box:

Aurora Serverless Cluster properties

Name:

type: string | required

• Altostra will use Name property for generating a logical ID:
  • Only strict alpha-numeric characters will be used (by the restrictions of CFN)
  • If non alpha-numeric characters were used in the name, the logical ID will be generated by the resource type
  • Up to 64 characters

SQL Engine:

type: string | required

• The name of the database engine that you want to use for this Aurora Cluster.
• Allowed values:
  • MySQL
  • PostgreSQL

SQL Engine Version:

type: string | required

• The version number of the database engine to use.
• Allowed Values: Dependent on the selected SQL Engine.

Default Database Name:

type: string | default: MyDB | required

• The name of the database to create when the Aurora Cluster is created.
• MySQL Constraints:
  • Must contain 1 to 64 letters or numbers.
  • Can't be a word reserved by the specified database engine.
• PostgreSQL Constraints:
  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
  • Must contain 1 to 63 characters.
  • Can't be a word reserved by the specified database engine.

Username:

type: string | default: MyDB | required

• The master user name for the Aurora Cluster.
• MySQL Constraints:
  • Must be 1 to 16 letters or numbers.
  • First character must be a letter.
  • Can't be a reserved word for the chosen database engine.
• PostgreSQL Constraints:
  • Must be 1 to 63 letters or numbers.
  • First character must be a letter.
  • Can't be a reserved word for the chosen database engine.

Advanced Parameters:

Minimum capacity unit:

type: integer | required

• The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
• The minimum capacity must be less than or equal to the maximum capacity.
• Available values:
  • 1 (MySQL only)
  • 2
  • 4
  • 8
  • 16
  • 32
  • 64
  • 128 (MySQL only)
  • 192 (PostgreSQL only)
  • 256 (MySQL only)
  • 384 (PostgreSQL only)

Maximum capacity unit:

type: integer | required

• The maximum capacity for an Aurora Serverless DB cluster.
• The maximum capacity must be greater than or equal to the minimum capacity.
• Available values:
  • 1 (MySQL only)
  • 2
  • 4
  • 8
  • 16
  • 32
  • 64
  • 128 (MySQL only)
  • 192 (PostgreSQL only)
  • 256 (MySQL only)
  • 384 (PostgreSQL only)

Auto pause:

type: boolean | default: false | required

• A value that indicates whether to allow or disallow automatic pause for an Aurora Serverless cluster. A DB cluster can be paused only when it is idle (I.E. it has no connections).

Note:
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

Auto pause when inactive for:

type: integer | allowed values: 300-86,400 (5 minutes-1 day) | required if Auto pause is true

• The time, in seconds, before an Aurora Serverless Cluster is paused.

Security Group IDs:

type: string | optional

• A comma separated list of the VPC security group IDs to assign to the Aurora Cluster.

Subnet IDs:

type: string | optional

• A comma separated list of the VPC subnet IDs to assign to the Aurora Cluster instances.

Enable Storage Encryption:

type: boolean | default: true | required

• A value that indicates whether the Aurora Cluster is encrypted.
  
  Aurora Cluster can be encrypted to protect the data stored in the database.
  
  When an Aurora Cluster is encrypted, the data stored in the underlying storage is encrypted using an encryption key. This encryption key is managed by the AWS Key Management Service (KMS), and it is used to encrypt and decrypt the data stored in the Aurora Cluster.

Use default key:

type: boolean | default: true | required if Enable Storage Encryption is true

• If true, indicates that the default KMS key should be used for Storage Encryption.
  Otherwise, the user must specify an Encryption Key ID.

Encryption Key ID:

type: string | required if Enable Storage Encryption is true and Use default key is false

• The ARN of the AWS KMS key that is used to encrypt the Aurora Cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

Backup Retention Days:

type: integer | allowed values: 1-35 | optional

• The number of days for which automated backups are retained.

Publicly accessible:

type: boolean | default: false | required

• Indicates whether the Aurora Cluster is an internet-facing cluster. If you specify true, AWS CloudFormation creates a cluster with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal cluster with a DNS name that resolves to a private IP address.

Deletion Protection:

type: boolean | default: true | required

• A value that indicates whether the Aurora Cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.