This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::EventsV2::Subscriber InvokeConfiguration
Configuration for how the subscriber invokes its target. Specify the target ARN, the IAM role, and, optionally, the target-specific parameters object that matches the target type.
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "EventBusV2Parameters" :EventBusV2Parameters, "HttpParameters" :HttpParameters, "KinesisParameters" :KinesisParameters, "LambdaParameters" :LambdaParameters, "RoleArn" :String, "SnsParameters" :SnsParameters, "SqsParameters" :SqsParameters, "StepFunctionsParameters" :StepFunctionsParameters, "TargetArn" :String, "UniversalTargetParameters" :UniversalTargetParameters}
YAML
EventBusV2Parameters:EventBusV2ParametersHttpParameters:HttpParametersKinesisParameters:KinesisParametersLambdaParameters:LambdaParametersRoleArn:StringSnsParameters:SnsParametersSqsParameters:SqsParametersStepFunctionsParameters:StepFunctionsParametersTargetArn:StringUniversalTargetParameters:UniversalTargetParameters
Properties
EventBusV2Parameters-
Parameters for forwarding events to another EventBridge event bus, used when TargetArn is an event bus ARN of the form arn:{partition}:events:{region}:{account}:event-busv2/{name}/{id}.
Required: No
Type: EventBusV2Parameters
Update requires: No interruption
HttpParameters-
Parameters for invoking an HTTP endpoint target, such as an Amazon API Gateway endpoint or an EventBridge API destination.
Required: No
Type: HttpParameters
Update requires: No interruption
KinesisParameters-
Parameters for writing events to an Amazon Kinesis Data Streams target.
Required: No
Type: KinesisParameters
Update requires: No interruption
LambdaParameters-
Parameters for invoking an AWS Lambda function target.
Required: No
Type: LambdaParameters
Update requires: No interruption
RoleArn-
The ARN of the IAM role the service assumes to invoke the target. The role must belong to the same account as the subscriber.
Required: Yes
Type: String
Pattern:
^arn:aws(-[a-z0-9]+)*:iam::\d{12}:role\/[\w+=,.@/-]+$Minimum:
1Maximum:
1600Update requires: No interruption
SnsParameters-
Parameters for publishing events to an Amazon SNS topic target.
Required: No
Type: SnsParameters
Update requires: No interruption
SqsParameters-
Parameters for sending events to an Amazon SQS queue target.
Required: No
Type: SqsParameters
Update requires: No interruption
StepFunctionsParameters-
Parameters for starting an AWS Step Functions state machine execution target.
Required: No
Type: StepFunctionsParameters
Update requires: No interruption
TargetArn-
The Amazon Resource Name (ARN) of the target that the subscriber invokes. For universal service integration targets, use the form arn:{partition}:events:::aws-sdk:{service}:{apiAction}.
Required: Yes
Type: String
Pattern:
^arn:Minimum:
1Maximum:
1600Update requires: Replacement
UniversalTargetParameters-
Parameters for invoking an AWS service API as a universal service integration target, used when TargetArn has the form arn:{partition}:events:::aws-sdk:{service}:{apiAction}.
Required: No
Type: UniversalTargetParameters
Update requires: No interruption
