Class: Aws::SWF::Types::RegisterWorkflowTypeInput

Inherits:

Struct

Object
Struct
Aws::SWF::Types::RegisterWorkflowTypeInput

show all

Defined in:: gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb

Constant Summary collapse

SENSITIVE =

[]

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 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.

Returns:

(String)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3839

class RegisterWorkflowTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :default_task_start_to_close_timeout,
  :default_execution_start_to_close_timeout,
  :default_task_list,
  :default_task_priority,
  :default_child_policy,
  :default_lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3839

class RegisterWorkflowTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :default_task_start_to_close_timeout,
  :default_execution_start_to_close_timeout,
  :default_task_list,
  :default_task_priority,
  :default_child_policy,
  :default_lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#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 you start 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)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3839

class RegisterWorkflowTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :default_task_start_to_close_timeout,
  :default_execution_start_to_close_timeout,
  :default_task_list,
  :default_task_priority,
  :default_child_policy,
  :default_lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(Types::TaskList)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3839

class RegisterWorkflowTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :default_task_start_to_close_timeout,
  :default_execution_start_to_close_timeout,
  :default_task_list,
  :default_task_priority,
  :default_child_policy,
  :default_lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3839

class RegisterWorkflowTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :default_task_start_to_close_timeout,
  :default_execution_start_to_close_timeout,
  :default_task_list,
  :default_task_priority,
  :default_child_policy,
  :default_lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3839

class RegisterWorkflowTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :default_task_start_to_close_timeout,
  :default_execution_start_to_close_timeout,
  :default_task_list,
  :default_task_priority,
  :default_child_policy,
  :default_lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

Textual description of the workflow type.

Returns:

(String)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3839

class RegisterWorkflowTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :default_task_start_to_close_timeout,
  :default_execution_start_to_close_timeout,
  :default_task_list,
  :default_task_priority,
  :default_child_policy,
  :default_lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#domain ⇒ `String`

The name of the domain in which to register the workflow type.

Returns:

(String)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3839

class RegisterWorkflowTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :default_task_start_to_close_timeout,
  :default_execution_start_to_close_timeout,
  :default_task_list,
  :default_task_priority,
  :default_child_policy,
  :default_lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the workflow type.

The specified string 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.

Returns:

(String)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3839

class RegisterWorkflowTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :default_task_start_to_close_timeout,
  :default_execution_start_to_close_timeout,
  :default_task_list,
  :default_task_priority,
  :default_child_policy,
  :default_lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ `String`

The version of the workflow type.

The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.

The specified string 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.

Returns:

(String)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3839

class RegisterWorkflowTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :default_task_start_to_close_timeout,
  :default_execution_start_to_close_timeout,
  :default_task_list,
  :default_task_priority,
  :default_child_policy,
  :default_lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::SWF::Types::RegisterWorkflowTypeInput

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#default_child_policy ⇒ String

#default_execution_start_to_close_timeout ⇒ String

#default_lambda_role ⇒ String

#default_task_list ⇒ Types::TaskList

#default_task_priority ⇒ String

#default_task_start_to_close_timeout ⇒ String

#description ⇒ String

#domain ⇒ String

#name ⇒ String

#version ⇒ String

#default_child_policy ⇒ `String`

#default_execution_start_to_close_timeout ⇒ `String`

#default_lambda_role ⇒ `String`

#default_task_list ⇒ `Types::TaskList`

#default_task_priority ⇒ `String`

#default_task_start_to_close_timeout ⇒ `String`

#description ⇒ `String`

#domain ⇒ `String`

#name ⇒ `String`

#version ⇒ `String`