Struct aws_sdk_ssm::types::Runbook

#[non_exhaustive]
pub struct Runbook {
    pub document_name: String,
    pub document_version: Option<String>,
    pub parameters: Option<HashMap<String, Vec<String>>>,
    pub target_parameter_name: Option<String>,
    pub targets: Option<Vec<Target>>,
    pub target_maps: Option<Vec<HashMap<String, Vec<String>>>>,
    pub max_concurrency: Option<String>,
    pub max_errors: Option<String>,
    pub target_locations: Option<Vec<TargetLocation>>,
}

Information about an Automation runbook used in a runbook workflow in Change Manager.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

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.

document_name: String

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

document_version: Option<String>

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

parameters: Option<HashMap<String, Vec<String>>>

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

target_parameter_name: Option<String>

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

targets: Option<Vec<Target>>

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

target_maps: 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.

max_concurrency: 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.

max_errors: 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.

target_locations: Option<Vec<TargetLocation>>

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

Implementations

impl Runbook

pub fn document_name(&self) -> &str

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

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

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

pub fn 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) -> Option<&str>

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) -> &[Target]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .targets.is_none().

pub fn target_maps(&self) -> &[HashMap<String, Vec<String>>]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .target_maps.is_none().

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

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) -> Option<&str>

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) -> &[TargetLocation]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .target_locations.is_none().

impl Runbook

pub fn builder() -> RunbookBuilder

Creates a new builder-style object to manufacture Runbook.

Trait Implementations

impl Clone for Runbook

fn clone(&self) -> Runbook

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Runbook

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

Formats the value using the given formatter.

impl PartialEq for Runbook

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