Struct aws_sdk_ssm::operation::start_automation_execution::builders::StartAutomationExecutionInputBuilder
source · #[non_exhaustive]pub struct StartAutomationExecutionInputBuilder { /* private fields */ }
Expand description
A builder for StartAutomationExecutionInput
.
Implementations§
source§impl StartAutomationExecutionInputBuilder
impl StartAutomationExecutionInputBuilder
sourcepub fn document_name(self, input: impl Into<String>) -> Self
pub fn document_name(self, input: impl Into<String>) -> Self
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.
This field is required.sourcepub fn set_document_name(self, input: Option<String>) -> Self
pub fn set_document_name(self, input: Option<String>) -> Self
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.
sourcepub fn get_document_name(&self) -> &Option<String>
pub fn get_document_name(&self) -> &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.
sourcepub fn document_version(self, input: impl Into<String>) -> Self
pub fn document_version(self, input: impl Into<String>) -> Self
The version of the Automation runbook to use for this execution.
sourcepub fn set_document_version(self, input: Option<String>) -> Self
pub fn set_document_version(self, input: Option<String>) -> Self
The version of the Automation runbook to use for this execution.
sourcepub fn get_document_version(&self) -> &Option<String>
pub fn get_document_version(&self) -> &Option<String>
The version of the Automation runbook to use for this execution.
sourcepub fn parameters(self, k: impl Into<String>, v: Vec<String>) -> Self
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
.
A key-value map of execution parameters, which match the declared parameters in the Automation runbook.
sourcepub fn set_parameters(self, input: Option<HashMap<String, Vec<String>>>) -> Self
pub fn set_parameters(self, input: Option<HashMap<String, Vec<String>>>) -> Self
A key-value map of execution parameters, which match the declared parameters in the Automation runbook.
sourcepub fn get_parameters(&self) -> &Option<HashMap<String, Vec<String>>>
pub fn get_parameters(&self) -> &Option<HashMap<String, Vec<String>>>
A key-value map of execution parameters, which match the declared parameters in the Automation runbook.
sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
sourcepub fn mode(self, input: ExecutionMode) -> Self
pub fn mode(self, input: ExecutionMode) -> Self
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
sourcepub fn set_mode(self, input: Option<ExecutionMode>) -> Self
pub fn set_mode(self, input: Option<ExecutionMode>) -> Self
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
sourcepub fn get_mode(&self) -> &Option<ExecutionMode>
pub fn get_mode(&self) -> &Option<ExecutionMode>
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
sourcepub fn target_parameter_name(self, input: impl Into<String>) -> Self
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 execution. Required if you specify targets.
sourcepub fn set_target_parameter_name(self, input: Option<String>) -> Self
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 execution. Required if you specify targets.
sourcepub fn get_target_parameter_name(&self) -> &Option<String>
pub fn get_target_parameter_name(&self) -> &Option<String>
The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
sourcepub fn targets(self, input: Target) -> Self
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. Required if you specify TargetParameterName.
sourcepub fn set_targets(self, input: Option<Vec<Target>>) -> Self
pub fn set_targets(self, input: Option<Vec<Target>>) -> Self
A key-value mapping to target resources. Required if you specify TargetParameterName.
sourcepub fn get_targets(&self) -> &Option<Vec<Target>>
pub fn get_targets(&self) -> &Option<Vec<Target>>
A key-value mapping to target resources. Required if you specify TargetParameterName.
sourcepub fn target_maps(self, input: HashMap<String, Vec<String>>) -> Self
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 document parameters to target resources. Both Targets and TargetMaps can't be specified together.
sourcepub fn set_target_maps(
self,
input: Option<Vec<HashMap<String, Vec<String>>>>
) -> Self
pub fn set_target_maps( self, input: Option<Vec<HashMap<String, Vec<String>>>> ) -> Self
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
sourcepub fn get_target_maps(&self) -> &Option<Vec<HashMap<String, Vec<String>>>>
pub fn get_target_maps(&self) -> &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.
sourcepub fn max_concurrency(self, input: impl Into<String>) -> Self
pub fn max_concurrency(self, input: impl Into<String>) -> Self
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
.
sourcepub fn set_max_concurrency(self, input: Option<String>) -> Self
pub fn set_max_concurrency(self, input: Option<String>) -> Self
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
.
sourcepub fn get_max_concurrency(&self) -> &Option<String>
pub fn get_max_concurrency(&self) -> &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
.
sourcepub fn max_errors(self, input: impl Into<String>) -> Self
pub fn max_errors(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_max_errors(self, input: Option<String>) -> Self
pub fn set_max_errors(self, input: Option<String>) -> Self
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.
sourcepub fn get_max_errors(&self) -> &Option<String>
pub fn get_max_errors(&self) -> &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.
sourcepub fn target_locations(self, input: TargetLocation) -> Self
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
.
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.
sourcepub fn set_target_locations(self, input: Option<Vec<TargetLocation>>) -> Self
pub fn set_target_locations(self, input: Option<Vec<TargetLocation>>) -> Self
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.
sourcepub fn get_target_locations(&self) -> &Option<Vec<TargetLocation>>
pub fn get_target_locations(&self) -> &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.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
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.
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.
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.
sourcepub fn alarm_configuration(self, input: AlarmConfiguration) -> Self
pub fn alarm_configuration(self, input: AlarmConfiguration) -> Self
The CloudWatch alarm you want to apply to your automation.
sourcepub fn set_alarm_configuration(self, input: Option<AlarmConfiguration>) -> Self
pub fn set_alarm_configuration(self, input: Option<AlarmConfiguration>) -> Self
The CloudWatch alarm you want to apply to your automation.
sourcepub fn get_alarm_configuration(&self) -> &Option<AlarmConfiguration>
pub fn get_alarm_configuration(&self) -> &Option<AlarmConfiguration>
The CloudWatch alarm you want to apply to your automation.
sourcepub fn build(self) -> Result<StartAutomationExecutionInput, BuildError>
pub fn build(self) -> Result<StartAutomationExecutionInput, BuildError>
Consumes the builder and constructs a StartAutomationExecutionInput
.
source§impl StartAutomationExecutionInputBuilder
impl StartAutomationExecutionInputBuilder
sourcepub async fn send_with(
self,
client: &Client
) -> Result<StartAutomationExecutionOutput, SdkError<StartAutomationExecutionError, HttpResponse>>
pub async fn send_with( self, client: &Client ) -> Result<StartAutomationExecutionOutput, SdkError<StartAutomationExecutionError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for StartAutomationExecutionInputBuilder
impl Clone for StartAutomationExecutionInputBuilder
source§fn clone(&self) -> StartAutomationExecutionInputBuilder
fn clone(&self) -> StartAutomationExecutionInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for StartAutomationExecutionInputBuilder
impl Default for StartAutomationExecutionInputBuilder
source§fn default() -> StartAutomationExecutionInputBuilder
fn default() -> StartAutomationExecutionInputBuilder
source§impl PartialEq for StartAutomationExecutionInputBuilder
impl PartialEq for StartAutomationExecutionInputBuilder
source§fn eq(&self, other: &StartAutomationExecutionInputBuilder) -> bool
fn eq(&self, other: &StartAutomationExecutionInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for StartAutomationExecutionInputBuilder
Auto Trait Implementations§
impl Freeze for StartAutomationExecutionInputBuilder
impl RefUnwindSafe for StartAutomationExecutionInputBuilder
impl Send for StartAutomationExecutionInputBuilder
impl Sync for StartAutomationExecutionInputBuilder
impl Unpin for StartAutomationExecutionInputBuilder
impl UnwindSafe for StartAutomationExecutionInputBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more