AwsEventbridgeEventRuleSfnTargetArgs

interface AwsEventbridgeEventRuleSfnTargetArgs extends EventbridgeEventRuleTargetCommon {
deadLetterConfig?: NonNullable<Input<EventTargetDeadLetterConfig | undefined>>;
eventBus?: undefined;
iamRole: Input<string>;
input?: Input<string>;
inputPath?: Input<string>;
inputTransformer?: NonNullable<Input<EventTargetInputTransformer | undefined>>;
lambda?: undefined;
logGroup?: undefined;
retryPolicy?: NonNullable<Input<EventTargetRetryPolicy | undefined>>;
sfn: Input<string>;
sns?: undefined;
sqs?: undefined;
}

Target configuration for routing events to a Step Functions state machine.

Example

CODE

const rule = new AwsEventbridgeEventRule({
  name: 'notify',
  defaultEventBus,
  eventPattern: JSON.stringify({ source: ['myapp'] }),
  targets: { workflow: {
    sfn: myStateMachine.arn,
    iamRole: eventbridgeRole.arn,
  } },
});

Hierarchy

EventbridgeEventRuleTargetCommon
AwsEventbridgeEventRuleSfnTargetArgs

Properties

`deadLetterConfig: NonNullable<Input<EventTargetDeadLetterConfig | undefined>>`

Inherited from deadLetterConfig

Dead-letter queue configuration for undeliverable events.

`eventBus: undefined`

`iamRole: Input<string>`

IAM role that grants EventBridge permission to invoke the state machine. Accepts a full role ARN, a role name, or a pulumi.Output<string> that resolves to an ARN.

`input: Input<string>`

Inherited from input

Verbatim JSON text passed to the target. Conflicts with inputPath and inputTransformer.

`inputPath: Input<string>`

Inherited from inputPath

JSONPath expression to extract part of the matched event. Conflicts with input and inputTransformer.

`inputTransformer: NonNullable<Input<EventTargetInputTransformer | undefined>>`

Inherited from inputTransformer

Custom input transformation applied before delivering the event. Conflicts with input and inputPath.

`lambda: undefined`

`logGroup: undefined`

`retryPolicy: NonNullable<Input<EventTargetRetryPolicy | undefined>>`

Inherited from retryPolicy

Retry policy for failed target invocations.

`sfn: Input<string>`

ARN or name of the Step Functions state machine. Accepts a full state machine ARN or a state machine name; names are resolved to ARNs automatically.