You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SWF::Types::WorkflowExecutionConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

The configuration settings for a workflow execution including timeout values, tasklist etc. These configuration settings are determined from the defaults specified when registering the workflow type and those specified when starting the workflow execution.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#child_policy ⇒ String

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

    Possible values:

    • TERMINATE
    • REQUEST_CANCEL
    • ABANDON

Returns:

  • (String) —

    The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

#execution_start_to_close_timeout ⇒ String

The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Returns:

  • (String) —

    The total duration for this workflow execution.

#lambda_role ⇒ String

The IAM role attached to the child workflow execution.

Returns:

  • (String) —

    The IAM role attached to the child workflow execution.

#task_list ⇒ Types::TaskList

The task list used for the decision tasks generated for this workflow execution.

Returns:

  • (Types::TaskList) —

    The task list used for the decision tasks generated for this workflow execution.

#task_priority ⇒ String

The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java\'s Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Returns:

  • (String) —

    The priority assigned to decision tasks for this workflow execution.

#task_start_to_close_timeout ⇒ String

The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Returns:

  • (String) —

    The maximum duration allowed for decision tasks for this workflow execution.