Package software.amazon.awscdk.services.lambda

Interface CfnFunction.DurableConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFunction.DurableConfigProperty.Jsii$Proxy

Enclosing class:

CfnFunction

@Stability(Stable)
public static interface CfnFunction.DurableConfigProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-durableconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFunction.DurableConfigProperty.Builder	A builder for CfnFunction.DurableConfigProperty
static final class	CfnFunction.DurableConfigProperty.Jsii$Proxy	An implementation for CfnFunction.DurableConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnFunction.DurableConfigProperty.Builder	builder()
Number	getExecutionTimeout()	The maximum time (in seconds) that a durable execution can run before timing out.
default String	getKmsKeyArn()	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.
default Number	getRetentionPeriodInDays()	The number of days to retain execution history after a durable execution completes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExecutionTimeout

@Stability(Stable)
@NotNull
Number getExecutionTimeout()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-durableconfig.html#cfn-lambda-function-durableconfig-executiontimeout

getKmsKeyArn

@Stability(Stable)
@Nullable
default String getKmsKeyArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-durableconfig.html#cfn-lambda-function-durableconfig-kmskeyarn

getRetentionPeriodInDays

@Stability(Stable)
@Nullable
default Number getRetentionPeriodInDays()

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.

Default: - 14

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-durableconfig.html#cfn-lambda-function-durableconfig-retentionperiodindays

builder

@Stability(Stable)
static CfnFunction.DurableConfigProperty.Builder builder()

Returns:

a CfnFunction.DurableConfigProperty.Builder of CfnFunction.DurableConfigProperty