software.amazon.awscdk.services.stepfunctions

Class StepFunctionsTaskConfig.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.StepFunctionsTaskConfig.Builder

Enclosing interface:

StepFunctionsTaskConfig

@Stability(value=Experimental)
public static final class StepFunctionsTaskConfig.Builder
extends Object

A builder for StepFunctionsTaskConfig

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
StepFunctionsTaskConfig	build() Builds the configured instance.
StepFunctionsTaskConfig.Builder	heartbeat(Duration heartbeat) Sets the value of StepFunctionsTaskConfig.getHeartbeat()
StepFunctionsTaskConfig.Builder	metricDimensions(Map<String,Object> metricDimensions) Sets the value of StepFunctionsTaskConfig.getMetricDimensions()
StepFunctionsTaskConfig.Builder	metricPrefixPlural(String metricPrefixPlural) Sets the value of StepFunctionsTaskConfig.getMetricPrefixPlural()
StepFunctionsTaskConfig.Builder	metricPrefixSingular(String metricPrefixSingular) Sets the value of StepFunctionsTaskConfig.getMetricPrefixSingular()
StepFunctionsTaskConfig.Builder	parameters(Map<String,Object> parameters) Sets the value of StepFunctionsTaskConfig.getParameters()
StepFunctionsTaskConfig.Builder	policyStatements(List<PolicyStatement> policyStatements) Sets the value of StepFunctionsTaskConfig.getPolicyStatements()
StepFunctionsTaskConfig.Builder	resourceArn(String resourceArn) Sets the value of StepFunctionsTaskConfig.getResourceArn()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

resourceArn

@Stability(value=Experimental)
public StepFunctionsTaskConfig.Builder resourceArn(String resourceArn)

Sets the value of StepFunctionsTaskConfig.getResourceArn()

Parameters:

resourceArn - The resource that represents the work to be executed. This parameter is required. Either the ARN of a Lambda Function or Activity, or a special ARN.

Returns:

this

heartbeat

@Stability(value=Experimental)
public StepFunctionsTaskConfig.Builder heartbeat(Duration heartbeat)

Sets the value of StepFunctionsTaskConfig.getHeartbeat()

Parameters:

heartbeat - Maximum time between heart beats. If the time between heart beats takes longer than this, a 'Timeout' error is raised.

This is only relevant when using an Activity type as resource.

Returns:

this

metricDimensions

@Stability(value=Experimental)
public StepFunctionsTaskConfig.Builder metricDimensions(Map<String,Object> metricDimensions)

Sets the value of StepFunctionsTaskConfig.getMetricDimensions()

Parameters:

metricDimensions - The dimensions to attach to metrics.

Returns:

this

metricPrefixPlural

@Stability(value=Experimental)
public StepFunctionsTaskConfig.Builder metricPrefixPlural(String metricPrefixPlural)

Sets the value of StepFunctionsTaskConfig.getMetricPrefixPlural()

Parameters:

metricPrefixPlural - Prefix for plural metric names of activity actions.

Returns:

this

metricPrefixSingular

@Stability(value=Experimental)
public StepFunctionsTaskConfig.Builder metricPrefixSingular(String metricPrefixSingular)

Sets the value of StepFunctionsTaskConfig.getMetricPrefixSingular()

Parameters:

metricPrefixSingular - Prefix for singular metric names of activity actions.

Returns:

this

parameters

@Stability(value=Experimental)
public StepFunctionsTaskConfig.Builder parameters(Map<String,Object> parameters)

Sets the value of StepFunctionsTaskConfig.getParameters()

Parameters:

parameters - Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input. The meaning of these parameters is task-dependent.

Its values will be merged with the parameters property which is configured directly on the Task state.

Returns:

this

policyStatements

@Stability(value=Experimental)
public StepFunctionsTaskConfig.Builder policyStatements(List<PolicyStatement> policyStatements)

Sets the value of StepFunctionsTaskConfig.getPolicyStatements()

Parameters:

policyStatements - Additional policy statements to add to the execution role.

Returns:

this

build

@Stability(value=Experimental)
public StepFunctionsTaskConfig build()

Builds the configured instance.

Returns:

a new instance of StepFunctionsTaskConfig

Throws:

NullPointerException - if any required attribute was not provided