@gammarers/aws-rds-database-running-schedule-stack 2.3.11 → 2.4.1

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.
Files changed (7) hide show
  1. package/.jsii +206 -142
  2. package/API.md +147 -108
  3. package/lib/index.d.ts +6 -2
  4. package/lib/index.js +13 -181
  5. package/lib/resources/running-control-state-machine.d.ts +9 -0
  6. package/lib/resources/running-control-state-machine.js +233 -0
  7. package/package.json +7 -5
package/API.md CHANGED
@@ -879,111 +879,6 @@ Whether termination protection is enabled for this stack.
879
879
 
880
880
  ## Structs <a name="Structs" id="Structs"></a>
881
881
 
882
- ### CustomNaming <a name="CustomNaming" id="@gammarers/aws-rds-database-running-schedule-stack.CustomNaming"></a>
883
-
884
- #### Initializer <a name="Initializer" id="@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.Initializer"></a>
885
-
886
- ```typescript
887
- import { CustomNaming } from '@gammarers/aws-rds-database-running-schedule-stack'
888
-
889
- const customNaming: CustomNaming = { ... }
890
- ```
891
-
892
- #### Properties <a name="Properties" id="Properties"></a>
893
-
894
- | **Name** | **Type** | **Description** |
895
- | --- | --- | --- |
896
- | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.notificationTopicDisplayName">notificationTopicDisplayName</a></code> | <code>string</code> | *No description.* |
897
- | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.notificationTopicName">notificationTopicName</a></code> | <code>string</code> | *No description.* |
898
- | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.schedulerRoleName">schedulerRoleName</a></code> | <code>string</code> | *No description.* |
899
- | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.startScheduleName">startScheduleName</a></code> | <code>string</code> | *No description.* |
900
- | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.stateMachineName">stateMachineName</a></code> | <code>string</code> | *No description.* |
901
- | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.stateMachineRoleName">stateMachineRoleName</a></code> | <code>string</code> | *No description.* |
902
- | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.stopScheduleName">stopScheduleName</a></code> | <code>string</code> | *No description.* |
903
- | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.type">type</a></code> | <code>@gammarers/aws-resource-naming.ResourceNamingType</code> | *No description.* |
904
-
905
- ---
906
-
907
- ##### `notificationTopicDisplayName`<sup>Required</sup> <a name="notificationTopicDisplayName" id="@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.notificationTopicDisplayName"></a>
908
-
909
- ```typescript
910
- public readonly notificationTopicDisplayName: string;
911
- ```
912
-
913
- - *Type:* string
914
-
915
- ---
916
-
917
- ##### `notificationTopicName`<sup>Required</sup> <a name="notificationTopicName" id="@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.notificationTopicName"></a>
918
-
919
- ```typescript
920
- public readonly notificationTopicName: string;
921
- ```
922
-
923
- - *Type:* string
924
-
925
- ---
926
-
927
- ##### `schedulerRoleName`<sup>Required</sup> <a name="schedulerRoleName" id="@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.schedulerRoleName"></a>
928
-
929
- ```typescript
930
- public readonly schedulerRoleName: string;
931
- ```
932
-
933
- - *Type:* string
934
-
935
- ---
936
-
937
- ##### `startScheduleName`<sup>Required</sup> <a name="startScheduleName" id="@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.startScheduleName"></a>
938
-
939
- ```typescript
940
- public readonly startScheduleName: string;
941
- ```
942
-
943
- - *Type:* string
944
-
945
- ---
946
-
947
- ##### `stateMachineName`<sup>Required</sup> <a name="stateMachineName" id="@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.stateMachineName"></a>
948
-
949
- ```typescript
950
- public readonly stateMachineName: string;
951
- ```
952
-
953
- - *Type:* string
954
-
955
- ---
956
-
957
- ##### `stateMachineRoleName`<sup>Required</sup> <a name="stateMachineRoleName" id="@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.stateMachineRoleName"></a>
958
-
959
- ```typescript
960
- public readonly stateMachineRoleName: string;
961
- ```
962
-
963
- - *Type:* string
964
-
965
- ---
966
-
967
- ##### `stopScheduleName`<sup>Required</sup> <a name="stopScheduleName" id="@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.stopScheduleName"></a>
968
-
969
- ```typescript
970
- public readonly stopScheduleName: string;
971
- ```
972
-
973
- - *Type:* string
974
-
975
- ---
976
-
977
- ##### `type`<sup>Required</sup> <a name="type" id="@gammarers/aws-rds-database-running-schedule-stack.CustomNaming.property.type"></a>
978
-
979
- ```typescript
980
- public readonly type: ResourceNamingType;
981
- ```
982
-
983
- - *Type:* @gammarers/aws-resource-naming.ResourceNamingType
984
-
985
- ---
986
-
987
882
  ### NotificationsProperty <a name="NotificationsProperty" id="@gammarers/aws-rds-database-running-schedule-stack.NotificationsProperty"></a>
