@aws-cdk/aws-events

AWS CloudWatch Events Construct Library

Amazon CloudWatch Events delivers a near real-time stream of system events that describe changes in AWS resources. For example, an AWS CodePipeline emits the State Change event when the pipeline changes it's state.

• Events: An event indicates a change in your AWS environment. AWS resources can generate events when their state changes. For example, Amazon EC2 generates an event when the state of an EC2 instance changes from pending to running, and Amazon EC2 Auto Scaling generates events when it launches or terminates instances. AWS CloudTrail publishes events when you make API calls. You can generate custom application-level events and publish them to CloudWatch Events. You can also set up scheduled events that are generated on a periodic basis. For a list of services that generate events, and sample events from each service, see CloudWatch Events Event Examples From Each Supported Service.
• Targets: A target processes events. Targets can include Amazon EC2 instances, AWS Lambda functions, Kinesis streams, Amazon ECS tasks, Step Functions state machines, Amazon SNS topics, Amazon SQS queues, and built-in targets. A target receives events in JSON format.
• Rules: A rule matches incoming events and routes them to targets for processing. A single rule can route to multiple targets, all of which are processed in parallel. Rules are not processed in a particular order. This enables different parts of an organization to look for and process the events that are of interest to them. A rule can customize the JSON sent to the target, by passing only certain parts or by overwriting it with a constant.

The EventRule construct defines a CloudWatch events rule which monitors an event based on an event pattern and invoke event targets when the pattern is matched against a triggered event. Event targets are objects that implement the IEventTarget interface.

Normally, you will use one of the source.onXxx(name[, target[, options]]) -> EventRule methods on the event source to define an event rule associated with the specific activity. You can targets either via props, or add targets using rule.addTarget.

For example, to define an rule that triggers a CodeBuild project build when a commit is pushed to the "master" branch of a CodeCommit repository:

const onCommitRule = repo.onCommit('OnCommitToMaster', project, 'master');

You can add additional targets, with optional input transformer using eventRule.addTarget(target[, input]). For example, we can add a SNS topic target which formats a human-readable message for the commit.

For example, this adds an SNS topic as a target:

onCommitRule.addTarget(topic, {
    template: 'A commit was pushed to the repository <repo> on branch <branch>',
    pathsMap: {
        branch: '$.detail.referenceName',
        repo: '$.detail.repositoryName'
    }
});

Changelog

0.23.0 (2019-02-04)

Bug Fixes

• apig: Move selectionPattern to integrationResponses (#1636) (7cdbcec), closes #1608
• aws-cdk: Improvements to IAM diff rendering (#1542) (3270b47), closes #1458 #1495 #1549
• aws-cdk: Java init template works on Windows (#1503) (24f521a)
• sns: create subscription object under subscriber (5c4a9e5), closes #1643 #1534
• Improve error message in SSMParameterProvider (#1630) (6a8e010), closes #1621
• aws-ec2: CfnNetworkAclEntry.CidrBlock should be optional (#1565) (4af7c0d), closes #1517
• aws-ec2: change maxAZs default for VPCs to 3 (#1543) (32a4b29), closes #996
• aws-events: ergonomics improvements to CloudWatch Events (#1570) (5e91a0a), closes #1514 #1198 #1275
• aws-s3-deployment: clean up tempfiles after deployment (#1367) (e291d37)
• dynamodb: grant also gives access to indexes (#1564) (33c2a6d), closes #1540
• Report stack metadata in assertions (#1547) (c2d17f5)

Features

• alexa-ask: Add deploy action for Alexa (#1613) (0deea61)
• apigateway: support function alias in LambdaIntegration (9f8bfa5)
• app: add source map support to TS app template (#1581) (5df22d9), closes #1579
• autoscaling: Support AssociatePublicIpAddress (#1604) (23c9afc), closes #1603
• aws-codepipeline: support setting a Role for a CFN Action (#1449) (77fe077)
• aws-ecs: add additional configuration to Volume (#1357) (ff96f3f)
• aws-ecs: add support for Event Targets (#1571) (aa68db5), closes #1370
• aws-ecs: ECS service scaling on ALB RequestCount (#1574) (2b491d4)
• aws-s3: add the option to not poll to the CodePipeline Action. (#1260) (876b26d)
• cdk: Support UpdateReplacePolicy on Resources (#1610) (f49c33b)
• cdk: treat the "fake" CFN intrinsics (Fn::GetArtifactAtt, Fn::GetParam) specially when stringifying JSON. (#1605) (2af2426), closes #1588
• cfnspec: Upgrade to CFN Resource Specification v2.21.0 (#1622) (21a5529)
• cloudwatch: Support 'datapointsToAlarm' on Alarms (#1631) (828ac20), closes #1626
• core: Generalization of dependencies (#1583) (53e68257)
• ecs: environment variables for LoadBalancedXxxService (#1537) (b633505)
• ecs: VPC link for API Gatweay and ECS services (#1541) (6642ca2)
• iam: Make roleName available on IRole (#1589) (9128390)
• lambda: reserved concurrent executions (#1560) (f7469c1)
• lambda: Support AWS Lambda Layers (#1411) (036cfdf)
• s3: Add DeployAction for codepipeline (#1596) (8f1a5e8)
• s3: export bucket websiteURL (#1521) (#1544) (4e46d3c)
• s3: imported bucket format option for website URL format (#1550) (28a423d)
• toolkit: disable colors if a terminal is not attached to stdout (#1641) (58b4685)

BREAKING CHANGES TO EXPERIMENTAL FEATURES

• aws-codepipeline: the role property in the CloudFormation Actions has been renamed to deploymentRole.
• aws-codepipeline: the role property in the app-delivery package has been renamed to deploymentRole.