Package software.amazon.awscdk.services.stepfunctions

Class StateMachineProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.StateMachineProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StateMachineProps>

Enclosing interface:

StateMachineProps

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

A builder for StateMachineProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StateMachineProps	build()	Builds the configured instance.
StateMachineProps.Builder	comment(String comment)	Sets the value of StateMachineProps.getComment()
StateMachineProps.Builder	definition(IChainable definition)	Deprecated. use definitionBody: DefinitionBody.fromChainable()
StateMachineProps.Builder	definitionBody(DefinitionBody definitionBody)	Sets the value of StateMachineProps.getDefinitionBody()
StateMachineProps.Builder	definitionSubstitutions(Map<String,String> definitionSubstitutions)	Sets the value of StateMachineProps.getDefinitionSubstitutions()
StateMachineProps.Builder	encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)	Sets the value of StateMachineProps.getEncryptionConfiguration()
StateMachineProps.Builder	logs(LogOptions logs)	Sets the value of StateMachineProps.getLogs()
StateMachineProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateMachineProps.getQueryLanguage()
StateMachineProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of StateMachineProps.getRemovalPolicy()
<T1 extends IRoleRef & IGrantable> StateMachineProps.Builder	role(T1 role)	Sets the value of StateMachineProps.getRole()
StateMachineProps.Builder	stateMachineName(String stateMachineName)	Sets the value of StateMachineProps.getStateMachineName()
StateMachineProps.Builder	stateMachineType(StateMachineType stateMachineType)	Sets the value of StateMachineProps.getStateMachineType()
StateMachineProps.Builder	timeout(Duration timeout)	Sets the value of StateMachineProps.getTimeout()
StateMachineProps.Builder	tracingEnabled(Boolean tracingEnabled)	Sets the value of StateMachineProps.getTracingEnabled()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

comment

@Stability(Stable)
public StateMachineProps.Builder comment(String comment)

Sets the value of StateMachineProps.getComment()

Parameters:

comment - Comment that describes this state machine.

Returns:

this

definition

@Stability(Deprecated)
@Deprecated
public StateMachineProps.Builder definition(IChainable definition)

Deprecated.

use definitionBody: DefinitionBody.fromChainable()

Sets the value of StateMachineProps.getDefinition()

Parameters:

definition - Definition for this state machine.

Returns:

this

definitionBody

@Stability(Stable)
public StateMachineProps.Builder definitionBody(DefinitionBody definitionBody)

Sets the value of StateMachineProps.getDefinitionBody()

Parameters:

definitionBody - Definition for this state machine.

Returns:

this

definitionSubstitutions

@Stability(Stable)
public StateMachineProps.Builder definitionSubstitutions(Map<String,String> definitionSubstitutions)

Sets the value of StateMachineProps.getDefinitionSubstitutions()

Parameters:

definitionSubstitutions - substitutions for the definition body as a key-value map.

Returns:

this

encryptionConfiguration

@Stability(Stable)
public StateMachineProps.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

Sets the value of StateMachineProps.getEncryptionConfiguration()

Parameters:

encryptionConfiguration - Configures server-side encryption of the state machine definition and execution history.

Returns:

this

logs

@Stability(Stable)
public StateMachineProps.Builder logs(LogOptions logs)

Sets the value of StateMachineProps.getLogs()

Parameters:

logs - Defines what execution history events are logged and where they are logged.

Returns:

this

queryLanguage

@Stability(Stable)
public StateMachineProps.Builder queryLanguage(QueryLanguage queryLanguage)

Sets the value of StateMachineProps.getQueryLanguage()

Parameters:

queryLanguage - The name of the query language used by the state machine. If the state does not contain a queryLanguage field, then it will use the query language specified in this queryLanguage field.

Returns:

this

removalPolicy

@Stability(Stable)
public StateMachineProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of StateMachineProps.getRemovalPolicy()

Parameters:

removalPolicy - The removal policy to apply to state machine.

Returns:

this

role

@Stability(Stable)
public <T1 extends IRoleRef & IGrantable>
StateMachineProps.Builder role(T1 role)

Sets the value of StateMachineProps.getRole()

Parameters:

role - The execution role for the state machine service.

Returns:

this

stateMachineName

@Stability(Stable)
public StateMachineProps.Builder stateMachineName(String stateMachineName)

Sets the value of StateMachineProps.getStateMachineName()

Parameters:

stateMachineName - A name for the state machine.

Returns:

this

stateMachineType

@Stability(Stable)
public StateMachineProps.Builder stateMachineType(StateMachineType stateMachineType)

Sets the value of StateMachineProps.getStateMachineType()

Parameters:

stateMachineType - Type of the state machine.

Returns:

this

timeout

@Stability(Stable)
public StateMachineProps.Builder timeout(Duration timeout)

Sets the value of StateMachineProps.getTimeout()

Parameters:

timeout - Maximum run time for this state machine.

Returns:

this

tracingEnabled

@Stability(Stable)
public StateMachineProps.Builder tracingEnabled(Boolean tracingEnabled)

Sets the value of StateMachineProps.getTracingEnabled()

Parameters:

tracingEnabled - Specifies whether Amazon X-Ray tracing is enabled for this state machine.

Returns:

this

build

@Stability(Stable)
public StateMachineProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of StateMachineProps

Throws:

NullPointerException - if any required attribute was not provided