988
883
 
989
884
  #### Initializer <a name="Initializer" id="@gammarers/aws-rds-database-running-schedule-stack.NotificationsProperty.Initializer"></a>
@@ -999,6 +894,7 @@ const notificationsProperty: NotificationsProperty = { ... }
999
894
  | **Name** | **Type** | **Description** |
1000
895
  | --- | --- | --- |
1001
896
  | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.NotificationsProperty.property.emails">emails</a></code> | <code>string[]</code> | *No description.* |
897
+ | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.NotificationsProperty.property.slack">slack</a></code> | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.Slack">Slack</a></code> | *No description.* |
1002
898
 
1003
899
  ---
1004
900
 
@@ -1012,6 +908,16 @@ public readonly emails: string[];
1012
908
 
1013
909
  ---
1014
910
 
911
+ ##### `slack`<sup>Optional</sup> <a name="slack" id="@gammarers/aws-rds-database-running-schedule-stack.NotificationsProperty.property.slack"></a>
912
+
913
+ ```typescript
914
+ public readonly slack: Slack;
915
+ ```
916
+
917
+ - *Type:* <a href="#@gammarers/aws-rds-database-running-schedule-stack.Slack">Slack</a>
918
+
919
+ ---
920
+
1015
921
  ### RDSDatabaseRunningScheduleStackProps <a name="RDSDatabaseRunningScheduleStackProps" id="@gammarers/aws-rds-database-running-schedule-stack.RDSDatabaseRunningScheduleStackProps"></a>
1016
922
 
1017
923
  #### Initializer <a name="Initializer" id="@gammarers/aws-rds-database-running-schedule-stack.RDSDatabaseRunningScheduleStackProps.Initializer"></a>
@@ -1039,7 +945,7 @@ const rDSDatabaseRunningScheduleStackProps: RDSDatabaseRunningScheduleStackProps
1039
945
  | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.RDSDatabaseRunningScheduleStackProps.property.targetResource">targetResource</a></code> | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.TargetResourceProperty">TargetResourceProperty</a></code> | *No description.* |
1040
946
  | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.RDSDatabaseRunningScheduleStackProps.property.enableScheduling">enableScheduling</a></code> | <code>boolean</code> | *No description.* |
1041
947
  | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.RDSDatabaseRunningScheduleStackProps.property.notifications">notifications</a></code> | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.NotificationsProperty">NotificationsProperty</a></code> | *No description.* |
1042
- | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.RDSDatabaseRunningScheduleStackProps.property.resourceNamingOption">resourceNamingOption</a></code> | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.CustomNaming">CustomNaming</a> \| @gammarers/aws-resource-naming.ResourceDefaultNaming \| @gammarers/aws-resource-naming.ResourceAutoNaming</code> | *No description.* |
948
+ | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.RDSDatabaseRunningScheduleStackProps.property.resourceNamingOption">resourceNamingOption</a></code> | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming">ResourceCustomNaming</a> \| @gammarers/aws-resource-naming.ResourceDefaultNaming \| @gammarers/aws-resource-naming.ResourceAutoNaming</code> | *No description.* |
1043
949
  | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.RDSDatabaseRunningScheduleStackProps.property.startSchedule">startSchedule</a></code> | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.ScheduleProperty">ScheduleProperty</a></code> | *No description.* |
1044
950
  | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.RDSDatabaseRunningScheduleStackProps.property.stopSchedule">stopSchedule</a></code> | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.ScheduleProperty">ScheduleProperty</a></code> | *No description.* |
1045
951
 
@@ -1288,10 +1194,10 @@ public readonly notifications: NotificationsProperty;
1288
1194
  ##### `resourceNamingOption`<sup>Optional</sup> <a name="resourceNamingOption" id="@gammarers/aws-rds-database-running-schedule-stack.RDSDatabaseRunningScheduleStackProps.property.resourceNamingOption"></a>
1289
1195
 
1290
1196
  ```typescript
1291
- public readonly resourceNamingOption: CustomNaming | ResourceDefaultNaming | ResourceAutoNaming;
1197
+ public readonly resourceNamingOption: ResourceCustomNaming | ResourceDefaultNaming | ResourceAutoNaming;
1292
1198
  ```
1293
1199
 
