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

Properties that define what kind of task should be created.

Parameters

resource_arn (str) – 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]) – 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]]) – The dimensions to attach to metrics. Default: No metrics
metric_prefix_plural (Optional[str]) – Prefix for plural metric names of activity actions. Default: No such metrics
metric_prefix_singular (Optional[str]) – Prefix for singular metric names of activity actions. Default: No such metrics
parameters (Optional[Mapping[str, Any]]) – 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[List[PolicyStatement]]) – Additional policy statements to add to the execution role. Default: No policy roles

Attributes

heartbeat¶

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
Return type: Optional[Duration]

metric_dimensions¶

The dimensions to attach to metrics.

Default: No metrics
Return type: Optional[Mapping[str, Any]]

metric_prefix_plural¶

Prefix for plural metric names of activity actions.

Default: No such metrics
Return type: Optional[str]

metric_prefix_singular¶

Prefix for singular metric names of activity actions.

Default: No such metrics
Return type: Optional[str]

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.

Default: No parameters
See: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters
Return type: Optional[Mapping[str, Any]]

policy_statements¶

Additional policy statements to add to the execution role.

Default: No policy roles
Return type: Optional[List[PolicyStatement]]

resource_arn¶

The resource that represents the work to be executed.

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

Return type: str