InvokeConfigurationProperty Struct Added in v2.275.0
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.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eventsv2 as eventsv2 } from 'aws-cdk-lib';
const invokeConfigurationProperty: eventsv2.CfnSubscriber.InvokeConfigurationProperty = {
roleArn: 'roleArn',
targetArn: 'targetArn',
// the properties below are optional
eventBusV2Parameters: {
deduplicationConfiguration: {
deduplicationType: 'deduplicationType',
},
metadata: {
metadataKey: 'metadata',
},
systemMetadata: {
deduplicationId: 'deduplicationId',
eventGroupId: 'eventGroupId',
},
},
httpParameters: {
headerParameters: {
headerParametersKey: 'headerParameters',
},
invocationTimeoutSeconds: 'invocationTimeoutSeconds',
pathParameterValues: ['pathParameterValues'],
queryStringParameters: {
queryStringParametersKey: 'queryStringParameters',
},
},
kinesisParameters: {
explicitHashKey: 'explicitHashKey',
partitionKey: 'partitionKey',
},
lambdaParameters: {
durableExecutionName: 'durableExecutionName',
invocationTimeoutSeconds: 'invocationTimeoutSeconds',
invocationType: 'invocationType',
qualifier: 'qualifier',
tenantId: 'tenantId',
},
snsParameters: {
messageAttributes: {
messageAttributesKey: {
dataType: 'dataType',
// the properties below are optional
binaryValue: 'binaryValue',
stringValue: 'stringValue',
},
},
messageDeduplicationId: 'messageDeduplicationId',
messageGroupId: 'messageGroupId',
messageStructure: 'messageStructure',
subject: 'subject',
},
sqsParameters: {
delaySeconds: 'delaySeconds',
messageAttributes: {
messageAttributesKey: {
dataType: 'dataType',
// the properties below are optional
binaryValue: 'binaryValue',
stringValue: 'stringValue',
},
},
messageDeduplicationId: 'messageDeduplicationId',
messageGroupId: 'messageGroupId',
messageSystemAttributes: {
messageSystemAttributesKey: {
dataType: 'dataType',
// the properties below are optional
binaryValue: 'binaryValue',
stringValue: 'stringValue',
},
},
},
stepFunctionsParameters: {
invocationTimeoutSeconds: 'invocationTimeoutSeconds',
invocationType: 'invocationType',
name: 'name',
traceHeader: 'traceHeader',
},
universalTargetParameters: {
input: 'input',
// the properties below are optional
invocationTimeoutSeconds: 'invocationTimeoutSeconds',
},
};
Properties
eventBusV2ParametersoptionalIResolvable | CfnSubscriber.EventBusV2ParametersPropertyevent_bus_v2_parametersoptionaltyping.Union[IResolvable, EventBusV2ParametersProperty]eventBusV2ParametersoptionalIResolvableEventBusV2ParametersoptionalIResolvableEventBusV2Parametersoptionalinterface{}#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}.
httpParametersoptionalIResolvable | CfnSubscriber.HttpParametersPropertyhttp_parametersoptionaltyping.Union[IResolvable, HttpParametersProperty]httpParametersoptionalIResolvableHttpParametersoptionalIResolvableHttpParametersoptionalinterface{}#Parameters for invoking an HTTP endpoint target, such as an Amazon API Gateway endpoint or an EventBridge API destination.
kinesisParametersoptionalIResolvable | CfnSubscriber.KinesisParametersPropertykinesis_parametersoptionaltyping.Union[IResolvable, KinesisParametersProperty]kinesisParametersoptionalIResolvableKinesisParametersoptionalIResolvableKinesisParametersoptionalinterface{}#Parameters for writing events to an Amazon Kinesis Data Streams target.
lambdaParametersoptionalIResolvable | CfnSubscriber.LambdaParametersPropertylambda_parametersoptionaltyping.Union[IResolvable, LambdaParametersProperty]lambdaParametersoptionalIResolvableLambdaParametersoptionalIResolvableLambdaParametersoptionalinterface{}#Parameters for invoking an AWS Lambda function target.
The ARN of the IAM role the service assumes to invoke the target.
The role must belong to the same account as the subscriber.
snsParametersoptionalIResolvable | CfnSubscriber.SnsParametersPropertysns_parametersoptionaltyping.Union[IResolvable, SnsParametersProperty]snsParametersoptionalIResolvableSnsParametersoptionalIResolvableSnsParametersoptionalinterface{}#Parameters for publishing events to an Amazon SNS topic target.
sqsParametersoptionalIResolvable | CfnSubscriber.SqsParametersPropertysqs_parametersoptionaltyping.Union[IResolvable, SqsParametersProperty]sqsParametersoptionalIResolvableSqsParametersoptionalIResolvableSqsParametersoptionalinterface{}#Parameters for sending events to an Amazon SQS queue target.
stepFunctionsParametersoptionalIResolvable | CfnSubscriber.StepFunctionsParametersPropertystep_functions_parametersoptionaltyping.Union[IResolvable, StepFunctionsParametersProperty]stepFunctionsParametersoptionalIResolvableStepFunctionsParametersoptionalIResolvableStepFunctionsParametersoptionalinterface{}#Parameters for starting an AWS Step Functions state machine execution target.
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}.
universalTargetParametersoptionalIResolvable | CfnSubscriber.UniversalTargetParametersPropertyuniversal_target_parametersoptionaltyping.Union[IResolvable, UniversalTargetParametersProperty]universalTargetParametersoptionalIResolvableUniversalTargetParametersoptionalIResolvableUniversalTargetParametersoptionalinterface{}#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}.