Struct WorkflowExecutionConfiguration

#[non_exhaustive]
pub struct WorkflowExecutionConfiguration {
    pub task_start_to_close_timeout: String,
    pub execution_start_to_close_timeout: String,
    pub task_list: Option<TaskList>,
    pub task_priority: Option<String>,
    pub child_policy: ChildPolicy,
    pub lambda_role: Option<String>,
}

The configuration settings for a workflow execution including timeout values, tasklist etc. These configuration settings are determined from the defaults specified when registering the workflow type and those specified when starting the workflow execution.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

task_start_to_close_timeout: String

The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

execution_start_to_close_timeout: String

The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

task_list: Option<TaskList>

The task list used for the decision tasks generated for this workflow execution.

task_priority: Option<String>

The priority assigned to decision tasks for this workflow execution. 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.

child_policy: ChildPolicy

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

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.

lambda_role: Option<String>

The IAM role attached to the child workflow execution.

Implementations

impl WorkflowExecutionConfiguration

pub fn task_start_to_close_timeout(&self) -> &str

The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

pub fn execution_start_to_close_timeout(&self) -> &str

The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

pub fn task_list(&self) -> Option<&TaskList>

The task list used for the decision tasks generated for this workflow execution.

pub fn task_priority(&self) -> Option<&str>

The priority assigned to decision tasks for this workflow execution. 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.

pub fn child_policy(&self) -> &ChildPolicy

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

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.

pub fn lambda_role(&self) -> Option<&str>

The IAM role attached to the child workflow execution.

impl WorkflowExecutionConfiguration

pub fn builder() -> WorkflowExecutionConfigurationBuilder

Creates a new builder-style object to manufacture WorkflowExecutionConfiguration.

Trait Implementations

impl Clone for WorkflowExecutionConfiguration

fn clone(&self) -> WorkflowExecutionConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WorkflowExecutionConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for WorkflowExecutionConfiguration

fn eq(&self, other: &WorkflowExecutionConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WorkflowExecutionConfiguration