Interface SfnStateMachineProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable,TargetBaseProps
- All Known Implementing Classes:
SfnStateMachineProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
date="2025-11-20T13:52:03.851Z")
@Stability(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 ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forSfnStateMachinePropsstatic final classAn implementation forSfnStateMachineProps -
Method Summary
Modifier and TypeMethodDescriptionstatic SfnStateMachineProps.Builderbuilder()default RuleTargetInputgetInput()The input to the state machine execution.default IRolegetRole()The IAM role to be assumed to execute the State Machine.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJsonMethods inherited from interface software.amazon.awscdk.services.events.targets.TargetBaseProps
getDeadLetterQueue, getMaxEventAge, getRetryAttempts
-
Method Details
-
getInput
The input to the state machine execution.Default: the entire EventBridge event
-
getRole
The IAM role to be assumed to execute the State Machine.Default: - a new role will be created
-
builder
- Returns:
- a
SfnStateMachineProps.BuilderofSfnStateMachineProps
-