@cfn-modules/rds-aurora-serverless NPM

cfn-modules: AWS RDS Aurora Serverless MySQL cluster

RDS Aurora Serverless MySQL cluster with secure firewall configuration, encryption, multi AZ, auto scaling, backup enabled, and alerting.

Install

Install Node.js and npm first!

npm i @cfn-modules/rds-aurora-serverless

Usage

---
AWSTemplateFormatVersion: '2010-09-09'
Description: 'cfn-modules example'
Resources:
  AuroraServerlessCluster:
    Type: 'AWS::CloudFormation::Stack'
    Properties:
      Parameters:
        VpcModule: !GetAtt 'Vpc.Outputs.StackName' # required
        ClientSgModule: !GetAtt 'ClientSg.Outputs.StackName' # required
        KmsKeyModule: !GetAtt 'Key.Outputs.StackName' # required
        BastionModule: !GetAtt 'Bastion.Outputs.StackName' # optional
        HostedZoneModule: !GetAtt 'HostedZone.Outputs.StackName' # optional
        AlertingModule: !GetAtt 'Alerting.Outputs.StackName' # optional
        SecretModule: !GetAtt 'Secret.Outputs.StackName' # optional
        DBSnapshotIdentifier: '' # optional
        DBName: 'test' # required (ignored when DBSnapshotIdentifier is set, value used from snapshot)
        DBBackupRetentionPeriod: '30' # optional
        DBMasterUsername: 'master' # optional
        DBMasterUserPassword: 'SuP3rS3curE' # required (ignored when DBSnapshotIdentifier is set, value used from snapshot; also ignored if SecretModule is set)
        SubDomainNameWithDot: '' # optional
        PreferredBackupWindow: '09:54-10:24' # optional
        PreferredMaintenanceWindow: 'sat:07:00-sat:07:30' # optional
        AutoPause: 'true' # optional
        SecondsUntilAutoPause: '300' # optional
        MaxCapacity: '2' # optional
        MinCapacity: '2' # optional
        EngineVersion: '5.6.10a' # optional
        EnableDataApi: 'true' # optional
      TemplateURL: './node_modules/@cfn-modules/rds-aurora-serverless/module.yml'

Examples

none

Migration

v1 to v2

Be warned, switching from 1.x.x to 2.x.x will replace the database cluster. AWS is sunsetting Aurora Serverless v1. To upgrade to version 2, we recommend to take a snapshot of your current database cluster and use the DBSnapshotIdentifier to create a new Aurora cluster with serverless v2.