cfn-modules: RDS MySQL

RDS MySQL database with secure firewall configuration, encryption, multi AZ, backup enabled, and alerting.

Install

Install Node.js and npm first!

npm i @cfn-modules/rds-mysql

Usage

---
AWSTemplateFormatVersion: '2010-09-09'
Description: 'cfn-modules example'
Resources:
  Database:
    Type: 'AWS::CloudFormation::Stack'
    Properties:
      Parameters:
        VpcModule: !GetAtt 'Vpc.Outputs.StackName' # required
        ClientSgModule: !GetAtt 'ClientSg.Outputs.StackName' # required
        AlertingModule: '' # optional
        HostedZoneModule: '' # optional
        BastionModule: '' # optional
        KmsKeyModule: '' # optional
        SecretModule: '' # optional
        DBSnapshotIdentifier: '' # optional
        DBAllocatedStorage: 5 # optional
        DBInstanceClass: 'db.t4g.micro' # optional
        DBName: '' # optional
        DBBackupRetentionPeriod: 30 # optional
        DBMasterUsername: 'master' # optional
        DBMasterUserPassword: '' # required if neither DBSnapshotIdentifier nor SecretModule is set
        DBMultiAZ: true # optional
        SubDomainNameWithDot: 'mysql.' # optional
        # Set this to the version of MySQL you want to use.
        # You can run the following command to get the list of MySQL versions supported by AWS RDS:
        # aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
        EngineVersion: '8.0.31'
        EnableIAMDatabaseAuthentication: 'false' # optional
      TemplateURL: './node_modules/@cfn-modules/rds-mysql/module.yml'

Examples

• ec2-mysql

Related modules

• rds-aurora-serverless
• rds-postgres

Parameters

Limitations

• Scalable: RDS instances capacity (CPU, RAM, network, ...) is limited by design
• Monitoring: Network In+Out is not monitored according to capacity of instance type