swf/aws.sdk.kotlin.services.swf.model/StartChildWorkflowExecutionDecisionAttributes

StartChildWorkflowExecutionDecisionAttributes

class StartChildWorkflowExecutionDecisionAttributes

Provides the details of the StartChildWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.

tagList.member.N – The key is "swf:tagList.N" where N is the tag number from 0 to 4, inclusive.
taskList – String constraint. The key is swf:taskList.name.
workflowType.name – String constraint. The key is swf:workflowType.name.
workflowType.version – String constraint. The key is swf:workflowType.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Types

Builder

class Builder

Companion

object Companion

Properties

childPolicy

val childPolicy: ChildPolicy?

If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

control

val control: String?

The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.

executionStartToCloseTimeout

val executionStartToCloseTimeout: String?

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

input

val input: String?

The input to be provided to the workflow execution.

lambdaRole

val lambdaRole: String?

The IAM role attached to the child workflow execution.

tagList

val tagList: List<String>?

The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

taskList

val taskList: TaskList?

The name of the task list to be used for decision tasks of the child workflow execution.

taskPriority

val taskPriority: String?

A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

taskStartToCloseTimeout

val taskStartToCloseTimeout: String?

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

workflowId

val workflowId: String

The workflowId of the workflow execution.

workflowType

val workflowType: WorkflowType?

The type of the workflow execution to be started.

Functions

copy

inline fun copy(block: StartChildWorkflowExecutionDecisionAttributes.Builder.() -> Unit = {}): StartChildWorkflowExecutionDecisionAttributes

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String