software.amazon.awscdk.services.events.targets

Class SfnStateMachine

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.events.targets.SfnStateMachine

All Implemented Interfaces:

IRuleTarget, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.341Z")
 @Stability(value=Stable)
public class SfnStateMachine
extends software.amazon.jsii.JsiiObject
implements IRuleTarget

Use a StepFunctions state machine as a target for Amazon EventBridge rules.

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	Class and Description
static class	SfnStateMachine.Builder A fluent builder for SfnStateMachine.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.events.IRuleTarget

IRuleTarget.Jsii$Default, IRuleTarget.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	SfnStateMachine(IStateMachine machine)
	SfnStateMachine(IStateMachine machine, SfnStateMachineProps props)
protected	SfnStateMachine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SfnStateMachine(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
RuleTargetConfig	bind(IRule _rule) Returns a properties that are used in an Rule to trigger this State Machine.
RuleTargetConfig	bind(IRule _rule, String _id) Returns a properties that are used in an Rule to trigger this State Machine.
IStateMachine	getMachine()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

SfnStateMachine

protected SfnStateMachine(software.amazon.jsii.JsiiObjectRef objRef)

SfnStateMachine

protected SfnStateMachine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

SfnStateMachine

@Stability(value=Stable)
public SfnStateMachine(@NotNull
                                                IStateMachine machine,
                                                @Nullable
                                                SfnStateMachineProps props)

Parameters:

machine - This parameter is required.

props -

SfnStateMachine

@Stability(value=Stable)
public SfnStateMachine(@NotNull
                                                IStateMachine machine)

Parameters:

machine - This parameter is required.

Method Detail

bind

@Stability(value=Stable)
 @NotNull
public RuleTargetConfig bind(@NotNull
                                                                IRule _rule,
                                                                @Nullable
                                                                String _id)

Returns a properties that are used in an Rule to trigger this State Machine.

Specified by:

bind in interface IRuleTarget

Parameters:

_rule - This parameter is required.

_id -

See Also:

https://docs.aws.amazon.com/eventbridge/latest/userguide/resource-based-policies-eventbridge.html#sns-permissions

bind

@Stability(value=Stable)
 @NotNull
public RuleTargetConfig bind(@NotNull
                                                                IRule _rule)

Returns a properties that are used in an Rule to trigger this State Machine.

Specified by:

bind in interface IRuleTarget

Parameters:

_rule - This parameter is required.

See Also:

https://docs.aws.amazon.com/eventbridge/latest/userguide/resource-based-policies-eventbridge.html#sns-permissions

getMachine

@Stability(value=Stable)
 @NotNull
public IStateMachine getMachine()