software.amazon.awscdk.services.stepfunctions

Interface StepFunctionsTaskConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StepFunctionsTaskConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.15.0 (build 585166b)",
           date="2021-01-06T15:17:33.920Z")
 @Stability(value=Stable)
public interface StepFunctionsTaskConfig
extends software.amazon.jsii.JsiiSerializable

Properties that define what kind of task should be created.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static StepFunctionsTaskConfig.Builder	builder()
default Duration	getHeartbeat() Maximum time between heart beats.
default Map<String,Object>	getMetricDimensions() The dimensions to attach to metrics.
default String	getMetricPrefixPlural() Prefix for plural metric names of activity actions.
default String	getMetricPrefixSingular() Prefix for singular metric names of activity actions.
default Map<String,Object>	getParameters() Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
default List<PolicyStatement>	getPolicyStatements() Additional policy statements to add to the execution role.
String	getResourceArn() The resource that represents the work to be executed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getResourceArn

@Stability(value=Stable)
 @NotNull
String getResourceArn()

The resource that represents the work to be executed.

Either the ARN of a Lambda Function or Activity, or a special ARN.

getHeartbeat

@Stability(value=Stable)
 @Nullable
default Duration getHeartbeat()

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.

Default: No heart beat timeout

getMetricDimensions

@Stability(value=Stable)
 @Nullable
default Map<String,Object> getMetricDimensions()

The dimensions to attach to metrics.

Default: No metrics

getMetricPrefixPlural

@Stability(value=Stable)
 @Nullable
default String getMetricPrefixPlural()

Prefix for plural metric names of activity actions.

Default: No such metrics

getMetricPrefixSingular

@Stability(value=Stable)
 @Nullable
default String getMetricPrefixSingular()

Prefix for singular metric names of activity actions.

Default: No such metrics

getParameters

@Stability(value=Stable)
 @Nullable
default Map<String,Object> getParameters()

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.

Default: No parameters

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters

getPolicyStatements

@Stability(value=Stable)
 @Nullable
default List<PolicyStatement> getPolicyStatements()

Additional policy statements to add to the execution role.

Default: No policy roles

builder

@Stability(value=Stable)
static StepFunctionsTaskConfig.Builder builder()

Returns:

a StepFunctionsTaskConfig.Builder of StepFunctionsTaskConfig