AWS RDS Database Running Scheduler

Common errors

• Error: Invariant Violation: The construct ID 'MyRDSScheduler' is already in use by a sibling construct. Choose a unique ID for each construct within the same scope.

  cause Attempting to create two constructs with the same ID within the same parent scope.
  fix Ensure each construct instance (e.g., `new RDSDatabaseRunningScheduler(...)`) has a unique string ID within its parent scope (e.g., `stack`).

• Error: Unable to resolve object: Fn::Join: Invalid type for Fn::Join

  cause Common CDK synthesis error indicating an issue with how references or intrinsic functions are used, often due to passing non-string values where strings are expected.
  fix Review the properties passed to `RDSDatabaseRunningSchedulerProps`, especially for `targetResource` and `secrets`, ensuring all values are correctly typed as strings or construct references.

• TypeError: Cannot read properties of undefined (reading 'account')

  cause CDK environment variables (CDK_DEFAULT_ACCOUNT, CDK_DEFAULT_REGION) are not set when synthesizing or deploying, and the stack's `env` property is not explicitly provided or correctly conditionally accessed.
  fix Define the `env` property for your `Stack` with explicit `account` and `region` values, or ensure `CDK_DEFAULT_ACCOUNT` and `CDK_DEFAULT_REGION` are set in your environment (e.g., `export CDK_DEFAULT_ACCOUNT="123456789012"`).

Warnings

• breaking This package requires Node.js version 20.0.0 or higher. Older Node.js versions are not supported and will lead to errors during CDK synthesis or deployment.
  Fix: Upgrade your Node.js environment to version 20.0.0 or newer (e.g., using nvm: `nvm install 20 && nvm use 20`).
• gotcha The `targetResource.tagKey` and `targetResource.tagValues` must exactly match the tags applied to your RDS instances or Aurora clusters. Mismatched casing or values will result in resources not being managed by the scheduler.
  Fix: Carefully verify that the tags on your AWS RDS resources (both key and value) precisely match the configuration in your CDK code.
• gotcha The `slackSecretName` property expects the name of an AWS Secrets Manager secret that contains the Slack webhook URL. If the secret does not exist or the Lambda function lacks permissions to access it, Slack notifications will fail silently or cause Lambda invocation errors.
  Fix: Ensure the specified secret exists in AWS Secrets Manager, contains a valid Slack webhook URL, and the IAM role associated with the scheduler's Lambda function has `secretsmanager:GetSecretValue` permissions for that secret.
• gotcha The `timezone` string for `startSchedule` and `stopSchedule` must be a valid IANA timezone identifier (e.g., 'America/New_York', 'Europe/London', 'Asia/Tokyo'). Invalid timezone strings may lead to incorrect scheduling or deployment failures.
  Fix: Consult a list of IANA timezones and use a valid identifier for your desired schedule. Examples include 'UTC', 'America/Los_Angeles', 'Europe/Berlin'.

Install

• npm install aws-rds-database-running-scheduler npm
• yarn add aws-rds-database-running-scheduler yarn
• pnpm add aws-rds-database-running-scheduler pnpm

Imports

• RDSDatabaseRunningScheduler
  wrong:

  const { RDSDatabaseRunningScheduler } = require('aws-rds-database-running-scheduler');

  correct:

  import { RDSDatabaseRunningScheduler } from 'aws-rds-database-running-scheduler';

  This is the primary construct for embedding the scheduler into an existing CDK stack. Use ESM import syntax.
• RDSDatabaseRunningScheduleStack
  wrong:

  import RDSDatabaseRunningScheduleStack from 'aws-rds-database-running-scheduler';

  correct:

  import { RDSDatabaseRunningScheduleStack } from 'aws-rds-database-running-scheduler';

  Use this specific Stack construct when creating a dedicated CDK stack solely for the scheduler. It's a named import.
• App

  import { App, Stack } from 'aws-cdk-lib';

  When using CDK constructs, you typically need to import `App` and `Stack` from `aws-cdk-lib` to define your application and environment.

Quickstart

This code deploys the RDS Database Running Scheduler as a construct within a new AWS CDK stack. It configures the scheduler to manage RDS instances and Aurora clusters tagged with 'WorkHoursRunning=YES', setting a daily start/stop schedule for weekdays in the 'Asia/Tokyo' timezone. It also includes a placeholder for Slack notification secret.

import { App, Stack } from 'aws-cdk-lib';
import { RDSDatabaseRunningScheduler } from 'aws-rds-database-running-scheduler';
import { Secret } from 'aws-cdk-lib/aws-secretsmanager';

const app = new App();
const stack = new Stack(app, 'MyRdsSchedulerStack', {
  env: {
    account: process.env.CDK_DEFAULT_ACCOUNT ?? '',
    region: process.env.CDK_DEFAULT_REGION ?? ''
  }
});

// Create a placeholder secret for Slack webhook (replace with your actual secret management)
const slackWebhookSecret = new Secret(stack, 'SlackWebhookSecret', {
  secretName: 'example/slack/webhook',
  description: 'Secret for Slack webhook URL (for RDS scheduler notifications)',
  secretStringValue: process.env.SLACK_WEBHOOK_URL ?? 'https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX'
});

new RDSDatabaseRunningScheduler(stack, 'MyRDSScheduler', {
  targetResource: { tagKey: 'WorkHoursRunning', tagValues: ['YES'] },
  secrets: { slackSecretName: slackWebhookSecret.secretName },
  enableScheduling: true,
  startSchedule: { timezone: 'Asia/Tokyo', minute: '50', hour: '7', week: 'MON-FRI' },
  stopSchedule: { timezone: 'Asia/Tokyo', minute: '5', hour: '19', week: 'MON-FRI' }
});

app.synth();