Skip to main content

AWS RDS Database Running Scheduler

Project description

AWS RDS Database Running Schedule Stack

GitHub npm (scoped) PyPI Nuget GitHub Workflow Status (branch) GitHub release (latest SemVer)

View on Construct Hub

This AWS CDK Construct Stack controls the starting and stopping of RDS DB instances and clusters based on specified tags, ensuring they only run during working hours. It uses EventBridge Scheduler to trigger a StepFunctions State Machine at the start and end of the working hours(default 07:50(UTC) - 21:10(UTC)), which then starts or stops the databases depending on the mode.

Fixed

  • RDS Aurora Cluster
  • RDS Instance

Resources

This construct creating resource list.

  • EventBridge Scheduler execution role
  • EventBridge Scheduler
  • StepFunctions StateMahcine (star or stop controle)
  • StepFunctions StateMahcine execution role

Install

TypeScript

install by npm

npm install @gammarers/aws-rds-database-running-schedule-stack

install by yarn

yarn add @gammarers/aws-rds-database-running-schedule-stack

install by pnpm

pnpm add @gammarers/aws-rds-database-running-schedule-stack

install by bun

bun add @gammarers/aws-rds-database-running-schedule-stack

Python

pip install gammarers.aws-rds-database-running-schedule-stack

C# / .NET

dotnet add package Gammarers.CDK.AWS.RdsDatabaseRunningScheduleStack

Example

import { RdsDatabaseRunningScheduler, DatabaseType } from '@gammarer/aws-rds-database-running-schedule-stack';

new RDSDatabaseRunningScheduleStack(app, 'RDSDatabaseRunningScheduleStack', {
  targetResource: {
    tagKey: 'WorkHoursRunning', // already tagging to rds instance or cluster
    tagValues: ['YES'], // already tagging to rds instance or cluster
  },
  enableScheduling: true,
  startSchedule: {
    timezone: 'Asia/Tokyo',
    minute: '55',
    hour: '8',
    week: 'MON-FRI',
  },
  stopSchedule: {
    timezone: 'Asia/Tokyo',
    minute: '5',
    hour: '19',
    week: 'MON-FRI',
  },
});

License

This project is licensed under the Apache-2.0 License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file gammarers_aws_rds_database_running_schedule_stack-2.2.9.tar.gz.

File metadata

File hashes

Hashes for gammarers_aws_rds_database_running_schedule_stack-2.2.9.tar.gz
Algorithm Hash digest
SHA256 6ebc91e36b9a6aad605734fb22a616588a3ae621f604c2ab878c261e38e8ecdb
MD5 4aa877358252c74b0ceb7ab0bf4b49fa
BLAKE2b-256 df40154eb3a09a1466a8f6751526c7b12b2e0a81835c3d57e3b8174b1d50ea9c

See more details on using hashes here.

File details

Details for the file gammarers.aws_rds_database_running_schedule_stack-2.2.9-py3-none-any.whl.

File metadata

File hashes

Hashes for gammarers.aws_rds_database_running_schedule_stack-2.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 74594c2b5665da4b2f3fbd6f3e307241243225376bba2a2d6ebe44158ccdee7c
MD5 bcd303045bfe70c281c3e21dde3e3d2c
BLAKE2b-256 e677b59a92b848c05a1a9b18ad494ac9cf0344eb7a92062d60d75e19dfafe77b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page