Package software.amazon.awscdk.services.stepfunctions

Class CfnStateMachine.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.CfnStateMachine.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStateMachine>

Enclosing class:

CfnStateMachine

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

A fluent builder for CfnStateMachine.

Method Summary

Modifier and Type	Method	Description
CfnStateMachine	build()
static CfnStateMachine.Builder	create(software.constructs.Construct scope, String id)
CfnStateMachine.Builder	definition(Object definition)	The Amazon States Language definition of the state machine.
CfnStateMachine.Builder	definitionS3Location(IResolvable definitionS3Location)	The name of the S3 bucket where the state machine definition is stored.
CfnStateMachine.Builder	definitionS3Location(CfnStateMachine.S3LocationProperty definitionS3Location)	The name of the S3 bucket where the state machine definition is stored.
CfnStateMachine.Builder	definitionString(String definitionString)	The Amazon States Language definition of the state machine.
CfnStateMachine.Builder	definitionSubstitutions(Map<String,String> definitionSubstitutions)	A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.
CfnStateMachine.Builder	definitionSubstitutions(IResolvable definitionSubstitutions)	A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.
CfnStateMachine.Builder	encryptionConfiguration(IResolvable encryptionConfiguration)	Encryption configuration for the state machine.
CfnStateMachine.Builder	encryptionConfiguration(CfnStateMachine.EncryptionConfigurationProperty encryptionConfiguration)	Encryption configuration for the state machine.
CfnStateMachine.Builder	loggingConfiguration(IResolvable loggingConfiguration)	Defines what execution history events are logged and where they are logged.
CfnStateMachine.Builder	loggingConfiguration(CfnStateMachine.LoggingConfigurationProperty loggingConfiguration)	Defines what execution history events are logged and where they are logged.
CfnStateMachine.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
CfnStateMachine.Builder	stateMachineName(String stateMachineName)	The name of the state machine.
CfnStateMachine.Builder	stateMachineType(String stateMachineType)	Determines whether a STANDARD or EXPRESS state machine is created.
CfnStateMachine.Builder	tags(List<? extends CfnStateMachine.TagsEntryProperty> tags)	The list of tags to add to a resource.
CfnStateMachine.Builder	tracingConfiguration(IResolvable tracingConfiguration)	Selects whether or not the state machine's AWS X-Ray tracing is enabled.
CfnStateMachine.Builder	tracingConfiguration(CfnStateMachine.TracingConfigurationProperty tracingConfiguration)	Selects whether or not the state machine's AWS X-Ray tracing is enabled.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnStateMachine.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnStateMachine.Builder.

roleArn

@Stability(Stable)
public CfnStateMachine.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role to use for this state machine. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-rolearn

definition

@Stability(Stable)
public CfnStateMachine.Builder definition(Object definition)

The Amazon States Language definition of the state machine.

The state machine definition must be in JSON or YAML, and the format of the object must match the format of your CloudFormation template file. See Amazon States Language .

Parameters:

definition - The Amazon States Language definition of the state machine. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definition

definitionS3Location

@Stability(Stable)
public CfnStateMachine.Builder definitionS3Location(IResolvable definitionS3Location)

The name of the S3 bucket where the state machine definition is stored.

The state machine definition must be a JSON or YAML file.

Parameters:

definitionS3Location - The name of the S3 bucket where the state machine definition is stored. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location

definitionS3Location

@Stability(Stable)
public CfnStateMachine.Builder definitionS3Location(CfnStateMachine.S3LocationProperty definitionS3Location)

The name of the S3 bucket where the state machine definition is stored.

The state machine definition must be a JSON or YAML file.

Parameters:

definitionS3Location - The name of the S3 bucket where the state machine definition is stored. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location

definitionString

@Stability(Stable)
public CfnStateMachine.Builder definitionString(String definitionString)

The Amazon States Language definition of the state machine.

The state machine definition must be in JSON. See Amazon States Language .

Parameters:

definitionString - The Amazon States Language definition of the state machine. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionstring

definitionSubstitutions

@Stability(Stable)
public CfnStateMachine.Builder definitionSubstitutions(IResolvable definitionSubstitutions)

