Class StepFunctionsTaskConfig
(deprecated) Properties that define what kind of task should be created.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.AWS.StepFunctions.dll
Syntax (csharp)
public class StepFunctionsTaskConfig : Object, IStepFunctionsTaskConfig
Syntax (vb)
Public Class StepFunctionsTaskConfig
Inherits Object
Implements IStepFunctionsTaskConfig
Remarks
Stability: Deprecated
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK;
var metricDimensions;
var parameters;
PolicyStatement policyStatement;
var stepFunctionsTaskConfig = new StepFunctionsTaskConfig {
ResourceArn = "resourceArn",
// the properties below are optional
Heartbeat = Duration.Minutes(30),
MetricDimensions = new Dictionary<string, object> {
{ "metricDimensionsKey", metricDimensions }
},
MetricPrefixPlural = "metricPrefixPlural",
MetricPrefixSingular = "metricPrefixSingular",
Parameters = new Dictionary<string, object> {
{ "parametersKey", parameters }
},
PolicyStatements = new [] { policyStatement }
};
Synopsis
Constructors
StepFunctionsTaskConfig() |
Properties
Heartbeat | (deprecated) Maximum time between heart beats. |
MetricDimensions | (deprecated) The dimensions to attach to metrics. |
MetricPrefixPlural | (deprecated) Prefix for plural metric names of activity actions. |
MetricPrefixSingular | (deprecated) Prefix for singular metric names of activity actions. |
Parameters | (deprecated) Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input. |
PolicyStatements | (deprecated) Additional policy statements to add to the execution role. |
ResourceArn | (deprecated) The resource that represents the work to be executed. |
Constructors
StepFunctionsTaskConfig()
public StepFunctionsTaskConfig()
Properties
Heartbeat
(deprecated) Maximum time between heart beats.
public Duration Heartbeat { get; set; }
Property Value
Remarks
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
MetricDimensions
(deprecated) The dimensions to attach to metrics.
public IDictionary<string, object> MetricDimensions { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
Default: No metrics
Stability: Deprecated
MetricPrefixPlural
(deprecated) Prefix for plural metric names of activity actions.
public string MetricPrefixPlural { get; set; }
Property Value
System.String
Remarks
Default: No such metrics
Stability: Deprecated
MetricPrefixSingular
(deprecated) Prefix for singular metric names of activity actions.
public string MetricPrefixSingular { get; set; }
Property Value
System.String
Remarks
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.
public IDictionary<string, object> Parameters { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
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
Stability: Deprecated
PolicyStatements
(deprecated) Additional policy statements to add to the execution role.
public PolicyStatement[] PolicyStatements { get; set; }
Property Value
Remarks
Default: No policy roles
Stability: Deprecated
ResourceArn
(deprecated) The resource that represents the work to be executed.
public string ResourceArn { get; set; }
Property Value
System.String
Remarks
Either the ARN of a Lambda Function or Activity, or a special ARN.
Stability: Deprecated