CDK Constructs for deploying AWS Events Rule that invokes AWS Step Function
Project description
aws-events-rule-step-function module
---All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
Reference Documentation: | https://docs.aws.amazon.com/solutions/latest/constructs/ |
---|
Language | Package |
---|---|
Python | aws_solutions_constructs.aws_events_rule_step_function |
Typescript | @aws-solutions-constructs/aws-events-rule-step-function |
Java | software.amazon.awsconstructs.services.eventsrulestepfunction |
This AWS Solutions Construct implements an AWS Events rule and an AWS Step function.
Here is a minimal deployable pattern definition in Typescript:
const { EventsRuleToStepFunction, EventsRuleToStepFunctionProps } from '@aws-solutions-constructs/aws-events-rule-step-function';
const startState = new stepfunctions.Pass(this, 'StartState');
const props: EventsRuleToStepFunctionProps = {
stateMachineProps: {
definition: startState
},
eventRuleProps: {
schedule: events.Schedule.rate(Duration.minutes(5))
}
};
new EventsRuleToStepFunction(stack, 'test-events-rule-step-function-stack', props);
Initializer
new EventsRuleToStepFunction(scope: Construct, id: string, props: EventsRuleToStepFunctionProps);
Parameters
- scope
Construct
- id
string
- props
EventsRuleToStepFunctionProps
Pattern Construct Props
Name | Type | Description |
---|---|---|
stateMachineProps | sfn.StateMachineProps |
Optional user provided props to override the default props for sfn.StateMachine |
eventRuleProps | events.RuleProps |
User provided eventRuleProps to override the defaults |
createCloudWatchAlarms | boolean |
Whether to create recommended CloudWatch alarms |
Pattern Properties
Name | Type | Description |
---|---|---|
eventsRule | events.Rule |
Returns an instance of events.Rule created by the construct |
stateMachine | sfn.StateMachine |
Returns an instance of sfn.StateMachine created by the construct |
stateMachineLogGroup | logs.LogGroup |
Returns an instance of the LogGroup created by the construct for StateMachine |
cloudwatchAlarms? | cloudwatch.Alarm[] |
Returns a list of cloudwatch.Alarm created by the construct |
Default settings
Out of the box implementation of the Construct without any override will set the following defaults:
Amazon CloudWatch Events Rule
- Grant least privilege permissions to CloudWatch Events to trigger the Lambda Function
AWS Step Function
- Enable CloudWatch logging for API Gateway
- Deploy best practices CloudWatch Alarms for the Step Function
Architecture
© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aws-solutions-constructs.aws-events-rule-step-function-1.75.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a2b0080a001b693b29a3e7e0114da132e07f3285d10029a784c698c19c4d642 |
|
MD5 | cabc6341568ff5d24098c036dc4e59fb |
|
BLAKE2b-256 | db570c7dc4fa6d6ac3ec631eb6babc73f22065e87c8ddc6de9334c5a339c0983 |
Hashes for aws_solutions_constructs.aws_events_rule_step_function-1.75.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ceea13b2ce68a56b3302926a8bfe0bbb4ee98a66dc9b228dd56ec08edbf92b6 |
|
MD5 | c7ad348d922cf8d02a7519fec06d459c |
|
BLAKE2b-256 | 927bfdf9d3ecbeda444fe2455199daa168a8908a295890df57f01c8e0b02a7cb |