public static interface StartAutomationExecutionRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<StartAutomationExecutionRequest.Builder,StartAutomationExecutionRequest>
| Modifier and Type | Method and Description |
|---|---|
StartAutomationExecutionRequest.Builder |
clientToken(String clientToken)
User-provided idempotency token.
|
StartAutomationExecutionRequest.Builder |
documentName(String documentName)
The name of the Automation document to use for this execution.
|
StartAutomationExecutionRequest.Builder |
documentVersion(String documentVersion)
The version of the Automation document to use for this execution.
|
StartAutomationExecutionRequest.Builder |
maxConcurrency(String maxConcurrency)
The maximum number of targets allowed to run this task in parallel.
|
StartAutomationExecutionRequest.Builder |
maxErrors(String maxErrors)
The number of errors that are allowed before the system stops running the automation on additional targets.
|
StartAutomationExecutionRequest.Builder |
mode(ExecutionMode mode)
The execution mode of the automation.
|
StartAutomationExecutionRequest.Builder |
mode(String mode)
The execution mode of the automation.
|
StartAutomationExecutionRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
StartAutomationExecutionRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
StartAutomationExecutionRequest.Builder |
parameters(Map<String,? extends Collection<String>> parameters)
A key-value map of execution parameters, which match the declared parameters in the Automation document.
|
StartAutomationExecutionRequest.Builder |
tags(Collection<Tag> tags)
Optional metadata that you assign to a resource.
|
StartAutomationExecutionRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Optional metadata that you assign to a resource.
|
StartAutomationExecutionRequest.Builder |
tags(Tag... tags)
Optional metadata that you assign to a resource.
|
StartAutomationExecutionRequest.Builder |
targetLocations(Collection<TargetLocation> targetLocations)
A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation.
|
StartAutomationExecutionRequest.Builder |
targetLocations(Consumer<TargetLocation.Builder>... targetLocations)
A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation.
|
StartAutomationExecutionRequest.Builder |
targetLocations(TargetLocation... targetLocations)
A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation.
|
StartAutomationExecutionRequest.Builder |
targetMaps(Collection<? extends Map<String,? extends Collection<String>>> targetMaps)
A key-value mapping of document parameters to target resources.
|
StartAutomationExecutionRequest.Builder |
targetMaps(Map<String,? extends Collection<String>>... targetMaps)
A key-value mapping of document parameters to target resources.
|
StartAutomationExecutionRequest.Builder |
targetParameterName(String targetParameterName)
The name of the parameter used as the target resource for the rate-controlled execution.
|
StartAutomationExecutionRequest.Builder |
targets(Collection<Target> targets)
A key-value mapping to target resources.
|
StartAutomationExecutionRequest.Builder |
targets(Consumer<Target.Builder>... targets)
A key-value mapping to target resources.
|
StartAutomationExecutionRequest.Builder |
targets(Target... targets)
A key-value mapping to target resources.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildStartAutomationExecutionRequest.Builder documentName(String documentName)
The name of the Automation document to use for this execution.
documentName - The name of the Automation document to use for this execution.StartAutomationExecutionRequest.Builder documentVersion(String documentVersion)
The version of the Automation document to use for this execution.
documentVersion - The version of the Automation document to use for this execution.StartAutomationExecutionRequest.Builder parameters(Map<String,? extends Collection<String>> parameters)
A key-value map of execution parameters, which match the declared parameters in the Automation document.
parameters - A key-value map of execution parameters, which match the declared parameters in the Automation
document.StartAutomationExecutionRequest.Builder clientToken(String clientToken)
User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
clientToken - User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID
format, and can't be reused.StartAutomationExecutionRequest.Builder mode(String mode)
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
mode - The execution mode of the automation. Valid modes include the following: Auto and Interactive. The
default mode is Auto.ExecutionMode,
ExecutionModeStartAutomationExecutionRequest.Builder mode(ExecutionMode mode)
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
mode - The execution mode of the automation. Valid modes include the following: Auto and Interactive. The
default mode is Auto.ExecutionMode,
ExecutionModeStartAutomationExecutionRequest.Builder targetParameterName(String targetParameterName)
The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
targetParameterName - The name of the parameter used as the target resource for the rate-controlled execution. Required if
you specify targets.StartAutomationExecutionRequest.Builder targets(Collection<Target> targets)
A key-value mapping to target resources. Required if you specify TargetParameterName.
targets - A key-value mapping to target resources. Required if you specify TargetParameterName.StartAutomationExecutionRequest.Builder targets(Target... targets)
A key-value mapping to target resources. Required if you specify TargetParameterName.
targets - A key-value mapping to target resources. Required if you specify TargetParameterName.StartAutomationExecutionRequest.Builder targets(Consumer<Target.Builder>... targets)
A key-value mapping to target resources. Required if you specify TargetParameterName.
This is a convenience that creates an instance of theList.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its
result is passed to #targets(List) .targets - a consumer that will call methods on List.Builder #targets(List) StartAutomationExecutionRequest.Builder targetMaps(Collection<? extends Map<String,? extends Collection<String>>> targetMaps)
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.
targetMaps - A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be
specified together.StartAutomationExecutionRequest.Builder targetMaps(Map<String,? extends Collection<String>>... targetMaps)
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.
targetMaps - A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be
specified together.StartAutomationExecutionRequest.Builder maxConcurrency(String maxConcurrency)
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.
maxConcurrency - 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.StartAutomationExecutionRequest.Builder maxErrors(String maxErrors)
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.
maxErrors - 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.
StartAutomationExecutionRequest.Builder targetLocations(Collection<TargetLocation> targetLocations)
A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
targetLocations - A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation.
Use this action to start an Automation in multiple Regions and multiple accounts. For more
information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User
Guide.StartAutomationExecutionRequest.Builder targetLocations(TargetLocation... targetLocations)
A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
targetLocations - A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation.
Use this action to start an Automation in multiple Regions and multiple accounts. For more
information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User
Guide.StartAutomationExecutionRequest.Builder targetLocations(Consumer<TargetLocation.Builder>... targetLocations)
A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
This is a convenience that creates an instance of theList.Builder avoiding the need
to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and
its result is passed to #targetLocations(List) .targetLocations - a consumer that will call methods on List.Builder #targetLocations(List) StartAutomationExecutionRequest.Builder tags(Collection<Tag> 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 name/value pairs:
Key=environment,Value=test
Key=OS,Value=Windows
To add tags to an existing patch baseline, use the AddTagsToResource action.
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 name/value pairs:
Key=environment,Value=test
Key=OS,Value=Windows
To add tags to an existing patch baseline, use the AddTagsToResource action.
StartAutomationExecutionRequest.Builder tags(Tag... 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 name/value pairs:
Key=environment,Value=test
Key=OS,Value=Windows
To add tags to an existing patch baseline, use the AddTagsToResource action.
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 name/value pairs:
Key=environment,Value=test
Key=OS,Value=Windows
To add tags to an existing patch baseline, use the AddTagsToResource action.
StartAutomationExecutionRequest.Builder tags(Consumer<Tag.Builder>... 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 name/value pairs:
Key=environment,Value=test
Key=OS,Value=Windows
To add tags to an existing patch baseline, use the AddTagsToResource action.
List.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) StartAutomationExecutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderStartAutomationExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2020. All rights reserved.