Merge pull request #1204 from awslabs/bump/2.70.0

chore(release): 2.70.0
awslabs · Sep 18, 2024 · c8d3738 · c8d3738
2 parents 636e41d + ed36807
commit c8d3738
Show file tree

Hide file tree

Showing 26 changed files with 648 additions and 119 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.70.0](https://github.com/awslabs/aws-solutions-constructs/compare/v2.69.0...v2.70.0) (2024-09-18)
+
+Built on CDK v2.154.1
+
+### Features
+
+* **aws-constructs-factories:** add cloudwatch alarms to factory output ([#1201](https://github.com/awslabs/aws-solutions-constructs/issues/1201)) ([5e49430](https://github.com/awslabs/aws-solutions-constructs/commit/5e49430c88a6e8a403fd0f35028d1619d03df8ed))
+
 ## [2.69.0](https://github.com/awslabs/aws-solutions-constructs/compare/v2.68.0...v2.69.0) (2024-09-11)
 
 Built on CDK v2.154.1

diff --git a/source/lerna.json b/source/lerna.json
@@ -6,5 +6,5 @@
     "./patterns/@aws-solutions-constructs/*"
   ],
   "rejectCycles": "true",
-  "version": "2.69.0"
+  "version": "2.70.0"
 }
diff --git a/source/patterns/@aws-solutions-constructs/aws-constructs-factories/README.md b/source/patterns/@aws-solutions-constructs/aws-constructs-factories/README.md
@@ -171,13 +171,16 @@ stateMachineFactory(id: string, props: StateMachineFactoryProps): StateMachineFa
 |:-------------|:----------------|-----------------|
 |stateMachineProps|[`sfn.StateMachineProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachineProps.html)|The CDK properties that define the state machine. This property is required and must include a definitionBody or definition (definition is deprecated)|
 |logGroup?|[]`logs.LogGroup`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroup.html)|An existing LogGroup to which the new state machine will write log entries. Default: none, the construct will create a new log group.|
+|createCloudWatchAlarms?|boolean|Whether to create recommended CloudWatch alarms for the State Machine. Default: the alarms are created|
+|cloudWatchAlarmsPrefix?|string|Creating multiple State Machines with one Factories construct will result in name collisions as the cloudwatch alarms originally had fixed resource ids. This value was added to avoid collisions while not making changes that would be destructive for existing stacks. Unless you are creating multiple State Machines using factories you can ignore it|
 
 # StateMachineFactoryResponse
 
 | **Name**     | **Type**        | **Description** |
 |:-------------|:----------------|-----------------|
 |stateMachineProps|[`sfn.StateMachineProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachineProps.html)||
 |logGroup|[]`logs.LogGroupProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroupProps.html)||
+|cloudwatchAlarms?|[`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html)|The alarms created by the factory (ExecutionFailed, ExecutionThrottled, ExecutionAborted)|
 
 # Default settings
 
