Class: AWSCDK::Lambda::CfnFunction::DurableConfigProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Lambda::CfnFunction::DurableConfigProperty

Defined in:

lambda/cfn_function.rb

Overview

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

See Also:

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

Instance Attribute Summary

• #execution_timeout ⇒ Numeric readonly

  The maximum time (in seconds) that a durable execution can run before timing out.

• #retention_period_in_days ⇒ Numeric^? readonly

  The number of days to retain execution history after a durable execution completes.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(execution_timeout:, retention_period_in_days: nil) ⇒ DurableConfigProperty constructor

  A new instance of DurableConfigProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(execution_timeout:, retention_period_in_days: nil) ⇒ DurableConfigProperty

Returns a new instance of DurableConfigProperty.

Parameters:

• execution_timeout (Numeric) —

  The maximum time (in seconds) that a durable execution can run before timing out.

• retention_period_in_days (Numeric, nil) (defaults to: nil) —

  The number of days to retain execution history after a durable execution completes.

# File 'lambda/cfn_function.rb', line 1149

def initialize(execution_timeout:, retention_period_in_days: nil)
  @execution_timeout = execution_timeout
  Jsii::Type.check_type(@execution_timeout, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "executionTimeout")
  @retention_period_in_days = retention_period_in_days
  Jsii::Type.check_type(@retention_period_in_days, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "retentionPeriodInDays") unless @retention_period_in_days.nil?
end

Instance Attribute Details

#execution_timeout ⇒ Numeric (readonly)

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.

Returns:

• (Numeric)

See Also:

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

# File 'lambda/cfn_function.rb', line 1162

def execution_timeout
  @execution_timeout
end

#retention_period_in_days ⇒ Numeric^? (readonly)

Note:

Default: - 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.

Returns:

• (Numeric, nil)

See Also:

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

# File 'lambda/cfn_function.rb', line 1170

def retention_period_in_days
  @retention_period_in_days
end

Class Method Details

.jsii_properties ⇒ Object

# File 'lambda/cfn_function.rb', line 1172

def self.jsii_properties
  {
    :execution_timeout => "executionTimeout",
    :retention_period_in_days => "retentionPeriodInDays",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'lambda/cfn_function.rb', line 1179

def to_jsii
  result = {}
  result.merge!({
    "executionTimeout" => @execution_timeout,
    "retentionPeriodInDays" => @retention_period_in_days,
  })
  result.compact
end