Package 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.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.942Z") @Stability(Deprecated) @Deprecated public interface StepFunctionsTaskConfig extends software.amazon.jsii.JsiiSerializable
Deprecated.
used by IStepFunctionsTask. IStepFunctionsTask is deprecated and replaced by TaskStateBase.
(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();

  • Method Details

    • getResourceArn

      @Stability(Deprecated) @Deprecated @NotNull 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

      @Stability(Deprecated) @Deprecated @Nullable 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

      @Stability(Deprecated) @Deprecated @Nullable default Map<String,Object> getMetricDimensions()
      Deprecated.
      (deprecated) The dimensions to attach to metrics.

      Default: No metrics

    • getMetricPrefixPlural

      @Stability(Deprecated) @Deprecated @Nullable default String getMetricPrefixPlural()
      Deprecated.
      (deprecated) Prefix for plural metric names of activity actions.

      Default: No such metrics

    • getMetricPrefixSingular

      @Stability(Deprecated) @Deprecated @Nullable default String getMetricPrefixSingular()
      Deprecated.
      (deprecated) Prefix for singular metric names of activity actions.

      Default: No such metrics

    • getParameters

      @Stability(Deprecated) @Deprecated @Nullable default Map<String,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:

    • getPolicyStatements

      @Stability(Deprecated) @Deprecated @Nullable default List<PolicyStatement> getPolicyStatements()
      Deprecated.
      (deprecated) Additional policy statements to add to the execution role.

      Default: No policy roles

    • builder

      @Stability(Deprecated) @Deprecated static StepFunctionsTaskConfig.Builder builder()
      Deprecated.
      Returns:
      a StepFunctionsTaskConfig.Builder of StepFunctionsTaskConfig