Skip to content
v2.277.0

Timeout Class ​

Timeout for a task or heartbeat.

Example ​

ts
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),
});
python
tasks.GlueStartJobRun(self, "Task",
    glue_job_name="my-glue-job",
    arguments=sfn.TaskInput.from_object({
        "key": "value"
    }),
    task_timeout=sfn.Timeout.duration(Duration.minutes(30)),
    notify_delay_after=Duration.minutes(5)
)
java
GlueStartJobRun.Builder.create(this, "Task")
        .glueJobName("my-glue-job")
        .arguments(TaskInput.fromObject(Map.of(
                "key", "value")))
        .taskTimeout(Timeout.duration(Duration.minutes(30)))
        .notifyDelayAfter(Duration.minutes(5))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
new GlueStartJobRun(this, "Task", new GlueStartJobRunProps {
    GlueJobName = "my-glue-job",
    Arguments = TaskInput.FromObject(new Dictionary<string, object> {
        { "key", "value" }
    }),
    TaskTimeout = Timeout.Duration(Duration.Minutes(30)),
    NotifyDelayAfter = Duration.Minutes(5)
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
tasks.NewGlueStartJobRun(this, jsii.String("Task"), &GlueStartJobRunProps{
	GlueJobName: jsii.String("my-glue-job"),
	Arguments: sfn.TaskInput_FromObject(map[string]interface{}{
		"key": jsii.String("value"),
	}),
	TaskTimeout: sfn.Timeout_Duration(awscdk.Duration_Minutes(jsii.Number(30))),
	NotifyDelayAfter: awscdk.Duration_*Minutes(jsii.Number(5)),
})

Initializer ​

ts
new Timeout()
python
Timeout()
java
new Timeout()
csharp
new Timeout()
go
NewTimeout()

Properties ​

jsonataExpressionmay be undefinedstringjsonata_expressionmay be undefinedstrjsonataExpressionmay be undefinedStringJsonataExpressionmay be undefinedstringJsonataExpressionmay be undefined*string#
JSONata expression for this timeout.
pathmay be undefinedstringpathmay be undefinedstrpathmay be undefinedStringPathmay be undefinedstringPathmay be undefined*string#
Path for this timeout.
secondsmay be undefinednumbersecondsmay be undefinedint | floatsecondsmay be undefinedNumberSecondsmay be undefineddoubleSecondsmay be undefined*float64#
Seconds for this timeout.

Methods ​

at(path: string): Timeout // chainable@staticmethod def at(path: str) -> Timeoutpublic static Timeout at(String path)public static Timeout At(string path)func At(Path *string) Timeoutstatic#
Use a dynamic timeout specified by a path in the state input.

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

duration(duration: Duration): Timeout // chainable@staticmethod def duration(duration: Duration) -> Timeoutpublic static Timeout duration(Duration duration)public static Timeout Duration(Duration duration)func Duration(Duration Duration) Timeoutstatic#
Use a duration as timeout.
jsonata(jsonataExpression: string): Timeout // chainable@staticmethod def jsonata(jsonata_expression: str) -> Timeoutpublic static Timeout jsonata(String jsonataExpression)public static Timeout Jsonata(string jsonataExpression)func Jsonata(JsonataExpression *string) Timeoutstatic#
Use a dynamic timeout specified by a JSONata expression.

The JSONata expression value must be a positive integer.