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

Class: Aws::SWF::Types::WorkflowTypeConfiguration

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

Overview

The configuration settings of a workflow type.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#default_child_policy ⇒ String

The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

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 default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

#default_execution_start_to_close_timeout ⇒ String

The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

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 default maximum duration, specified when registering the workflow type, for executions of this workflow type.

#default_lambda_role ⇒ String

The default IAM role attached to this workflow type.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don\'t specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

Returns:

  • (String) —

    The default IAM role attached to this workflow type.

#default_task_list ⇒ Types::TaskList

The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

Returns:

  • (Types::TaskList) —

    The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type.

#default_task_priority ⇒ String

The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

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 default task priority, specified when registering the workflow type, for all decision tasks of this workflow type.

#default_task_start_to_close_timeout ⇒ String

The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn\'tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

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 default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure.