AWS::AppIntegrations::EventIntegration
Creates an event integration. You provide a name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that will push events to that bus. No objects are created in your account, only metadata that is persisted on the EventIntegration control plane.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::AppIntegrations::EventIntegration", "Properties" : { "Description" :
String
, "EventBridgeBus" :String
, "EventFilter" :EventFilter
, "Name" :String
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::AppIntegrations::EventIntegration Properties: Description:
String
EventBridgeBus:String
EventFilter:EventFilter
Name:String
Tags:- Tag
Properties
Description
-
The event integration description.
Required: No
Type: String
Update requires: No interruption
EventBridgeBus
-
The Amazon EventBridge bus for the event integration.
Required: Yes
Type: String
Update requires: Replacement
EventFilter
-
The event integration filter.
Required: Yes
Type: EventFilter
Update requires: Replacement
Name
-
The name of the event integration.
Required: Yes
Type: String
Update requires: Replacement
Tags
-
An array of key-value pairs to apply to this resource.
For more information, see Tag.
Required: No
Type: List of Tag
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the EventIntegration name. For example:
{ "Ref": "myEventIntegrationName" }
For more information about using the Ref
function, see Ref.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt.