You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SWF::Types::RegisterWorkflowTypeInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::SWF::Types::RegisterWorkflowTypeInput
- Defined in:
- (unknown)
Overview
When passing RegisterWorkflowTypeInput as input to an Aws::Client method, you can use a vanilla Hash:
{
domain: "DomainName", # required
name: "Name", # required
version: "Version", # required
description: "Description",
default_task_start_to_close_timeout: "DurationInSecondsOptional",
default_execution_start_to_close_timeout: "DurationInSecondsOptional",
default_task_list: {
name: "Name", # required
},
default_task_priority: "TaskPriority",
default_child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
default_lambda_role: "Arn",
}
Instance Attribute Summary collapse
-
#default_child_policy ⇒ String
If set, specifies 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
If set, specifies the default maximum duration for executions of this workflow type.
-
#default_lambda_role ⇒ String
The default IAM role attached to this workflow type.
-
#default_task_list ⇒ Types::TaskList
If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type.
-
#default_task_priority ⇒ String
The default task priority to assign to the workflow type.
-
#default_task_start_to_close_timeout ⇒ String
If set, specifies the default maximum duration of decision tasks for this workflow type.
-
#description ⇒ String
Textual description of the workflow type.
-
#domain ⇒ String
The name of the domain in which to register the workflow type.
-
#name ⇒ String
The name of the workflow type.
-
#version ⇒ String
The version of the workflow type.
Instance Attribute Details
#default_child_policy ⇒ String
If set, specifies 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 aWorkflowExecutionCancelRequested
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
#default_execution_start_to_close_timeout ⇒ String
If set, specifies the default maximum duration for executions of this
workflow type. You can override this default when starting an execution
through the StartWorkflowExecution Action or
StartChildWorkflowExecution
Decision.
The duration is specified in seconds; an integer greater than or equal
to 0. Unlike some of the other timeout parameters in Amazon SWF, you
cannot specify a value of \"NONE\" for
defaultExecutionStartToCloseTimeout
; there is a one-year max limit on
the time that a workflow execution can run. Exceeding this limit always
causes the workflow execution to time out.
#default_lambda_role ⇒ String
The default IAM role attached to this workflow type.
#default_task_list ⇒ Types::TaskList
If set, specifies the default task list to use for scheduling decision
tasks for executions of this workflow type. This default is used only if
a task list isn\'t provided when starting the execution through the
StartWorkflowExecution Action or StartChildWorkflowExecution
Decision.
#default_task_priority ⇒ String
The default task priority to assign to the workflow type. If not
assigned, then 0
is used. 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.
#default_task_start_to_close_timeout ⇒ String
If set, specifies the default maximum duration of decision tasks for
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.
#description ⇒ String
Textual description of the workflow type.
#domain ⇒ String
The name of the domain in which to register the workflow type.
#name ⇒ String
The name of the workflow type.
The specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash), |
(vertical bar), or any control
characters (\u0000-\u001f
| \u007f-\u009f
). Also, it must not be
the literal string arn
.
#version ⇒ String
The version of the workflow type.
The specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash), |
(vertical bar), or any control
characters (\u0000-\u001f
| \u007f-\u009f
). Also, it must not be
the literal string arn
.