Skip to content
v2.274.0

DurableConfigProperty Struct ​

Configuration settings for durable functions , including execution timeout and retention period for execution history.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const durableConfigProperty: lambda.CfnFunction.DurableConfigProperty = {
  executionTimeout: 123,

  // the properties below are optional
  kmsKeyArn: 'kmsKeyArn',
  retentionPeriodInDays: 123,
};

Properties ​

executionTimeoutnumberexecution_timeoutint | floatexecutionTimeoutNumberExecutionTimeoutdoubleExecutionTimeout*float64required#
The maximum time (in seconds) that a durable execution can run before timing out.

This timeout applies to the entire durable execution, not individual function invocations.

kmsKeyArnstringkms_key_arnstrkmsKeyArnStringKmsKeyArnstringKmsKeyArn*string#
The ARN of the KMSlong (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.
retentionPeriodInDaysnumberretention_period_in_daysint | floatretentionPeriodInDaysNumberRetentionPeriodInDaysdoubleRetentionPeriodInDays*float64= 14#
The number of days to retain execution history after a durable execution completes.

After this period, execution history is no longer available through the GetDurableExecutionHistory API.