@@ -187,6 +190,10 @@ Out of the box implementation of the Construct without any override will set the
   * Configured to log to the new log group at LogLevel.ERROR
 * Amazon CloudWatch Logs Log Group
   * Log name is prefaced with /aws/vendedlogs/ to avoid resource policy [issues](https://docs.aws.amazon.com/step-functions/latest/dg/cw-logs.html#cloudwatch-iam-policy). The Log Group name is still created to be unique to the stack to avoid name collisions. 
+* CloudWatch alarms for:
+  * 1 or more failed executions
+  * 1 or more executions being throttled
+  * 1 or more executions being aborted
 
 # Architecture
 ![Architecture Diagram](sf-architecture.png)

diff --git a/source/patterns/@aws-solutions-constructs/aws-constructs-factories/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-constructs-factories/lib/index.ts
@@ -19,6 +19,7 @@ import * as sqs from 'aws-cdk-lib/aws-sqs';
 import * as kms from 'aws-cdk-lib/aws-kms';
 import * as logs from 'aws-cdk-lib/aws-logs';
 import * as defaults from '@aws-solutions-constructs/core';
+import * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';
 
 export interface S3BucketFactoryProps {
   readonly bucketProps?: s3.BucketProps | any,
@@ -44,6 +45,22 @@ export interface StateMachineFactoryProps {
    * Default: none, the construct will create a new log group.
    */
   readonly logGroupProps?: logs.LogGroupProps
+  /**
+   * Whether to create recommended CloudWatch alarms
+   *
+   * @default - Alarms are created
+   */
+  readonly createCloudWatchAlarms?: boolean,
+  /**
+   * Creating multiple State Machines in 1 stack with constructs will
+   * result in name collisions as the cloudwatch alarms originally had fixed resource ids.
+   * This value was added to avoid collisions while not making changes that would be
+   * destructive for existing stacks. Unless you are creating multiple State Machines using constructs
+   * you can ignore it.
+   *
+   * @default - undefined
+   */
+  readonly cloudWatchAlarmsPrefix?: string
 }
 
 // Create a response specifically for the interface to avoid coupling client with internal implementation
@@ -57,6 +74,10 @@ export interface StateMachineFactoryResponse {
    * The log group that will receive log messages from the state maching
    */
   readonly logGroup: logs.ILogGroup
+  /*
+   * The alarms created by the factory (ExecutionFailed, ExecutionThrottled, ExecutionAborted)
+   */
+  readonly cloudwatchAlarms?: cloudwatch.Alarm[];
 }
 
 export interface SqsQueueFactoryProps {
@@ -135,10 +156,16 @@ export class ConstructsFactories extends Construct {
   }
 
   public stateMachineFactory(id: string, props: StateMachineFactoryProps): StateMachineFactoryResponse {
-    const buildStateMachineResponse = defaults.buildStateMachine(this, id, props.stateMachineProps, props.logGroupProps);
+    const buildStateMachineResponse = defaults.buildStateMachine(this, id, {
+      stateMachineProps: props.stateMachineProps,
+      logGroupProps: props.logGroupProps,
+      createCloudWatchAlarms: props.createCloudWatchAlarms,
+      cloudWatchAlarmsPrefix: props.cloudWatchAlarmsPrefix
+    });
     return {
       stateMachine: buildStateMachineResponse.stateMachine,
-      logGroup: buildStateMachineResponse.logGroup
+      logGroup: buildStateMachineResponse.logGroup,
+      cloudwatchAlarms: buildStateMachineResponse.cloudWatchAlarms
     };
   }
 

diff --git a/...patterns/@aws-solutions-constructs/aws-constructs-factories/sf-architecture.png b/...patterns/@aws-solutions-constructs/aws-constructs-factories/sf-architecture.png
diff --git a/...cts/aws-constructs-factories/test/stepfunctions/integ.facstp-defaults.js.snapshot/cdk.out b/...cts/aws-constructs-factories/test/stepfunctions/integ.facstp-defaults.js.snapshot/cdk.out
@@ -1 +1 @@
-{"version":"36.0.0"}
+{"version":"36.0.25"}
diff --git a/...actories/test/stepfunctions/integ.facstp-defaults.js.snapshot/facstp-defaults.assets.json b/...actories/test/stepfunctions/integ.facstp-defaults.js.snapshot/facstp-defaults.assets.json
@@ -1,15 +1,15 @@
 {
-  "version": "36.0.0",
+  "version": "36.0.25",
   "files": {
-    "c7ecd4e8eaccb1e7f7416826559ce7fa1c58bb3a5fb8298e571ac6695d1d50b7": {
+    "c609c27e6e7fc30d831454d0ca67932fbbb0f7d66f09883e3fc1e4a0afe294b6": {
       "source": {
         "path": "facstp-defaults.template.json",
         "packaging": "file"
       },
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "c7ecd4e8eaccb1e7f7416826559ce7fa1c58bb3a5fb8298e571ac6695d1d50b7.json",
+          "objectKey": "c609c27e6e7fc30d831454d0ca67932fbbb0f7d66f09883e3fc1e4a0afe294b6.json",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }

diff --git a/...tories/test/stepfunctions/integ.facstp-defaults.js.snapshot/facstp-defaults.template.json b/...tories/test/stepfunctions/integ.facstp-defaults.js.snapshot/facstp-defaults.template.json
@@ -176,6 +176,69 @@
    "UpdateReplacePolicy": "Delete",
    "DeletionPolicy": "Delete"
   },
+  "targetExecutionFailedAlarm97DD1630": {
+   "Type": "AWS::CloudWatch::Alarm",
+   "Properties": {
+    "AlarmDescription": "Alarm for the number of executions that failed exceeded the threshold of 1. ",
+    "ComparisonOperator": "GreaterThanOrEqualToThreshold",
+    "Dimensions": [
+     {
+      "Name": "StateMachineArn",
+      "Value": {
+       "Ref": "targetStateMachinetestsm59897C57"
+      }
+     }
+    ],
+    "EvaluationPeriods": 1,
+    "MetricName": "ExecutionsFailed",
+    "Namespace": "AWS/States",
+    "Period": 300,
+    "Statistic": "Sum",
+    "Threshold": 1
+   }
+  },
+  "targetExecutionThrottledAlarmCAA85FD5": {
+   "Type": "AWS::CloudWatch::Alarm",
+   "Properties": {
+    "AlarmDescription": "Alarm for the number of executions that throttled exceeded the threshold of 1. ",
+    "ComparisonOperator": "GreaterThanOrEqualToThreshold",
+    "Dimensions": [
+     {
+      "Name": "StateMachineArn",
+      "Value": {
+       "Ref": "targetStateMachinetestsm59897C57"
+      }
+     }
+    ],
+    "EvaluationPeriods": 1,
+    "MetricName": "ExecutionThrottled",
+    "Namespace": "AWS/States",
+    "Period": 300,
+    "Statistic": "Sum",
+    "Threshold": 1
+   }
+  },
+  "targetExecutionAbortedAlarm70BA06C6": {
+   "Type": "AWS::CloudWatch::Alarm",
+   "Properties": {
+    "AlarmDescription": "Alarm for the number of executions that aborted exceeded the threshold of 1. ",
+    "ComparisonOperator": "GreaterThanOrEqualToThreshold",
+    "Dimensions": [
+     {
+      "Name": "StateMachineArn",
+      "Value": {
+       "Ref": "targetStateMachinetestsm59897C57"
+      }
+     }
+    ],
+    "EvaluationPeriods": 1,
+    "MetricName": "ExecutionsAborted",
+    "Namespace": "AWS/States",
+    "Period": 300,
+    "Statistic": "Maximum",
+    "Threshold": 1
+   }
+  },
   "lambdatestServiceRoleF3BDB8FC": {
    "Type": "AWS::IAM::Role",
    "Properties": {

diff --git a/...acstp-defaults.js.snapshot/facstpdefaultsIntegDefaultTestDeployAssertFD717592.assets.json b/...acstp-defaults.js.snapshot/facstpdefaultsIntegDefaultTestDeployAssertFD717592.assets.json
@@ -1,5 +1,5 @@
 {
-  "version": "36.0.0",
+  "version": "36.0.25",
   "files": {
     "21fbb51d7b23f6a6c262b46a9caee79d744a3ac019fd45422d988b96d44b2a22": {
       "source": {

diff --git a/.../aws-constructs-factories/test/stepfunctions/integ.facstp-defaults.js.snapshot/integ.json b/.../aws-constructs-factories/test/stepfunctions/integ.facstp-defaults.js.snapshot/integ.json
@@ -1,5 +1,5 @@
 {
-  "version": "36.0.0",
+  "version": "36.0.25",
   "testCases": {
     "facstp-defaults/Integ/DefaultTest": {
       "stacks": [

diff --git a/...s-constructs-factories/test/stepfunctions/integ.facstp-defaults.js.snapshot/manifest.json b/...s-constructs-factories/test/stepfunctions/integ.facstp-defaults.js.snapshot/manifest.json
@@ -1,5 +1,5 @@
 {
-  "version": "36.0.0",
+  "version": "36.0.24",
   "artifacts": {
     "facstpdefaultsIntegDefaultTestDeployAssertFD717592.assets": {
       "type": "cdk:asset-manifest",
@@ -66,7 +66,7 @@
         "validateOnSynth": false,
         "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-deploy-role-${AWS::AccountId}-${AWS::Region}",
         "cloudFormationExecutionRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-cfn-exec-role-${AWS::AccountId}-${AWS::Region}",
-        "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/c7ecd4e8eaccb1e7f7416826559ce7fa1c58bb3a5fb8298e571ac6695d1d50b7.json",
+        "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/c609c27e6e7fc30d831454d0ca67932fbbb0f7d66f09883e3fc1e4a0afe294b6.json",
         "requiresBootstrapStackVersion": 6,
         "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version",
         "additionalDependencies": [
@@ -106,6 +106,24 @@
             "data": "targetStateMachinetestsm59897C57"
           }
         ],
+        "/facstp-defaults/target/ExecutionFailedAlarm/Resource": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "targetExecutionFailedAlarm97DD1630"
+          }
+        ],
+        "/facstp-defaults/target/ExecutionThrottledAlarm/Resource": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "targetExecutionThrottledAlarmCAA85FD5"
+          }
+        ],
+        "/facstp-defaults/target/ExecutionAbortedAlarm/Resource": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "targetExecutionAbortedAlarm70BA06C6"
+          }
+        ],
         "/facstp-defaults/lambdatest/ServiceRole/Resource": [
           {
             "type": "aws:cdk:logicalId",