software.amazon.awscdk.services.events.targets

Interface SfnStateMachineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TargetBaseProps

All Known Implementing Classes:

SfnStateMachineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.342Z")
 @Stability(value=Stable)
public interface SfnStateMachineProps
extends software.amazon.jsii.JsiiSerializable, TargetBaseProps

Customize the Step Functions State Machine target.

Example:

 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.stepfunctions.*;
 Rule rule = Rule.Builder.create(this, "Rule")
         .schedule(Schedule.rate(Duration.minutes(1)))
         .build();
 Queue dlq = new Queue(this, "DeadLetterQueue");
 Role role = Role.Builder.create(this, "Role")
         .assumedBy(new ServicePrincipal("events.amazonaws.com"))
         .build();
 StateMachine stateMachine = StateMachine.Builder.create(this, "SM")
         .definition(Wait.Builder.create(this, "Hello").time(WaitTime.duration(Duration.seconds(10))).build())
         .build();
 rule.addTarget(SfnStateMachine.Builder.create(stateMachine)
         .input(RuleTargetInput.fromObject(Map.of("SomeParam", "SomeValue")))
         .deadLetterQueue(dlq)
         .role(role)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SfnStateMachineProps.Builder A builder for SfnStateMachineProps
static class	SfnStateMachineProps.Jsii$Proxy An implementation for SfnStateMachineProps

Method Summary

Modifier and Type	Method and Description
static SfnStateMachineProps.Builder	builder()
default RuleTargetInput	getInput() The input to the state machine execution.
default IRole	getRole() The IAM role to be assumed to execute the State Machine.

Methods inherited from interface software.amazon.awscdk.services.events.targets.TargetBaseProps

getDeadLetterQueue, getMaxEventAge, getRetryAttempts

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getInput

@Stability(value=Stable)
 @Nullable
default RuleTargetInput getInput()

The input to the state machine execution.

Default: the entire EventBridge event

getRole

@Stability(value=Stable)
 @Nullable
default IRole getRole()

The IAM role to be assumed to execute the State Machine.

Default: - a new role will be created

builder

@Stability(value=Stable)
static SfnStateMachineProps.Builder builder()

Specified by:

builder in interface TargetBaseProps

Returns:

a SfnStateMachineProps.Builder of SfnStateMachineProps