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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb

Overview

Note:

When making an API call, you may pass RegisterWorkflowTypeInput data as a 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

Instance Attribute Details

#default_child_policyString

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)


4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 4105

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)
  include Aws::Structure
end

#default_execution_start_to_close_timeoutString

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)


4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 4105

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)
  include Aws::Structure
end

#default_lambda_roleString

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 http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

Returns:

  • (String)


4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 4105

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)
  include Aws::Structure
end

#default_task_listTypes::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:



4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 4105

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)
  include Aws::Structure
end

#default_task_priorityString

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)


4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 4105

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)
  include Aws::Structure
end

#default_task_start_to_close_timeoutString

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)


4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 4105

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)
  include Aws::Structure
end

#descriptionString

Textual description of the workflow type.

Returns:

  • (String)


4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 4105

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)
  include Aws::Structure
end

#domainString

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

Returns:

  • (String)


4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 4105

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)
  include Aws::Structure
end

#nameString

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 contain the literal string arn.

Returns:

  • (String)


4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 4105

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)
  include Aws::Structure
end

#versionString

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 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 contain the literal string arn.

Returns:

  • (String)


4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 4105

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)
  include Aws::Structure
end