@gammarers/aws-rds-database-running-schedule-stack 2.4.2 → 2.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +3 -3
- package/README.md +20 -2
- package/images/example-email.png +0 -0
- package/images/example-slack.png +0 -0
- package/lib/index.js +1 -1
- package/package.json +1 -1
package/.jsii
CHANGED
|
@@ -3719,7 +3719,7 @@
|
|
|
3719
3719
|
},
|
|
3720
3720
|
"name": "@gammarers/aws-rds-database-running-schedule-stack",
|
|
3721
3721
|
"readme": {
|
|
3722
|
-
"markdown": "# AWS RDS Database Running Schedule Stack\n\n[](https://github.com/gammarers/aws-rds-database-running-schedule-stack/blob/main/LICENSE)\n[](https://www.npmjs.com/package/@gammarers/aws-rds-database-running-schedule-stack)\n[](https://pypi.org/project/gammarers.aws-rds-database-running-schedule-stack/)\n[](https://www.nuget.org/packages/Gammarers.CDK.AWS.RdsDatabaseRunningScheduleStack/)\n[](https://github.com/gammarers/aws-rds-database-running-schedule-stack/actions/workflows/release.yml)\n[](https://github.com/gammarers/aws-rds-database-running-schedule-stack/releases)\n\n[](https://constructs.dev/packages/@gammarers/aws-rds-database-running-schedule-stack)\n\nThis 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.\n\n> [!WARNING]\n> v2.3.0:\n> Stack props add option resourceNamingOption\n> default ResourceNamingType.DEFAULT is cdk generated name\n> f you want to maintain compatibility with versions below `v2.3.0`, please include the following settings (ResourceNamingType.AUTO).\n> ```typescript\n> new RDSDatabaseRunningScheduleStack(app, 'RDSDatabaseRunningScheduleStack', {\n> targetResource: {\n> tagKey: 'WorkHoursRunning',\n> tagValues: ['YES'],\n> },\n> resourceNamingOption: {\n> type: ResourceNamingType.AUTO, // HERE\n> },\n> });\n> ```\n\n\n## Fixed\n\n- RDS Aurora Cluster\n- RDS Instance\n\n## Resources\n\nThis construct creating resource list.\n\n- EventBridge Scheduler execution role\n- EventBridge Scheduler\n- StepFunctions StateMahcine (star or stop controle)\n- StepFunctions StateMahcine execution role\n\n## Install\n\n### TypeScript\n\n#### install by npm\n\n```shell\nnpm install @gammarers/aws-rds-database-running-schedule-stack\n```\n\n#### install by yarn\n\n```shell\nyarn add @gammarers/aws-rds-database-running-schedule-stack\n```\n\n#### install by pnpm\n\n```shell\npnpm add @gammarers/aws-rds-database-running-schedule-stack\n```\n\n#### install by bun\n\n```shell\nbun add @gammarers/aws-rds-database-running-schedule-stack\n```\n\n### Python\n\n```shell\npip install gammarers.aws-rds-database-running-schedule-stack\n```\n\n### C# / .NET\n\n```shell\ndotnet add package Gammarers.CDK.AWS.RdsDatabaseRunningScheduleStack\n```\n\n## Example\n\n```typescript\nimport {
|
|
3722
|
+
"markdown": "# AWS RDS Database Running Schedule Stack\n\n[](https://github.com/gammarers/aws-rds-database-running-schedule-stack/blob/main/LICENSE)\n[](https://www.npmjs.com/package/@gammarers/aws-rds-database-running-schedule-stack)\n[](https://pypi.org/project/gammarers.aws-rds-database-running-schedule-stack/)\n[](https://www.nuget.org/packages/Gammarers.CDK.AWS.RdsDatabaseRunningScheduleStack/)\n[](https://github.com/gammarers/aws-rds-database-running-schedule-stack/actions/workflows/release.yml)\n[](https://github.com/gammarers/aws-rds-database-running-schedule-stack/releases)\n\n[](https://constructs.dev/packages/@gammarers/aws-rds-database-running-schedule-stack)\n\nThis 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.\n\n> [!WARNING]\n> v2.3.0:\n> Stack props add option resourceNamingOption\n> default ResourceNamingType.DEFAULT is cdk generated name\n> f you want to maintain compatibility with versions below `v2.3.0`, please include the following settings (ResourceNamingType.AUTO).\n> ```typescript\n> new RDSDatabaseRunningScheduleStack(app, 'RDSDatabaseRunningScheduleStack', {\n> targetResource: {\n> tagKey: 'WorkHoursRunning',\n> tagValues: ['YES'],\n> },\n> resourceNamingOption: {\n> type: ResourceNamingType.AUTO, // HERE\n> },\n> });\n> ```\n\n\n## Fixed\n\n- RDS Aurora Cluster\n- RDS Instance\n\n## Resources\n\nThis construct creating resource list.\n\n- EventBridge Scheduler execution role\n- EventBridge Scheduler\n- StepFunctions StateMahcine (star or stop controle)\n- StepFunctions StateMahcine execution role\n\n## Install\n\n### TypeScript\n\n#### install by npm\n\n```shell\nnpm install @gammarers/aws-rds-database-running-schedule-stack\n```\n\n#### install by yarn\n\n```shell\nyarn add @gammarers/aws-rds-database-running-schedule-stack\n```\n\n#### install by pnpm\n\n```shell\npnpm add @gammarers/aws-rds-database-running-schedule-stack\n```\n\n#### install by bun\n\n```shell\nbun add @gammarers/aws-rds-database-running-schedule-stack\n```\n\n### Python\n\n```shell\npip install gammarers.aws-rds-database-running-schedule-stack\n```\n\n### C# / .NET\n\n```shell\ndotnet add package Gammarers.CDK.AWS.RdsDatabaseRunningScheduleStack\n```\n\n## Example\n\n```typescript\nimport { RDSDatabaseRunningScheduleStack, ResourceNamingType } from '@gammarer/aws-rds-database-running-schedule-stack';\n\nnew RDSDatabaseRunningScheduleStack(app, 'RDSDatabaseRunningScheduleStack', {\n targetResource: {\n tagKey: 'WorkHoursRunning', // already tagging to rds instance or cluster\n tagValues: ['YES'], // already tagging to rds instance or cluster\n },\n enableScheduling: true,\n startSchedule: {\n timezone: 'Asia/Tokyo',\n minute: '55',\n hour: '8',\n week: 'MON-FRI',\n },\n stopSchedule: {\n timezone: 'Asia/Tokyo',\n minute: '5',\n hour: '19',\n week: 'MON-FRI',\n },\n resourceNamingOption: {\n type: ResourceNamingType.AUTO, // DEFAULT or AUTO or CUSTOM\n },\n notifications: {\n emails: [ // \"Incoming Sample Message - EMAIL\"\n 'foo@example.com',\n 'bar@example.net',\n ],\n slack: { // \"Incoming Sample Message - EMAIL\"\n webhookSecretName: 'example/slack/webhook',\n },\n },\n});\n```\n\n## Incoming Sample Message\n\n### EMAIL\n\n\n\n### Slack\n\n\n\n## License\n\nThis project is licensed under the Apache-2.0 License.\n\n\n\n"
|
|
3723
3723
|
},
|
|
3724
3724
|
"repository": {
|
|
3725
3725
|
"type": "git",
|
|
@@ -4267,6 +4267,6 @@
|
|
|
4267
4267
|
"symbolId": "src/index:TargetResourceProperty"
|
|
4268
4268
|
}
|
|
4269
4269
|
},
|
|
4270
|
-
"version": "2.4.
|
|
4271
|
-
"fingerprint": "
|
|
4270
|
+
"version": "2.4.3",
|
|
4271
|
+
"fingerprint": "akpZdycdFSYTUjGU/Kj0r+gsouZbl17wVzlWcdQZ2RM="
|
|
4272
4272
|
}
|
package/README.md
CHANGED
|
@@ -86,7 +86,7 @@ dotnet add package Gammarers.CDK.AWS.RdsDatabaseRunningScheduleStack
|
|
|
86
86
|
## Example
|
|
87
87
|
|
|
88
88
|
```typescript
|
|
89
|
-
import {
|
|
89
|
+
import { RDSDatabaseRunningScheduleStack, ResourceNamingType } from '@gammarer/aws-rds-database-running-schedule-stack';
|
|
90
90
|
|
|
91
91
|
new RDSDatabaseRunningScheduleStack(app, 'RDSDatabaseRunningScheduleStack', {
|
|
92
92
|
targetResource: {
|
|
@@ -109,10 +109,28 @@ new RDSDatabaseRunningScheduleStack(app, 'RDSDatabaseRunningScheduleStack', {
|
|
|
109
109
|
resourceNamingOption: {
|
|
110
110
|
type: ResourceNamingType.AUTO, // DEFAULT or AUTO or CUSTOM
|
|
111
111
|
},
|
|
112
|
+
notifications: {
|
|
113
|
+
emails: [ // "Incoming Sample Message - EMAIL"
|
|
114
|
+
'foo@example.com',
|
|
115
|
+
'bar@example.net',
|
|
116
|
+
],
|
|
117
|
+
slack: { // "Incoming Sample Message - EMAIL"
|
|
118
|
+
webhookSecretName: 'example/slack/webhook',
|
|
119
|
+
},
|
|
120
|
+
},
|
|
112
121
|
});
|
|
113
|
-
|
|
114
122
|
```
|
|
115
123
|
|
|
124
|
+
## Incoming Sample Message
|
|
125
|
+
|
|
126
|
+
### EMAIL
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
### Slack
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
116
134
|
## License
|
|
117
135
|
|
|
118
136
|
This project is licensed under the Apache-2.0 License.
|
|
Binary file
|
|
Binary file
|
package/lib/index.js
CHANGED
|
@@ -149,7 +149,7 @@ class RDSDatabaseRunningScheduleStack extends aws_cdk_lib_1.Stack {
|
|
|
149
149
|
}
|
|
150
150
|
exports.RDSDatabaseRunningScheduleStack = RDSDatabaseRunningScheduleStack;
|
|
151
151
|
_a = JSII_RTTI_SYMBOL_1;
|
|
152
|
-
RDSDatabaseRunningScheduleStack[_a] = { fqn: "@gammarers/aws-rds-database-running-schedule-stack.RDSDatabaseRunningScheduleStack", version: "2.4.
|
|
152
|
+
RDSDatabaseRunningScheduleStack[_a] = { fqn: "@gammarers/aws-rds-database-running-schedule-stack.RDSDatabaseRunningScheduleStack", version: "2.4.3" };
|
|
153
153
|
class DBRuningSchedule extends scheduler.CfnSchedule {
|
|
154
154
|
constructor(scope, id, props) {
|
|
155
155
|
super(scope, id, {
|