Package software.amazon.awscdk.services.pipes.targets.alpha

Interface SfnStateMachineParameters

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SfnStateMachineParameters.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:50.531Z")
@Stability(Experimental)
public interface SfnStateMachineParameters
extends software.amazon.jsii.JsiiSerializable

(experimental) Parameters for the SfnStateMachine target.

Example:

 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SfnStateMachineParameters.Builder	builder()
default IInputTransformation	getInputTransformation()	(experimental) The input transformation to apply to the message before sending it to the target.
default StateMachineInvocationType	getInvocationType()	(experimental) Specify whether to invoke the State Machine synchronously (REQUEST_RESPONSE) or asynchronously (FIRE_AND_FORGET).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInputTransformation

@Stability(Experimental)
@Nullable
default IInputTransformation getInputTransformation()

(experimental) The input transformation to apply to the message before sending it to the target.

Default: - none

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-inputtemplate

getInvocationType

@Stability(Experimental)
@Nullable
default StateMachineInvocationType getInvocationType()

(experimental) Specify whether to invoke the State Machine synchronously (REQUEST_RESPONSE) or asynchronously (FIRE_AND_FORGET).

Default: StateMachineInvocationType.FIRE_AND_FORGET

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsqsqueueparameters.html#cfn-pipes-pipe-pipetargetsqsqueueparameters-messagededuplicationid

builder

@Stability(Experimental)
static SfnStateMachineParameters.Builder builder()

Returns:

a SfnStateMachineParameters.Builder of SfnStateMachineParameters