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 timeoutmetric_dimensions (
Optional
[Mapping
[str
,Any
]]) – (deprecated) The dimensions to attach to metrics. Default: No metricsmetric_prefix_plural (
Optional
[str
]) – (deprecated) Prefix for plural metric names of activity actions. Default: No such metricsmetric_prefix_singular (
Optional
[str
]) – (deprecated) Prefix for singular metric names of activity actions. Default: No such metricsparameters (
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 theparameters
property which is configured directly on the Task state. Default: No parameterspolicy_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 byTaskStateBase
.- Stability:
deprecated
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iam as iam import aws_cdk.aws_stepfunctions as stepfunctions import aws_cdk.core as cdk # metric_dimensions: Any # parameters: Any # policy_statement: iam.PolicyStatement step_functions_task_config = stepfunctions.StepFunctionsTaskConfig( resource_arn="resourceArn", # the properties below are optional heartbeat=cdk.Duration.minutes(30), metric_dimensions={ "metric_dimensions_key": metric_dimensions }, metric_prefix_plural="metricPrefixPlural", metric_prefix_singular="metricPrefixSingular", parameters={ "parameters_key": parameters }, policy_statements=[policy_statement] )
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
- metric_dimensions
(deprecated) The dimensions to attach to metrics.
- Default:
No metrics
- Stability:
deprecated
- metric_prefix_plural
(deprecated) Prefix for plural metric names of activity actions.
- Default:
No such metrics
- Stability:
deprecated
- metric_prefix_singular
(deprecated) Prefix for singular metric names of activity actions.
- Default:
No such metrics
- Stability:
deprecated
- 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:
- Stability:
deprecated
- policy_statements
(deprecated) Additional policy statements to add to the execution role.
- Default:
No policy roles
- Stability:
deprecated
- 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