View a markdown version of this page

UpdateInvokeConfiguration - Amazon EventBridge Custom Event Bus

UpdateInvokeConfiguration

Update-able configuration for how the subscriber invokes its target.

Contents

RoleArn

IAM role the service assumes to invoke the target. Must belong to the calling account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: arn:aws(-[a-z0-9]+)*:iam::\d{12}:role\/[\w+=,.@/-]+

Required: Yes

EventBusV2Parameters

Parameters for forwarding events to another EventBridge event bus.

Type: EventBusV2Parameters object

Required: No

HttpParameters

HTTP invocation parameters for subscribers (API Gateway / API Destination). Values are forwarded to the HTTP endpoint.

Type: HttpParameters object

Required: No

KinesisParameters

Kinesis Data Streams invocation parameters for subscribers. Values are forwarded to the Kinesis PutRecords API. All scalar values accept a literal or a JSONata expression (e.g. "{% $events.Data.partitionKey %}").

Type: KinesisParameters object

Required: No

LambdaParameters

Lambda invocation parameters for subscribers. Values are forwarded to the Lambda Invoke API. Every string member accepts a literal or a JSONata expression (e.g. "{% $events.Data.qualifier %}").

Type: LambdaParameters object

Required: No

SnsParameters

SNS invocation parameters for subscribers. Values are forwarded to the SNS PublishBatch API. All scalar values accept a literal or a JSONata expression (e.g. "{% $events.Data.groupId %}").

Type: SnsParameters object

Required: No

SqsParameters

SQS invocation parameters for subscribers. Values are forwarded to the SQS SendMessageBatch API. All scalar values accept a literal or a JSONata expression (e.g. "{% $events.Data.groupId %}").

Type: SqsParameters object

Required: No

StepFunctionsParameters

Step Functions invocation parameters for subscribers. Values are forwarded to the Step Functions StartExecution or StartSyncExecution API. Every string member accepts a literal or a JSONata expression (e.g. "{% $events.Data.executionName %}").

Type: StepFunctionsParameters object

Required: No

UniversalTargetParameters

Parameters for USI (Universal Service Integration) targets. Used when TargetArn is in the format arn:aws:events:::aws-sdk:{service}:{apiAction}

Type: UniversalTargetParameters object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: