cdk-rds-dump

cdk-rds-dump is a Constructs library for AWS CDK that provides the functionality to dump the contents of Amazon RDS, generate it as an SQL file, and store it in Amazon S3.

Usage

Install from npm:

npm i cdk-rds-dump

Then write CDK code as below:

import * as events from 'aws-cdk-lib/aws-events'
import { RdsDump, DbEngine } from 'cdk-rds-dump';

declare const rdsCluster: rds.DatabaseCluster;
new RdsDump(this, "RdsDump", {
  dbEngine: DbEngine.MYSQL,
  rdsCluster: cluster,
  databaseName: "testDatabase",
  schedule: events.Schedule.cron({ minute: "0", hour: "0" }),
  // optional
  lambdaEnv: {
    ENV_VAR: "value",
  },
  // optional
  createSecretsManagerVPCEndpoint: false,
  // DB secret is obtained from rdsCluster.secret as default.
  // If you want to use a different secret, you can specify it as follows.
  // secretId: 'secretsmanager-secret-id',
});

Note: Assuming access to S3 via a Gateway Endpoint from within a VPC, please configure the Gateway Endpoint and update the Route Table based on this.

// Add gateway endpoints when creating the VPC
  const vpc = new ec2.Vpc(this, 'MyVpc', {
    gatewayEndpoints: {
      S3: {
        service: ec2.GatewayVpcEndpointAwsService.S3,
      },
    },
  });

How does it work?

This code creates a new RDS cluster and uses the RdsDump Construct to dump the data from that RDS cluster. The dumped data is generated as an SQL file and stored in Amazon S3.

For detailed usage and details of the parameters, refer to the API documentation.

Why do we need this construct?

AWS RDS is a very useful managed RDB service and includes, by default, the ability to create snapshots. However, in some cases, such as for development reasons, it is easier to handle SQL files dumped from the DB. Therefore, cdk-rds-dump was created as a construct to easily create SQL files on a regular basis.

Contribution

Contributions to the project are welcome. Submit improvement proposals via pull requests or propose new features.

License

This project is licensed under the Apache-2.0 License.