# CDK Triggers
> The APIs of higher level constructs in this module are experimental and under active development.
> They are subject to non-backward compatible changes or removal in any future version. These are
> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be
> announced in the release notes. 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.
## Overview
Allow specifying arbitrary handlers which execute as part of the deployment process and trigger them before/after resources or stacks.
## Usage
You can trigger the execution of arbitrary AWS Lambda functions before or after resources or groups of resources are provisioned using the Triggers API.
The library includes constructs that represent different triggers. The `BeforeCreate` and `AfterCreate` constructs can be used to trigger a handler before/after a set of resources have been created.
```python
# Example automatically generated from non-compiling source. May contain errors.
triggers.AfterCreate(self, "InvokeAfter",
resources=[resource1, resource2, stack, ...],
handler=my_lambda_function
)
```
Where `resources` is a list of **construct scopes** which determine when `handler` is invoked. Scopes can be either specific resources or composite constructs (in which case all the resources in the construct will be used as a group). The scope can also be a `Stack`, in which case the trigger will apply to all the resources within the stack (same as any composite construct). All scopes must roll up to the same stack.
Let's look at an example. Say we want to publish a notification to an SNS topic that says "hello, topic!" after the topic is created.
```python
# Example automatically generated from non-compiling source. May contain errors.
# define a topic
topic = sns.Topic(self, "MyTopic")
# define a lambda function which publishes a message to the topic
publisher = NodeJsFunction(self, "PublishToTopic")
publisher.add_environment("TOPIC_ARN", topic.topic_arn)
publisher.add_environment("MESSAGE", "Hello, topic!")
topic.grant_publish(publisher)
# trigger the lambda function after the topic is created
triggers.AfterCreate(self, "SayHello",
scopes=[topic],
handler=publisher
)
```
## Additional Notes
* If the trigger fails, deployment fails.
* If the handler changes (configuration or code), the trigger gets re-executed (trigger is bound to `lambda.currentVersion` which gets recreated
when the function changes).
## Roadmap
* Additional periodic execution after deployment (`repeatOnSchedule`).
* Async checks (`retryWithTimeout`)
* Execute shell command inside a Docker image
## Use Cases
Here are some examples of use cases for triggers:
* **Intrinsic validations**: execute a check to verify that a resource or set of resources have been deployed correctly
* Test connections to external systems (e.g. security tokens are valid)
* Verify integration between resources is working as expected
* Execute as one-off and also periodically after deployment
* Wait for data to start flowing (e.g. wait for a metric) before deployment is successful
* **Data priming**: add data to resources after they are created
* CodeCommit repo + initial commit
* Database + test data for development
* Check prerequisites before depoyment
* Account limits
* Availability of external services
* Connect to other accounts
## Security
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
## License
This project is licensed under the Apache-2.0 License.
挣扎的蓝藻
- 粉丝: 14w+
- 资源: 15万+
最新资源
- 基于springboot的智能无人仓库管理源码(java毕业设计完整源码+LW).zip
- 机械设计油箱密封试验机sw20项目全套技术资料.zip
- Spirent-TestCenter-Automation-Obj-Ref
- 基于springboot的在线考试与学习交流网页平台源码(java毕业设计完整源码+LW).zip
- 大规模用户运营体系搭建.pdf
- 数据资产化框架.pdf
- 数字化时代产业内容资产管理平台-业务架构.pdf
- 苏宁科技集团智慧零售方案.pdf
- 中国金融体系指标大全(2024年版)(77页).pdf
- 雪亮工程解决方案.pdf
- 基于springboot的常规应急物资管理系统源码(java毕业设计完整源码+LW).zip
- Spirent-TestCenter-Automation-Conf-Obj-Ref
- 基于springboot的线上辅导班系统的开发与设计源码(java毕业设计完整源码+LW).zip
- Spirent-TestCenter-Automation-Prog-Guide
- 计算机十进制转换成二进制详细步骤(手工计算).zip
- 基于springboot的医院资源管理系统源码(java毕业设计完整源码+LW).zip
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