AWS CDK Reference

Appearance

v2.275.0

Experimental

@aws-cdk/aws-pipes-targets-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

SfnStateMachine Class ​

An EventBridge Pipes target that sends messages to an AWS Step Functions State Machine.

Stability
Experimental
Source
lib/stepfunctions.ts

Example ​

ts
declare const sourceQueue: sqs.Queue;
declare const targetStateMachine: sfn.IStateMachine;

const pipeTarget = new targets.SfnStateMachine(targetStateMachine, {
    invocationType: targets.StateMachineInvocationType.FIRE_AND_FORGET,
});

const pipe = new pipes.Pipe(this, 'Pipe', {
    source: new SqsSource(sourceQueue),
    target: pipeTarget
});
python
# source_queue: sqs.Queue
# target_state_machine: sfn.IStateMachine


pipe_target = targets.SfnStateMachine(target_state_machine,
    invocation_type=targets.StateMachineInvocationType.FIRE_AND_FORGET
)

pipe = pipes.Pipe(self, "Pipe",
    source=SqsSource(source_queue),
    target=pipe_target
)
java
Queue sourceQueue;
IStateMachine targetStateMachine;


SfnStateMachine pipeTarget = SfnStateMachine.Builder.create(targetStateMachine)
        .invocationType(StateMachineInvocationType.FIRE_AND_FORGET)
        .build();

Pipe pipe = Pipe.Builder.create(this, "Pipe")
        .source(new SqsSource(sourceQueue))
        .target(pipeTarget)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Pipes.Targets.Alpha
Queue sourceQueue;
IStateMachine targetStateMachine;


var pipeTarget = new SfnStateMachine(targetStateMachine, new SfnStateMachineParameters {
    InvocationType = StateMachineInvocationType.FIRE_AND_FORGET
});

var pipe = new Pipe(this, "Pipe", new PipeProps {
    Source = new SqsSource(sourceQueue),
    Target = pipeTarget
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkpipestargetsalpha/v2
var sourceQueue Queue
var targetStateMachine IStateMachine


pipeTarget := targets.NewSfnStateMachine(targetStateMachine, &SfnStateMachineParameters{
	InvocationType: targets.StateMachineInvocationType_FIRE_AND_FORGET,
})

pipe := pipes.NewPipe(this, jsii.String("Pipe"), &PipeProps{
	Source: awscdkpipessourcesalpha.NewSqsSource(sourceQueue),
	Target: pipeTarget,
})

Initializer ​

ts
new SfnStateMachine(stateMachine: IStateMachine, parameters: SfnStateMachineParameters)
python
SfnStateMachine(state_machine: IStateMachine, parameters: SfnStateMachineParameters)
java
new SfnStateMachine(IStateMachine stateMachine, SfnStateMachineParameters parameters)
csharp
new SfnStateMachine(IStateMachine stateMachine, SfnStateMachineParameters parameters)
go
NewSfnStateMachine(StateMachine IStateMachine, Parameters SfnStateMachineParameters)

Properties ​

targetArnstringtarget_arnstrtargetArnStringTargetArnstringTargetArn*string#
The ARN of the target resource.

Methods ​

bind(pipe: IPipe): TargetConfigdef bind(self, pipe: IPipe) -> TargetConfigpublic TargetConfig bind(IPipe pipe)public TargetConfig Bind(IPipe pipe)func Bind(Pipe IPipe) TargetConfig#
Bind this target to a pipe.
grantPush(grantee: IRole): voiddef grant_push(self, grantee: IRole) -> Nonepublic void grantPush(IRole grantee)public void GrantPush(IRole grantee)func GrantPush(Grantee IRole)#
Grant the pipe role to push to the target.