1294
- - *Type:* <a href="#@gammarers/aws-rds-database-running-schedule-stack.CustomNaming">CustomNaming</a> | @gammarers/aws-resource-naming.ResourceDefaultNaming | @gammarers/aws-resource-naming.ResourceAutoNaming
1200
+ - *Type:* <a href="#@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming">ResourceCustomNaming</a> | @gammarers/aws-resource-naming.ResourceDefaultNaming | @gammarers/aws-resource-naming.ResourceAutoNaming
1295
1201
 
1296
1202
  ---
1297
1203
 
@@ -1315,6 +1221,111 @@ public readonly stopSchedule: ScheduleProperty;
1315
1221
 
1316
1222
  ---
1317
1223
 
1224
+ ### ResourceCustomNaming <a name="ResourceCustomNaming" id="@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming"></a>
1225
+
1226
+ #### Initializer <a name="Initializer" id="@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.Initializer"></a>
1227
+
1228
+ ```typescript
1229
+ import { ResourceCustomNaming } from '@gammarers/aws-rds-database-running-schedule-stack'
1230
+
1231
+ const resourceCustomNaming: ResourceCustomNaming = { ... }
1232
+ ```
1233
+
1234
+ #### Properties <a name="Properties" id="Properties"></a>
1235
+
1236
+ | **Name** | **Type** | **Description** |
1237
+ | --- | --- | --- |
1238
+ | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.notificationTopicDisplayName">notificationTopicDisplayName</a></code> | <code>string</code> | *No description.* |
1239
+ | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.notificationTopicName">notificationTopicName</a></code> | <code>string</code> | *No description.* |
1240
+ | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.schedulerRoleName">schedulerRoleName</a></code> | <code>string</code> | *No description.* |
1241
+ | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.startScheduleName">startScheduleName</a></code> | <code>string</code> | *No description.* |
1242
+ | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.stateMachineName">stateMachineName</a></code> | <code>string</code> | *No description.* |
1243
+ | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.stateMachineRoleName">stateMachineRoleName</a></code> | <code>string</code> | *No description.* |
1244
+ | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.stopScheduleName">stopScheduleName</a></code> | <code>string</code> | *No description.* |
1245
+ | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.type">type</a></code> | <code>@gammarers/aws-resource-naming.ResourceNamingType</code> | *No description.* |
1246
+
1247
+ ---
1248
+
1249
+ ##### `notificationTopicDisplayName`<sup>Required</sup> <a name="notificationTopicDisplayName" id="@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.notificationTopicDisplayName"></a>
1250
+
1251
+ ```typescript
1252
+ public readonly notificationTopicDisplayName: string;
1253
+ ```
1254
+
1255
+ - *Type:* string
1256
+
1257
+ ---
1258
+
1259
+ ##### `notificationTopicName`<sup>Required</sup> <a name="notificationTopicName" id="@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.notificationTopicName"></a>
1260
+
1261
+ ```typescript
1262
+ public readonly notificationTopicName: string;
1263
+ ```
1264
+
1265
+ - *Type:* string
1266
+
1267
+ ---
1268
+
1269
+ ##### `schedulerRoleName`<sup>Required</sup> <a name="schedulerRoleName" id="@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.schedulerRoleName"></a>
1270
+
1271
+ ```typescript
1272
+ public readonly schedulerRoleName: string;
1273
+ ```
1274
+
1275
+ - *Type:* string
1276
+
1277
+ ---
1278
+
1279
+ ##### `startScheduleName`<sup>Required</sup> <a name="startScheduleName" id="@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.startScheduleName"></a>
1280
+
1281
+ ```typescript
1282
+ public readonly startScheduleName: string;
1283
+ ```
1284
+
1285
+ - *Type:* string
1286
+
1287
+ ---
1288
+
1289
+ ##### `stateMachineName`<sup>Required</sup> <a name="stateMachineName" id="@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.stateMachineName"></a>
1290
+
1291
+ ```typescript
1292
+ public readonly stateMachineName: string;
1293
+ ```
1294
+
1295
+ - *Type:* string
1296
+
1297
+ ---
1298
+
1299
+ ##### `stateMachineRoleName`<sup>Required</sup> <a name="stateMachineRoleName" id="@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.stateMachineRoleName"></a>
1300
+
1301
+ ```typescript
1302
+ public readonly stateMachineRoleName: string;
1303
+ ```
1304
+
1305
+ - *Type:* string
1306
+
1307
+ ---
1308
+
1309
+ ##### `stopScheduleName`<sup>Required</sup> <a name="stopScheduleName" id="@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.stopScheduleName"></a>
1310
+
1311
+ ```typescript
1312
+ public readonly stopScheduleName: string;
1313
+ ```
1314
+
1315
+ - *Type:* string
1316
+
1317
+ ---
1318
+
1319
+ ##### `type`<sup>Required</sup> <a name="type" id="@gammarers/aws-rds-database-running-schedule-stack.ResourceCustomNaming.property.type"></a>
1320
+
1321
+ ```typescript
1322
+ public readonly type: ResourceNamingType;
1323
+ ```
1324
+
1325
+ - *Type:* @gammarers/aws-resource-naming.ResourceNamingType
1326
+
1327
+ ---
1328
+
1318
1329
  ### ScheduleProperty <a name="ScheduleProperty" id="@gammarers/aws-rds-database-running-schedule-stack.ScheduleProperty"></a>
