@ndlib/ndlib-cdk2 1.0.15 → 1.0.17

package/README.md

@@ -89,6 +89,36 @@ const notifications = new PipelineNotifications(stack, 'TestPipelineNotification
 })
 ```
 
+
+## CodePipeline Slack Status Notifications
+
+Adds a slack notification construct to watch a CodePipeline for state changes. Note: Currently does not watch any of the actions for specific state changes.
+
+Example message:
+
+> Pipeline [example-pipeline-deployment-DeploymentPipelineEDAF206A-19MVGYZ0MIPPR](https://us-east-1.console.aws.amazon.com/codepipeline/home?region=us-east-1#/view/example-pipeline-deployment-DeploymentPipelineEDAF206A-19MVGYZ0MIPPR)just SUCCEEDED.
+
+Example usage:
+
+```typescript
+import cdk = require('aws-cdk-lib/core')
+import { Pipeline } from 'aws-cdk-lib/aws-codepipeline'
+import { SlackPipelineStatusNotifications } from '@ndlib/ndlib-cdk2'
+const stack = new cdk.Stack()
+const pipeline = Pipeline(stack, { ... })
+
+if(props.slackChannelId){
+  new SlackPipelineStatusNotifications(this, 'SlackPipelineStatusNotifications', {
+    pipeline,
+    // messageText: 'example of additional message text', // optional
+    slackChannelId: props.slackChannelId,
+    slackChannelName: props.slackChannelName,
+    // slackNotifyTopicArn: 'some valid topic arn', // optional, defaults to: Fn.importValue('slack-pipeline-status-notify:TopicArn')
+  })
+}
+```
+
+
 ## Service Level Objectives
 
 Creates Cloudwatch Dashboards and Alarms from a list of SLOs based on the Google SRE workbook for [Alerting on SLOs](https://landing.google.com/sre/workbook/chapters/alerting-on-slos/)

package/lib/index.d.ts

@@ -1,18 +1,19 @@
-export * from './stack-tags';
-export * from './https-alb';
 export * from './archive-bucket';
-export * from './pipeline-notifications';
-export * from './slos/alarms';
-export * from './slos/alarms-dashboard';
-export * from './slos/performance-dashboard';
-export * from './ec2s/ec2-with-database';
 export * from './artifact-bucket';
+export * from './dashboards';
 export * from './docker-codebuild-action';
+export * from './ec2s/ec2-with-database';
 export * from './edge-lambdas';
+export * from './https-alb';
+export * from './metrics';
 export * from './newman-runner';
-export * from './static-host';
+export * from './pipeline-notifications';
 export * from './pipeline-s3-sync';
-export * from './source-watcher';
-export * from './dashboards';
-export * from './metrics';
 export * from './slack-integration';
+export * from './slack-pipeline-status-notifications';
+export * from './slos/alarms';
+export * from './slos/alarms-dashboard';
+export * from './slos/performance-dashboard';
+export * from './source-watcher';
+export * from './stack-tags';
+export * from './static-host';

package/lib/index.js

@@ -14,21 +14,22 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./stack-tags"), exports);
-__exportStar(require("./https-alb"), exports);
 __exportStar(require("./archive-bucket"), exports);
-__exportStar(require("./pipeline-notifications"), exports);
-__exportStar(require("./slos/alarms"), exports);
-__exportStar(require("./slos/alarms-dashboard"), exports);
-__exportStar(require("./slos/performance-dashboard"), exports);
-__exportStar(require("./ec2s/ec2-with-database"), exports);
 __exportStar(require("./artifact-bucket"), exports);
+__exportStar(require("./dashboards"), exports);
 __exportStar(require("./docker-codebuild-action"), exports);
+__exportStar(require("./ec2s/ec2-with-database"), exports);
 __exportStar(require("./edge-lambdas"), exports);
+__exportStar(require("./https-alb"), exports);
+__exportStar(require("./metrics"), exports);
 __exportStar(require("./newman-runner"), exports);
-__exportStar(require("./static-host"), exports);
+__exportStar(require("./pipeline-notifications"), exports);
 __exportStar(require("./pipeline-s3-sync"), exports);
-__exportStar(require("./source-watcher"), exports);
-__exportStar(require("./dashboards"), exports);
-__exportStar(require("./metrics"), exports);
 __exportStar(require("./slack-integration"), exports);
+__exportStar(require("./slack-pipeline-status-notifications"), exports);
+__exportStar(require("./slos/alarms"), exports);
+__exportStar(require("./slos/alarms-dashboard"), exports);
+__exportStar(require("./slos/performance-dashboard"), exports);
+__exportStar(require("./source-watcher"), exports);
+__exportStar(require("./stack-tags"), exports);
+__exportStar(require("./static-host"), exports);

package/lib/slack-pipeline-status-notifications.d.ts

@@ -0,0 +1,21 @@
+import { aws_codepipeline, StackProps } from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+export interface ISlackPipelineStatusNotificationsProps extends StackProps {
+    readonly pipeline: aws_codepipeline.Pipeline;
+    readonly messageText?: string;
+    readonly slackChannelId: string;
+    readonly slackChannelName?: string;
+    readonly slackNotifyTopicArn?: string;
+}
+export interface ISlackPipelineStatusNotificationsData {
+    eventInfo: string;
+    messageText?: string;
+    pipelineName: string;
+    pipelineState: string;
+    pipelineUrl: string;
+    slackChannelId: string;
+    slackChannelName?: string;
+}
+export declare class SlackPipelineStatusNotifications extends Construct {
+    constructor(scope: Construct, id: string, props: ISlackPipelineStatusNotificationsProps);
+}

package/lib/slack-pipeline-status-notifications.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SlackPipelineStatusNotifications = void 0;
+const aws_cdk_lib_1 = require("aws-cdk-lib");
+const aws_sns_1 = require("aws-cdk-lib/aws-sns");
+const constructs_1 = require("constructs");
+class SlackPipelineStatusNotifications extends constructs_1.Construct {
+    constructor(scope, id, props) {
+        super(scope, id);
+        const eventInfo = aws_cdk_lib_1.aws_events.EventField.fromPath('$');
+        const pipelineName = aws_cdk_lib_1.aws_events.EventField.fromPath('$.detail.pipeline');
+        const pipelineState = aws_cdk_lib_1.aws_events.EventField.fromPath('$.detail.state');
+        const pipelineBaseUrl = aws_cdk_lib_1.Fn.sub('https://${AWS::Region}.console.aws.amazon.com/codepipeline/home?region=${AWS::Region}#/view/');
+        // eslint-disable-next-line max-len
+        const testStackApprovalTopic = aws_sns_1.Topic.fromTopicArn(this, 'SlackTopicFromArn', props.slackNotifyTopicArn || aws_cdk_lib_1.Fn.importValue('slack-pipeline-status-notify:TopicArn'));
+        const SlackPipelineStatusNotificationsData = {
+            eventInfo: eventInfo,
+            messageText: props.messageText,
+            pipelineName: pipelineName,
+            pipelineState: pipelineState,
+            pipelineUrl: pipelineBaseUrl + pipelineName,
+            slackChannelId: props.slackChannelId,
+            slackChannelName: props.slackChannelName,
+        };
+        const message = aws_cdk_lib_1.aws_events.RuleTargetInput.fromObject(SlackPipelineStatusNotificationsData);
+        const target = new aws_cdk_lib_1.aws_events_targets.SnsTopic(testStackApprovalTopic, { message });
+        props.pipeline.onStateChange('OnPipelineStateChange', { target });
+    }
+}
+exports.SlackPipelineStatusNotifications = SlackPipelineStatusNotifications;

package/lib/static-host/static-host.js

@@ -104,7 +104,7 @@ class StaticHost extends constructs_1.Construct {
             ],
             viewerCertificate: aws_cdk_lib_1.aws_cloudfront.ViewerCertificate.fromAcmCertificate(props.websiteCertificate, {
                 aliases: [this.hostname],
-                securityPolicy: aws_cdk_lib_1.aws_cloudfront.SecurityPolicyProtocol.TLS_V1_1_2016,
+                securityPolicy: aws_cdk_lib_1.aws_cloudfront.SecurityPolicyProtocol.TLS_V1_2_2021,
                 sslMethod: aws_cdk_lib_1.aws_cloudfront.SSLMethod.SNI,
             }),
             viewerProtocolPolicy: aws_cdk_lib_1.aws_cloudfront.ViewerProtocolPolicy.REDIRECT_TO_HTTPS,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ndlib/ndlib-cdk2",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "description": "Reusable CDK2 modules used within Hesburgh Libraries of Notre Dame",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -40,35 +40,35 @@
     "aws-cdk-lib": "^2.88.0"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.3",
-    "@types/node": "^18.16.19",
-    "@typescript-eslint/eslint-plugin": "^6.1.0",
-    "@typescript-eslint/parser": "^6.1.0",
+    "@types/jest": "^29.5.4",
+    "@types/node": "^18.17.0",
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@typescript-eslint/parser": "^6.6.0",
     "aws-sdk-client-mock": "^3.0.0",
-    "eslint": "^8.45.0",
+    "eslint": "^8.48.0",
     "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-jest": "^27.2.3",
-    "eslint-plugin-n": "^16.0.1",
+    "eslint-plugin-n": "^16.0.2",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-standard": "^5.0.0",
     "github-changes": "^2.0.3",
-    "jest": "^29.6.1",
-    "jest-mock": "^29.6.1",
-    "prettier": "^3.0.0",
+    "jest": "^29.6.4",
+    "jest-mock": "^29.6.3",
+    "prettier": "^3.0.3",
     "subpackage": "^1.1.0",
     "ts-jest": "^29.1.1",
     "tsc-watch": "^6.0.4",
-    "typescript": "^5.1.6"
+    "typescript": "^5.2.2"
   },
   "files": [
     "lib/**/*"
   ],
   "dependencies": {
-    "aws-cdk-lib": "^2.88.0",
-    "constructs": "^10.2.69",
-    "node-fetch": "^3.3.1"
+    "aws-cdk-lib": "^2.94.0",
+    "constructs": "^10.2.70",
+    "node-fetch": "^3.3.2"
   },
   "subPackages": [
     "src/internal-lambdas/sourceWatcherLambda/src"