interface StepFunctionsTaskConfig ⚠️

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.StepFunctionsTaskConfig
Java	software.amazon.awscdk.services.stepfunctions.StepFunctionsTaskConfig
Python	aws_cdk.aws_stepfunctions.StepFunctionsTaskConfig
TypeScript (source)	@aws-cdk/aws-stepfunctions » StepFunctionsTaskConfig

⚠️ Deprecated: used by IStepFunctionsTask. IStepFunctionsTask is deprecated and replaced by TaskStateBase.

Obtainable from EcsRunTaskBase.bind(), InvokeActivity.bind(), InvokeFunction.bind(), PublishToTopic.bind(), RunBatchJob.bind(), RunGlueJobTask.bind(), RunLambdaTask.bind(), SendToQueue.bind(), StartExecution.bind()

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 * as iam from '@aws-cdk/aws-iam';
import * as stepfunctions from '@aws-cdk/aws-stepfunctions';
import * as cdk from '@aws-cdk/core';

declare const metricDimensions: any;
declare const parameters: any;
declare const policyStatement: iam.PolicyStatement;
const stepFunctionsTaskConfig: stepfunctions.StepFunctionsTaskConfig = {
  resourceArn: 'resourceArn',

  // the properties below are optional
  heartbeat: cdk.Duration.minutes(30),
  metricDimensions: {
    metricDimensionsKey: metricDimensions,
  },
  metricPrefixPlural: 'metricPrefixPlural',
  metricPrefixSingular: 'metricPrefixSingular',
  parameters: {
    parametersKey: parameters,
  },
  policyStatements: [policyStatement],
};

Properties

Name	Type	Description
resourceArn⚠️	string	The resource that represents the work to be executed.
heartbeat?⚠️	Duration	Maximum time between heart beats.
metricDimensions?⚠️	{ [string]: any }	The dimensions to attach to metrics.
metricPrefixPlural?⚠️	string	Prefix for plural metric names of activity actions.
metricPrefixSingular?⚠️	string	Prefix for singular metric names of activity actions.
parameters?⚠️	{ [string]: any }	Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
policyStatements?⚠️	PolicyStatement[]	Additional policy statements to add to the execution role.

---

resourceArn⚠️

⚠️ Deprecated: used by IStepFunctionsTask. IStepFunctionsTask is deprecated and replaced by TaskStateBase.

Type: string

The resource that represents the work to be executed.

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

---

heartbeat?⚠️

⚠️ Deprecated: used by IStepFunctionsTask. IStepFunctionsTask is deprecated and replaced by TaskStateBase.

Type: Duration (optional, default: No heart beat timeout)

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.

---

metricDimensions?⚠️

⚠️ Deprecated: used by IStepFunctionsTask. IStepFunctionsTask is deprecated and replaced by TaskStateBase.

Type: { [string]: any } (optional, default: No metrics)

The dimensions to attach to metrics.

---

metricPrefixPlural?⚠️

⚠️ Deprecated: used by IStepFunctionsTask. IStepFunctionsTask is deprecated and replaced by TaskStateBase.

Type: string (optional, default: No such metrics)

Prefix for plural metric names of activity actions.

---

metricPrefixSingular?⚠️

⚠️ Deprecated: used by IStepFunctionsTask. IStepFunctionsTask is deprecated and replaced by TaskStateBase.

Type: string (optional, default: No such metrics)

Prefix for singular metric names of activity actions.

---

parameters?⚠️

⚠️ Deprecated: used by IStepFunctionsTask. IStepFunctionsTask is deprecated and replaced by TaskStateBase.

Type: { [string]: any } (optional, default: No 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.

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

---

policyStatements?⚠️

⚠️ Deprecated: used by IStepFunctionsTask. IStepFunctionsTask is deprecated and replaced by TaskStateBase.

Type: PolicyStatement[] (optional, default: No policy roles)

Additional policy statements to add to the execution role.