Class WaiterStateMachineProps

Initialization properties for the WaiterStateMachine construct.

Inheritance
System.Object
WaiterStateMachineProps
Namespace: Amazon.CDK.CustomResources
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class WaiterStateMachineProps : Object, IWaiterStateMachineProps
Syntax (vb)
Public Class WaiterStateMachineProps
    Inherits Object
    Implements IWaiterStateMachineProps
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.Lambda;
using Amazon.CDK.AWS.Logs;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.CustomResources;

Function function_;
LogGroup logGroup;

var waiterStateMachineProps = new WaiterStateMachineProps {
    BackoffRate = 123,
    Interval = Duration.Minutes(30),
    IsCompleteHandler = function_,
    MaxAttempts = 123,
    TimeoutHandler = function_,

    // the properties below are optional
    DisableLogging = false,
    LogOptions = new LogOptions {
        Destination = logGroup,
        IncludeExecutionData = false,
        Level = LogLevel.OFF
    }
};

Synopsis

Constructors

WaiterStateMachineProps()

Properties

BackoffRate

Backoff between attempts.
DisableLogging

Whether logging for the state machine is disabled.
Interval

The interval to wait between attempts.
IsCompleteHandler

The main handler that notifies if the waiter to decide 'complete' or 'incomplete'.
LogOptions

Defines what execution history events are logged and where they are logged.
MaxAttempts

Number of attempts.
TimeoutHandler

The handler to call if the waiter times out and is incomplete.

Constructors

WaiterStateMachineProps()

public WaiterStateMachineProps()

Properties

BackoffRate

Backoff between attempts.

public double BackoffRate { get; set; }
Property Value

System.Double

DisableLogging

Whether logging for the state machine is disabled.

public Nullable<bool> DisableLogging { get; set; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: - false

Interval

The interval to wait between attempts.

public Duration Interval { get; set; }
Property Value

Duration

IsCompleteHandler

The main handler that notifies if the waiter to decide 'complete' or 'incomplete'.

public IFunction IsCompleteHandler { get; set; }
Property Value

IFunction

LogOptions

Defines what execution history events are logged and where they are logged.

public ILogOptions LogOptions { get; set; }
Property Value

ILogOptions

Remarks

Default: - A default log group will be created if logging is enabled.

MaxAttempts

Number of attempts.

public double MaxAttempts { get; set; }
Property Value

System.Double

TimeoutHandler

The handler to call if the waiter times out and is incomplete.

public IFunction TimeoutHandler { get; set; }
Property Value

IFunction

Implements