Struct aws_sdk_ssm::types::builders::StepExecutionBuilder

#[non_exhaustive]
pub struct StepExecutionBuilder { /* private fields */ }

A builder for StepExecution.

Implementations

impl StepExecutionBuilder

pub fn step_name(self, input: impl Into<String>) -> Self

The name of this execution step.

pub fn set_step_name(self, input: Option<String>) -> Self

The name of this execution step.

pub fn action(self, input: impl Into<String>) -> Self

The action this step performs. The action determines the behavior of the step.

pub fn set_action(self, input: Option<String>) -> Self

The action this step performs. The action determines the behavior of the step.

pub fn timeout_seconds(self, input: i64) -> Self

The timeout seconds of the step.

pub fn set_timeout_seconds(self, input: Option<i64>) -> Self

The timeout seconds of the step.

pub fn on_failure(self, input: impl Into<String>) -> Self

The action to take if the step fails. The default value is Abort.

pub fn set_on_failure(self, input: Option<String>) -> Self

The action to take if the step fails. The default value is Abort.

pub fn max_attempts(self, input: i32) -> Self

The maximum number of tries to run the action of the step. The default value is 1.

pub fn set_max_attempts(self, input: Option<i32>) -> Self

The maximum number of tries to run the action of the step. The default value is 1.

pub fn execution_start_time(self, input: DateTime) -> Self

If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field isn't populated.

pub fn set_execution_start_time(self, input: Option<DateTime>) -> Self

If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field isn't populated.

pub fn execution_end_time(self, input: DateTime) -> Self

If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.

pub fn set_execution_end_time(self, input: Option<DateTime>) -> Self

If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.

pub fn step_status(self, input: AutomationExecutionStatus) -> Self

The execution status for this step.

pub fn set_step_status(self, input: Option<AutomationExecutionStatus>) -> Self

The execution status for this step.

pub fn response_code(self, input: impl Into<String>) -> Self

The response code returned by the execution of the step.

pub fn set_response_code(self, input: Option<String>) -> Self

The response code returned by the execution of the step.

pub fn inputs(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to inputs.

To override the contents of this collection use set_inputs.

Fully-resolved values passed into the step before execution.

pub fn set_inputs(self, input: Option<HashMap<String, String>>) -> Self

Fully-resolved values passed into the step before execution.

pub fn outputs(self, k: impl Into<String>, v: Vec<String>) -> Self

Adds a key-value pair to outputs.

To override the contents of this collection use set_outputs.

Returned values from the execution of the step.

pub fn set_outputs(self, input: Option<HashMap<String, Vec<String>>>) -> Self

Returned values from the execution of the step.

pub fn response(self, input: impl Into<String>) -> Self

A message associated with the response code for an execution.

pub fn set_response(self, input: Option<String>) -> Self

A message associated with the response code for an execution.

pub fn failure_message(self, input: impl Into<String>) -> Self

If a step failed, this message explains why the execution failed.

pub fn set_failure_message(self, input: Option<String>) -> Self

If a step failed, this message explains why the execution failed.

pub fn failure_details(self, input: FailureDetails) -> Self

Information about the Automation failure.

pub fn set_failure_details(self, input: Option<FailureDetails>) -> Self

Information about the Automation failure.

pub fn step_execution_id(self, input: impl Into<String>) -> Self

The unique ID of a step execution.

pub fn set_step_execution_id(self, input: Option<String>) -> Self

The unique ID of a step execution.

pub fn overridden_parameters(self, k: impl Into<String>, v: Vec<String>) -> Self

Adds a key-value pair to overridden_parameters.

To override the contents of this collection use set_overridden_parameters.

A user-specified list of parameters to override when running a step.

pub fn set_overridden_parameters( self, input: Option<HashMap<String, Vec<String>>> ) -> Self

A user-specified list of parameters to override when running a step.

pub fn is_end(self, input: bool) -> Self

The flag which can be used to end automation no matter whether the step succeeds or fails.

pub fn set_is_end(self, input: Option<bool>) -> Self

The flag which can be used to end automation no matter whether the step succeeds or fails.

pub fn next_step(self, input: impl Into<String>) -> Self

The next step after the step succeeds.

pub fn set_next_step(self, input: Option<String>) -> Self

The next step after the step succeeds.

pub fn is_critical(self, input: bool) -> Self

The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

pub fn set_is_critical(self, input: Option<bool>) -> Self

The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

pub fn valid_next_steps(self, input: impl Into<String>) -> Self

Appends an item to valid_next_steps.

To override the contents of this collection use set_valid_next_steps.

Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.

pub fn set_valid_next_steps(self, input: Option<Vec<String>>) -> Self

Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.

pub fn targets(self, input: Target) -> Self

Appends an item to targets.

To override the contents of this collection use set_targets.

The targets for the step execution.

pub fn set_targets(self, input: Option<Vec<Target>>) -> Self

The targets for the step execution.

pub fn target_location(self, input: TargetLocation) -> Self

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

pub fn set_target_location(self, input: Option<TargetLocation>) -> Self

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

pub fn triggered_alarms(self, input: AlarmStateInformation) -> Self

Appends an item to triggered_alarms.

To override the contents of this collection use set_triggered_alarms.

The CloudWatch alarms that were invoked by the automation.

pub fn set_triggered_alarms( self, input: Option<Vec<AlarmStateInformation>> ) -> Self

The CloudWatch alarms that were invoked by the automation.

pub fn build(self) -> StepExecution

Consumes the builder and constructs a StepExecution.

Trait Implementations

impl Clone for StepExecutionBuilder

fn clone(&self) -> StepExecutionBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StepExecutionBuilder

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

Formats the value using the given formatter.

impl Default for StepExecutionBuilder

fn default() -> StepExecutionBuilder

Returns the “default value” for a type.

impl PartialEq<StepExecutionBuilder> for StepExecutionBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for StepExecutionBuilder