A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.

This enables the customer to inject values obtained at runtime, for example from intrinsic functions, in the state machine definition. Variables can be template parameter names, resource logical IDs, resource attributes, or a variable in a key-value map.

Substitutions must follow the syntax: ${key_name} or ${variable_1,variable_2,...} .

Parameters:

definitionSubstitutions - A map (string to string) that specifies the mappings for placeholder variables in the state machine definition. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionsubstitutions

definitionSubstitutions

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

A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.

This enables the customer to inject values obtained at runtime, for example from intrinsic functions, in the state machine definition. Variables can be template parameter names, resource logical IDs, resource attributes, or a variable in a key-value map.

Substitutions must follow the syntax: ${key_name} or ${variable_1,variable_2,...} .

Parameters:

definitionSubstitutions - A map (string to string) that specifies the mappings for placeholder variables in the state machine definition. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionsubstitutions

encryptionConfiguration

@Stability(Stable)
public CfnStateMachine.Builder encryptionConfiguration(IResolvable encryptionConfiguration)

Encryption configuration for the state machine.

Parameters:

encryptionConfiguration - Encryption configuration for the state machine. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-encryptionconfiguration

encryptionConfiguration

@Stability(Stable)
public CfnStateMachine.Builder encryptionConfiguration(CfnStateMachine.EncryptionConfigurationProperty encryptionConfiguration)

Encryption configuration for the state machine.

Parameters:

encryptionConfiguration - Encryption configuration for the state machine. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-encryptionconfiguration

loggingConfiguration

@Stability(Stable)
public CfnStateMachine.Builder loggingConfiguration(IResolvable loggingConfiguration)

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

By default, the level is set to OFF . For more information see Log Levels in the AWS Step Functions User Guide.

Parameters:

loggingConfiguration - Defines what execution history events are logged and where they are logged. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration

loggingConfiguration

@Stability(Stable)
public CfnStateMachine.Builder loggingConfiguration(CfnStateMachine.LoggingConfigurationProperty loggingConfiguration)

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

By default, the level is set to OFF . For more information see Log Levels in the AWS Step Functions User Guide.

Parameters:

loggingConfiguration - Defines what execution history events are logged and where they are logged. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration

stateMachineName

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

The name of the state machine.

A name must not contain:

• white space
• brackets < > { } [ ]
• wildcard characters ? *
• special characters " # % \ ^ | ~ $ & , ; : /`
• control characters ( U+0000-001F , U+007F-009F )

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Parameters:

stateMachineName - The name of the state machine. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinename

stateMachineType

@Stability(Stable)
public CfnStateMachine.Builder stateMachineType(String stateMachineType)

Determines whether a STANDARD or EXPRESS state machine is created.

The default is STANDARD . You cannot update the type of a state machine once it has been created. For more information on STANDARD and EXPRESS workflows, see Standard Versus Express Workflows in the AWS Step Functions Developer Guide.

Parameters:

stateMachineType - Determines whether a STANDARD or EXPRESS state machine is created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinetype

tags

@Stability(Stable)
public CfnStateMachine.Builder tags(List<? extends CfnStateMachine.TagsEntryProperty> tags)

The list of tags to add to a resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: `_ . : / = + -

Parameters:

tags - The list of tags to add to a resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tags

tracingConfiguration

@Stability(Stable)
public CfnStateMachine.Builder tracingConfiguration(IResolvable tracingConfiguration)

Selects whether or not the state machine's AWS X-Ray tracing is enabled.

Parameters:

tracingConfiguration - Selects whether or not the state machine's AWS X-Ray tracing is enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration

tracingConfiguration

@Stability(Stable)
public CfnStateMachine.Builder tracingConfiguration(CfnStateMachine.TracingConfigurationProperty tracingConfiguration)

Selects whether or not the state machine's AWS X-Ray tracing is enabled.

Parameters:

tracingConfiguration - Selects whether or not the state machine's AWS X-Ray tracing is enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration

build

@Stability(Stable)
public CfnStateMachine build()

Specified by:

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

Returns:

a newly built instance of CfnStateMachine.