Package software.amazon.awscdk.services.iot.actions.alpha

Class StepFunctionsStateMachineAction.Builder

java.lang.Object

software.amazon.awscdk.services.iot.actions.alpha.StepFunctionsStateMachineAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StepFunctionsStateMachineAction>

Enclosing class:

StepFunctionsStateMachineAction

@Stability(Experimental)
public static final class StepFunctionsStateMachineAction.Builder
extends Object
implements software.amazon.jsii.Builder<StepFunctionsStateMachineAction>

(experimental) A fluent builder for StepFunctionsStateMachineAction.

Method Summary

Modifier and Type	Method	Description
StepFunctionsStateMachineAction	build()
static StepFunctionsStateMachineAction.Builder	create(IStateMachine stateMachine)
StepFunctionsStateMachineAction.Builder	executionNamePrefix(String executionNamePrefix)	(experimental) Name of the state machine execution prefix.
StepFunctionsStateMachineAction.Builder	role(IRole role)	(experimental) The IAM role that allows access to AWS service.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static StepFunctionsStateMachineAction.Builder create(IStateMachine stateMachine)

Parameters:

stateMachine - The Step Functions Start Machine which shoud be executed. This parameter is required.

Returns:

a new instance of StepFunctionsStateMachineAction.Builder.

role

@Stability(Experimental)
public StepFunctionsStateMachineAction.Builder role(IRole role)

(experimental) The IAM role that allows access to AWS service.

Default: a new role will be created

Parameters:

role - The IAM role that allows access to AWS service. This parameter is required.

Returns:

this

executionNamePrefix

@Stability(Experimental)
public StepFunctionsStateMachineAction.Builder executionNamePrefix(String executionNamePrefix)

(experimental) Name of the state machine execution prefix.

The name given to the state machine execution consists of this prefix followed by a UUID. Step Functions creates a unique name for each state machine execution if one is not provided.

Default: : None - Step Functions creates a unique name for each state machine execution if one is not provided.

Parameters:

executionNamePrefix - Name of the state machine execution prefix. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/iot/latest/developerguide/stepfunctions-rule-action.html#stepfunctions-rule-action-parameters

build

@Stability(Experimental)
public StepFunctionsStateMachineAction build()

Specified by:

build in interface software.amazon.jsii.Builder<StepFunctionsStateMachineAction>

Returns:

a newly built instance of StepFunctionsStateMachineAction.