Struct aws_sdk_ssm::types::builders::RunbookBuilder

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

A builder for Runbook.

Implementations

impl RunbookBuilder

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

The name of the Automation runbook used in a runbook workflow.

This field is required.

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

The name of the Automation runbook used in a runbook workflow.

pub fn get_document_name(&self) -> &Option<String>

The name of the Automation runbook used in a runbook workflow.

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

The version of the Automation runbook used in a runbook workflow.

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

The version of the Automation runbook used in a runbook workflow.

pub fn get_document_version(&self) -> &Option<String>

The version of the Automation runbook used in a runbook workflow.

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

Adds a key-value pair to parameters.

To override the contents of this collection use set_parameters.

The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.

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

The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.

pub fn get_parameters(&self) -> &Option<HashMap<String, Vec<String>>>

The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.

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

The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.

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

The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.

pub fn get_target_parameter_name(&self) -> &Option<String>

The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.

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

Appends an item to targets.

To override the contents of this collection use set_targets.

A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.

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

A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.

pub fn get_targets(&self) -> &Option<Vec<Target>>

A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.

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

Appends an item to target_maps.

To override the contents of this collection use set_target_maps.

A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.

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

A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.

pub fn get_target_maps(&self) -> &Option<Vec<HashMap<String, Vec<String>>>>

A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.

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

The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.

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

The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.

pub fn get_max_concurrency(&self) -> &Option<String>

The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.

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

The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.

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

The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.

pub fn get_max_errors(&self) -> &Option<String>

The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.

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

Appends an item to target_locations.

To override the contents of this collection use set_target_locations.

Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.

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

Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.

pub fn get_target_locations(&self) -> &Option<Vec<TargetLocation>>

Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.

pub fn build(self) -> Result<Runbook, BuildError>

Consumes the builder and constructs a Runbook. This method will fail if any of the following fields are not set:

• document_name

Trait Implementations

impl Clone for RunbookBuilder

fn clone(&self) -> RunbookBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RunbookBuilder

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

Formats the value using the given formatter.

impl Default for RunbookBuilder

fn default() -> RunbookBuilder

Returns the “default value” for a type.

impl PartialEq for RunbookBuilder

fn eq(&self, other: &RunbookBuilder) -> 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 RunbookBuilder