Interface ITaskStateBaseOptions

Base options for all task states.

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ITaskStateBaseOptions

Syntax (vb)

Public Interface ITaskStateBaseOptions

Remarks

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;
            using Amazon.CDK.AWS.StepFunctions;

            TaskRole taskRole;
            Timeout timeout;

            var taskStateBaseOptions = new TaskStateBaseOptions {
                Credentials = new Credentials {
                    Role = taskRole
                },
                Heartbeat = Duration.Minutes(30),
                HeartbeatTimeout = timeout,
                IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
                TaskTimeout = timeout,
                Timeout = Duration.Minutes(30)
            };

Synopsis

Properties

Credentials	Credentials for an IAM Role that the State Machine assumes for executing the task.
Heartbeat	(deprecated) Timeout for the heartbeat.
HeartbeatTimeout	Timeout for the heartbeat.
IntegrationPattern	AWS Step Functions integrates with services directly in the Amazon States Language.
TaskTimeout	Timeout for the task.
Timeout	(deprecated) Timeout for the task.

Properties

Credentials

Credentials for an IAM Role that the State Machine assumes for executing the task.

ICredentials? Credentials { get; }

Property Value

ICredentials

Remarks

This enables cross-account resource invocations.

Default: - None (Task is executed using the State Machine's execution role)

See: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

Heartbeat

(deprecated) Timeout for the heartbeat.

[Obsolete("use `heartbeatTimeout`")]
Duration? Heartbeat { get; }

Property Value

Duration

Remarks

Default: - None

Stability: Deprecated

HeartbeatTimeout

Timeout for the heartbeat.

Timeout? HeartbeatTimeout { get; }

Property Value

Timeout

Remarks

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

IntegrationPattern

AWS Step Functions integrates with services directly in the Amazon States Language.

IntegrationPattern? IntegrationPattern { get; }

Property Value

IntegrationPattern?

Remarks

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Default: - IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html

TaskTimeout

Timeout for the task.

Timeout? TaskTimeout { get; }

Property Value

Timeout

Remarks

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

Timeout

(deprecated) Timeout for the task.

[Obsolete("use `taskTimeout`")]
Duration? Timeout { get; }

Property Value

Duration

Remarks

Default: - None

Stability: Deprecated