Struct aws_sdk_ssm::operation::start_automation_execution::StartAutomationExecutionInput

#[non_exhaustive]
pub struct StartAutomationExecutionInput {

    pub document_name: Option<String>,
    pub document_version: Option<String>,
    pub parameters: Option<HashMap<String, Vec<String>>>,
    pub client_token: Option<String>,
    pub mode: Option<ExecutionMode>,
    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>>,
    pub tags: Option<Vec<Tag>>,
    pub alarm_configuration: Option<AlarmConfiguration>,
}

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: Option<String>

The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Sharing SSM documents in the Amazon Web Services Systems Manager User Guide.

document_version: Option<String>

The version of the Automation runbook to use for this execution.

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

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

client_token: Option<String>

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

mode: Option<ExecutionMode>

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

target_parameter_name: Option<String>

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

targets: Option<Vec<Target>>

A key-value mapping to target resources. Required if you specify TargetParameterName.

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

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

max_concurrency: Option<String>

The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

max_errors: Option<String>

The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

target_locations: Option<Vec<TargetLocation>>

A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts in the Amazon Web Services Systems Manager User Guide.

tags: Option<Vec<Tag>>

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

• Key=environment,Value=test

• Key=OS,Value=Windows

To add tags to an existing automation, use the AddTagsToResource operation.

alarm_configuration: Option<AlarmConfiguration>

The CloudWatch alarm you want to apply to your automation.

Implementations

impl StartAutomationExecutionInput

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

The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Sharing SSM documents in the Amazon Web Services Systems Manager User Guide.

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

The version of the Automation runbook to use for this execution.

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

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

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

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

pub fn mode(&self) -> Option<&ExecutionMode>

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

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

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

pub fn targets(&self) -> &[Target]

A key-value mapping to target resources. 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 document 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 maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

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

The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

pub fn target_locations(&self) -> &[TargetLocation]

A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts in the Amazon Web Services Systems Manager User Guide.

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().

pub fn tags(&self) -> &[Tag]

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

• Key=environment,Value=test

• Key=OS,Value=Windows

To add tags to an existing automation, use the AddTagsToResource 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 .tags.is_none().

pub fn alarm_configuration(&self) -> Option<&AlarmConfiguration>

The CloudWatch alarm you want to apply to your automation.

impl StartAutomationExecutionInput

pub fn builder() -> StartAutomationExecutionInputBuilder

Creates a new builder-style object to manufacture StartAutomationExecutionInput.

Trait Implementations

impl Clone for StartAutomationExecutionInput

fn clone(&self) -> StartAutomationExecutionInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartAutomationExecutionInput

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

Formats the value using the given formatter.

impl PartialEq for StartAutomationExecutionInput

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