aws-cdk-lib.aws_stepfunctions.Timeout

class Timeout

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.Timeout
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#Timeout
Javasoftware.amazon.awscdk.services.stepfunctions.Timeout
Pythonaws_cdk.aws_stepfunctions.Timeout
TypeScript (source)aws-cdk-lib » aws_stepfunctions » Timeout

Timeout for a task or heartbeat.

Example

new tasks.GlueStartJobRun(this, 'Task', {
  glueJobName: 'my-glue-job',
  arguments: sfn.TaskInput.fromObject({
    key: 'value',
  }),
  taskTimeout: sfn.Timeout.duration(Duration.minutes(30)),
  notifyDelayAfter: Duration.minutes(5),
});

Initializer

new Timeout()

Properties

NameTypeDescription
path?stringPath for this timeout.
seconds?numberSeconds for this timeout.

path?

Type: string (optional)

Path for this timeout.


seconds?

Type: number (optional)

Seconds for this timeout.

Methods

NameDescription
static at(path)Use a dynamic timeout specified by a path in the state input.
static duration(duration)Use a duration as timeout.

static at(path)

public static at(path: string): Timeout

Parameters

  • path string

Returns

  • Timeout

Use a dynamic timeout specified by a path in the state input.

The path must select a field whose value is a positive integer.


static duration(duration)

public static duration(duration: Duration): Timeout

Parameters

  • duration Duration

Returns

  • Timeout

Use a duration as timeout.