# API Reference ## Constructs ### RdsScheduler A scheduler for RDS instances or clusters. #### Initializers ```typescript import { RdsScheduler } from 'cdk-rds-scheduler' new RdsScheduler(scope: Construct, id: string, props: RdsSchedulerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RdsSchedulerProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RdsSchedulerProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { RdsScheduler } from 'cdk-rds-scheduler' RdsScheduler.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ## Structs ### CronOptions Options to configure a cron expression. All fields are strings so you can use complex expressions. Absence of a field implies '*' or '?', whichever one is appropriate. > [https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html) #### Initializer ```typescript import { CronOptions } from 'cdk-rds-scheduler' const cronOptions: CronOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | day | string | The day of the month to run this rule at. | | hour | string | The hour to run this rule at. | | minute | string | The minute to run this rule at. | | month | string | The month to run this rule at. | | weekDay | string | The day of the week to run this rule at. | | year | string | The year to run this rule at. | --- ##### `day`^Optional ```typescript public readonly day: string; ``` - *Type:* string - *Default:* Every day of the month The day of the month to run this rule at. --- ##### `hour`^Optional ```typescript public readonly hour: string; ``` - *Type:* string - *Default:* Every hour The hour to run this rule at. --- ##### `minute`^Optional ```typescript public readonly minute: string; ``` - *Type:* string - *Default:* Every minute The minute to run this rule at. --- ##### `month`^Optional ```typescript public readonly month: string; ``` - *Type:* string - *Default:* Every month The month to run this rule at. --- ##### `weekDay`^Optional ```typescript public readonly weekDay: string; ``` - *Type:* string - *Default:* Any day of the week The day of the week to run this rule at. --- ##### `year`^Optional ```typescript public readonly year: string; ``` - *Type:* string - *Default:* Every year The year to run this rule at. --- ### RdsSchedulerProps Properties for the RdsScheduler. #### Initializer ```typescript import { RdsSchedulerProps } from 'cdk-rds-scheduler' const rdsSchedulerProps: RdsSchedulerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | schedule | Schedule[] | The schedule for starting and stopping the RDS instance or cluster. | | cluster | aws-cdk-lib.aws_rds.IDatabaseCluster | The RDS cluster to start and stop. | | instance | aws-cdk-lib.aws_rds.IDatabaseInstance | The RDS instance to start and stop. | --- ##### `schedule`^Required ```typescript public readonly schedule: Schedule[]; ``` - *Type:* Schedule[] The schedule for starting and stopping the RDS instance or cluster. --- ##### `cluster`^Optional ```typescript public readonly cluster: IDatabaseCluster; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseCluster - *Default:* no cluster is specified and you must specify an instance The RDS cluster to start and stop. If you specify a cluster, you cannot specify an instance. --- ##### `instance`^Optional ```typescript public readonly instance: IDatabaseInstance; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseInstance - *Default:* no instance is specified and you must specify a cluster The RDS instance to start and stop. If you specify an instance, you cannot specify a cluster. --- ### Schedule #### Initializer ```typescript import { Schedule } from 'cdk-rds-scheduler' const schedule: Schedule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | start | Cron | The start schedule. | | stop | Cron | The stop schedule. | | timezone | aws-cdk-lib.TimeZone | The timezone for the cron expression. | --- ##### `start`^Optional ```typescript public readonly start: Cron; ``` - *Type:* Cron - *Default:* no start schedule. The RDS instance or cluster will not be started automatically. The start schedule. --- ##### `stop`^Optional ```typescript public readonly stop: Cron; ``` - *Type:* Cron - *Default:* no stop schedule. The RDS instance or cluster will not be stopped automatically. The stop schedule. --- ##### `timezone`^Optional ```typescript public readonly timezone: TimeZone; ``` - *Type:* aws-cdk-lib.TimeZone - *Default:* UTC The timezone for the cron expression. --- ## Classes ### Cron #### Initializers ```typescript import { Cron } from 'cdk-rds-scheduler' new Cron(options: CronOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | CronOptions | *No description.* | --- ##### `options`^Required - *Type:* CronOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Return the cron expression. | --- ##### `toString` ```typescript public toString(): string ``` Return the cron expression.