software.amazon.awscdk.services.stepfunctions

Interface StepFunctionsTaskConfig

All Known Implementing Classes:

StepFunctionsTaskConfig.Jsii$Proxy

Deprecated.

used by `IStepFunctionsTask`. `IStepFunctionsTask` is deprecated and replaced by `TaskStateBase`.

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:29.112Z")
 @Deprecated
public interface StepFunctionsTaskConfig

(deprecated) Properties that define what kind of task should be created.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.stepfunctions.*;
 import software.amazon.awscdk.core.*;
 Object metricDimensions;
 Object parameters;
 PolicyStatement policyStatement;
 StepFunctionsTaskConfig stepFunctionsTaskConfig = StepFunctionsTaskConfig.builder()
         .resourceArn("resourceArn")
         // the properties below are optional
         .heartbeat(Duration.minutes(30))
         .metricDimensions(Map.of(
                 "metricDimensionsKey", metricDimensions))
         .metricPrefixPlural("metricPrefixPlural")
         .metricPrefixSingular("metricPrefixSingular")
         .parameters(Map.of(
                 "parametersKey", parameters))
         .policyStatements(List.of(policyStatement))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StepFunctionsTaskConfig.Builder Deprecated.
static class	StepFunctionsTaskConfig.Jsii$Proxy Deprecated.

Method Summary

Modifier and Type	Method and Description
static StepFunctionsTaskConfig.Builder	builder() Deprecated.
default Duration	getHeartbeat() Deprecated.
default java.util.Map<java.lang.String,java.lang.Object>	getMetricDimensions() Deprecated.
default java.lang.String	getMetricPrefixPlural() Deprecated.
default java.lang.String	getMetricPrefixSingular() Deprecated.
default java.util.Map<java.lang.String,java.lang.Object>	getParameters() Deprecated.
default java.util.List<PolicyStatement>	getPolicyStatements() Deprecated.
java.lang.String	getResourceArn() Deprecated.

Method Detail

getResourceArn

@Deprecated
java.lang.String getResourceArn()

Deprecated.

(deprecated) The resource that represents the work to be executed.

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

getHeartbeat

@Deprecated
default Duration getHeartbeat()

Deprecated.

(deprecated) 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

@Deprecated
default java.util.Map<java.lang.String,java.lang.Object> getMetricDimensions()

Deprecated.

(deprecated) The dimensions to attach to metrics.

Default: No metrics

getMetricPrefixPlural

@Deprecated
default java.lang.String getMetricPrefixPlural()

Deprecated.

(deprecated) Prefix for plural metric names of activity actions.

Default: No such metrics

getMetricPrefixSingular

@Deprecated
default java.lang.String getMetricPrefixSingular()

Deprecated.

(deprecated) Prefix for singular metric names of activity actions.

Default: No such metrics

getParameters

@Deprecated
default java.util.Map<java.lang.String,java.lang.Object> getParameters()

Deprecated.

(deprecated) 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

@Deprecated
default java.util.List<PolicyStatement> getPolicyStatements()

Deprecated.

(deprecated) Additional policy statements to add to the execution role.

Default: No policy roles

builder

@Deprecated
static StepFunctionsTaskConfig.Builder builder()

Deprecated.

Returns:

a StepFunctionsTaskConfig.Builder of StepFunctionsTaskConfig