Generating an AWS CloudFormation template from an existing EventBridge event bus
AWS CloudFormation enables you to configure and manage your AWS resources across accounts and regions in a centralized and repeatable manner by treating infrastructure as code. CloudFormation does this by letting you create templates, which define the resources you want to provision and manage.
EventBridge enables you to generate templates from the existing event buses in your account, as an aid to help you jumpstart developing CloudFormation templates. In addition, EventBridge provides the option of including the rules associated with that event bus in your template. You can then use these templates as the basis for creating stacks of resources under CloudFormation management.
For more information on CloudFormation see The AWS CloudFormation User Guide.
Note
EventBridge does not include managed rules managed rules in the generated template.
You can also generate a template from one or more rules contained in a selected event bus.
To generate an CloudFormation template from an event bus
Open the Amazon EventBridge console at https://console.aws.amazon.com/events/
. -
In the navigation pane, choose Event buses.
-
Choose the event bus from which you want to generate a CloudFormation template.
-
From the Actions menu, choose CloudFormation Template, and then choose which format you want EventBridge to generate the template in: JSON or YAML.
EventBridge displays the template, generated in the selected format. By default, all rules associated with the event bus are included in the template.
To generate the template without including rules, deselect Include rules on this EventBus.
-
EventBridge gives you the option of downloading the template file, or copying the template to the clipboard.
To download the template file, choose Download.
To copy the template to the clipboard, choose Copy.
-
To exit the template, choose Cancel.
Once you've customized your AWS CloudFormation template as necessary for your use case, you can use it to create stacks in CloudFormation.
Considerations when using CloudFormation templates generated from Amazon EventBridge
Consider the following factors when using a CloudFormation template you generated from an event bus:
EventBridge does not include any passwords in the generate template.
You can edit the template to include template parameters that enable users to specify passwords or other sensitive information when using the template to create or update a CloudFormation stack.
In addition, users can use Secrets Manager to create a secret in the desired region and then edit the generated template to employ dynamic parameters.
Targets in the generated template remain exactly as they were specified in the original event bus. This can lead to cross-region issues if you do not appropriately edit the template before using it to create stacks in other regions.
Additionally, the generated template will not create the downstream targets automatically.
