Skip to content
v2.276.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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lambda as lambda_

durable_config_property = lambda.CfnFunction.DurableConfigProperty(
    execution_timeout=123,

    # the properties below are optional
    kms_key_arn="kmsKeyArn",
    retention_period_in_days=123
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.lambda.*;

DurableConfigProperty durableConfigProperty = DurableConfigProperty.builder()
        .executionTimeout(123)

        // the properties below are optional
        .kmsKeyArn("kmsKeyArn")
        .retentionPeriodInDays(123)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lambda;

var durableConfigProperty = new DurableConfigProperty {
    ExecutionTimeout = 123,

    // the properties below are optional
    KmsKeyArn = "kmsKeyArn",
    RetentionPeriodInDays = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

durableConfigProperty := &DurableConfigProperty{
	ExecutionTimeout: jsii.Number(123),

	// the properties below are optional
	KmsKeyArn: jsii.String("kmsKeyArn"),
	RetentionPeriodInDays: jsii.Number(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.

kmsKeyArnoptionalstringkms_key_arnoptionalstrkmsKeyArnoptionalStringKmsKeyArnoptionalstringKmsKeyArnoptional*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.
retentionPeriodInDaysoptionalnumberretention_period_in_daysoptionalint | floatretentionPeriodInDaysoptionalNumberRetentionPeriodInDaysoptionaldoubleRetentionPeriodInDaysoptional*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.