1319
1330
 
1320
1331
  #### Initializer <a name="Initializer" id="@gammarers/aws-rds-database-running-schedule-stack.ScheduleProperty.Initializer"></a>
@@ -1376,6 +1387,34 @@ public readonly week: string;
1376
1387
 
1377
1388
  ---
1378
1389
 
1390
+ ### Slack <a name="Slack" id="@gammarers/aws-rds-database-running-schedule-stack.Slack"></a>
1391
+
1392
+ #### Initializer <a name="Initializer" id="@gammarers/aws-rds-database-running-schedule-stack.Slack.Initializer"></a>
1393
+
1394
+ ```typescript
1395
+ import { Slack } from '@gammarers/aws-rds-database-running-schedule-stack'
1396
+
1397
+ const slack: Slack = { ... }
1398
+ ```
1399
+
1400
+ #### Properties <a name="Properties" id="Properties"></a>
1401
+
1402
+ | **Name** | **Type** | **Description** |
1403
+ | --- | --- | --- |
1404
+ | <code><a href="#@gammarers/aws-rds-database-running-schedule-stack.Slack.property.webhookSecretName">webhookSecretName</a></code> | <code>string</code> | *No description.* |
1405
+
1406
+ ---
1407
+
1408
+ ##### `webhookSecretName`<sup>Required</sup> <a name="webhookSecretName" id="@gammarers/aws-rds-database-running-schedule-stack.Slack.property.webhookSecretName"></a>
1409
+
1410
+ ```typescript
1411
+ public readonly webhookSecretName: string;
1412
+ ```
1413
+
1414
+ - *Type:* string
1415
+
1416
+ ---
1417
+
1379
1418
  ### TargetResourceProperty <a name="TargetResourceProperty" id="@gammarers/aws-rds-database-running-schedule-stack.TargetResourceProperty"></a>
1380
1419
 
1381
1420
  #### Initializer <a name="Initializer" id="@gammarers/aws-rds-database-running-schedule-stack.TargetResourceProperty.Initializer"></a>
package/lib/index.d.ts CHANGED
@@ -2,7 +2,7 @@ import { ResourceAutoNaming, ResourceDefaultNaming, ResourceNamingType } from '@
2
2
  import { Stack, StackProps } from 'aws-cdk-lib';
3
3
  import { Construct } from 'constructs';
4
4
  export { ResourceAutoNaming, ResourceDefaultNaming, ResourceNamingType };
5
- export interface CustomNaming {
5
+ export interface ResourceCustomNaming {
6
6
  readonly type: ResourceNamingType.CUSTOM;
7
7
  readonly notificationTopicName: string;
8
8
  readonly notificationTopicDisplayName: string;
@@ -12,7 +12,7 @@ export interface CustomNaming {
12
12
  readonly startScheduleName: string;
13
13
  readonly stopScheduleName: string;
14
14
  }
15
- export type ResourceNamingOption = ResourceDefaultNaming | ResourceAutoNaming | CustomNaming;
15
+ export type ResourceNamingOption = ResourceDefaultNaming | ResourceAutoNaming | ResourceCustomNaming;
16
16
  export interface ScheduleProperty {
17
17
  readonly timezone: string;
18
18
  readonly minute?: string;
@@ -23,8 +23,12 @@ export interface TargetResourceProperty {
23
23
  readonly tagKey: string;
24
24
  readonly tagValues: string[];
25
25
  }
26
+ export interface Slack {
27
+ readonly webhookSecretName: string;
28
+ }
26
29
  export interface NotificationsProperty {
27
30
  readonly emails?: string[];
31
+ readonly slack?: Slack;
28
32
  }
29
33
  export interface RDSDatabaseRunningScheduleStackProps extends StackProps {
30
34
  readonly targetResource: TargetResourceProperty;