StepFunctionsTaskConfig

class aws_cdk.aws_stepfunctions.StepFunctionsTaskConfig(*, resource_arn, heartbeat=None, metric_dimensions=None, metric_prefix_plural=None, metric_prefix_singular=None, parameters=None, policy_statements=None)

Bases: object

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

Parameters
  • resource_arn (str) – (deprecated) The resource that represents the work to be executed. Either the ARN of a Lambda Function or Activity, or a special ARN.

  • heartbeat (Optional[Duration]) – (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

  • metric_dimensions (Optional[Mapping[str, Any]]) – (deprecated) The dimensions to attach to metrics. Default: No metrics

  • metric_prefix_plural (Optional[str]) – (deprecated) Prefix for plural metric names of activity actions. Default: No such metrics

  • metric_prefix_singular (Optional[str]) – (deprecated) Prefix for singular metric names of activity actions. Default: No such metrics

  • parameters (Optional[Mapping[str, Any]]) – (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

  • policy_statements (Optional[Sequence[PolicyStatement]]) – (deprecated) Additional policy statements to add to the execution role. Default: No policy roles

Deprecated

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

Stability

deprecated

Attributes

heartbeat

(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

Stability

deprecated

Return type

Optional[Duration]

metric_dimensions

(deprecated) The dimensions to attach to metrics.

Default

No metrics

Stability

deprecated

Return type

Optional[Mapping[str, Any]]

metric_prefix_plural

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

Default

No such metrics

Stability

deprecated

Return type

Optional[str]

metric_prefix_singular

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

Default

No such metrics

Stability

deprecated

Return type

Optional[str]

parameters

(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

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

Stability

deprecated

Return type

Optional[Mapping[str, Any]]

policy_statements

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

Default

No policy roles

Stability

deprecated

Return type

Optional[List[PolicyStatement]]

resource_arn

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

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

Stability

deprecated

Return type

str