GradientEdge CDK Utils
    Preparing search index...

    Interface SfnStateMachineProps

    interface SfnStateMachineProps {
        comment?: string;
        definition?: IChainable;
        definitionBody?: DefinitionBody;
        definitionSubstitutions?: { [key: string]: string };
        encryptionConfiguration?: EncryptionConfiguration;
        logs?: LogOptions;
        queryLanguage?: QueryLanguage;
        removalPolicy?: RemovalPolicy;
        role?: IRole;
        stateMachineName?: string;
        stateMachineType?: StateMachineType;
        timeout?: Duration;
        tracingEnabled?: boolean;
    }

    Hierarchy

    • StateMachineProps
      • SfnStateMachineProps
    Index

    Properties

    comment? definition? definitionBody? definitionSubstitutions? encryptionConfiguration? logs? queryLanguage? removalPolicy? role? stateMachineName? stateMachineType? timeout? tracingEnabled?

    Properties

    comment?: string

    Comment that describes this state machine

    - No comment
    definition?: IChainable

    Definition for this state machine

    use definitionBody: DefinitionBody.fromChainable()

    definitionBody?: DefinitionBody

    Definition for this state machine

    definitionSubstitutions?: { [key: string]: string }

    substitutions for the definition body as a key-value map

    encryptionConfiguration?: EncryptionConfiguration

    Configures server-side encryption of the state machine definition and execution history.

    - data is transparently encrypted using an AWS owned key
    logs?: LogOptions

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

    No logging
    queryLanguage?: QueryLanguage

    The name of the query language used by the state machine. If the state does not contain a queryLanguage field, then it will use the query language specified in this queryLanguage field.

    - JSON_PATH
    removalPolicy?: RemovalPolicy

    The removal policy to apply to state machine

    RemovalPolicy.DESTROY
    role?: IRole

    The execution role for the state machine service

    A role is automatically created
    stateMachineName?: string

    A name for the state machine

    A name is automatically generated
    stateMachineType?: StateMachineType

    Type of the state machine

    StateMachineType.STANDARD
    timeout?: Duration

    Maximum run time for this state machine

    No timeout
    tracingEnabled?: boolean

    Specifies whether Amazon X-Ray tracing is enabled for this state machine.

    false

    Settings

    Member Visibility

    On This Page

    Properties