Interface StartAutomationExecutionRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<StartAutomationExecutionRequest.Builder,StartAutomationExecutionRequest>
,SdkBuilder<StartAutomationExecutionRequest.Builder,StartAutomationExecutionRequest>
,SdkPojo
,SdkRequest.Builder
,SsmRequest.Builder
- Enclosing class:
- StartAutomationExecutionRequest
public static interface StartAutomationExecutionRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<StartAutomationExecutionRequest.Builder,StartAutomationExecutionRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default StartAutomationExecutionRequest.Builder
alarmConfiguration(Consumer<AlarmConfiguration.Builder> alarmConfiguration)
The CloudWatch alarm you want to apply to your automation.StartAutomationExecutionRequest.Builder
alarmConfiguration(AlarmConfiguration alarmConfiguration)
The CloudWatch alarm you want to apply to your automation.StartAutomationExecutionRequest.Builder
clientToken(String clientToken)
User-provided idempotency token.StartAutomationExecutionRequest.Builder
documentName(String documentName)
The name of the SSM document to run.StartAutomationExecutionRequest.Builder
documentVersion(String documentVersion)
The version of the Automation runbook 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(String mode)
The execution mode of the automation.StartAutomationExecutionRequest.Builder
mode(ExecutionMode mode)
The execution mode of the automation.StartAutomationExecutionRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartAutomationExecutionRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartAutomationExecutionRequest.Builder
parameters(Map<String,? extends Collection<String>> parameters)
A key-value map of execution parameters, which match the declared parameters in the Automation runbook.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 Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation.StartAutomationExecutionRequest.Builder
targetLocations(Consumer<TargetLocation.Builder>... targetLocations)
A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation.StartAutomationExecutionRequest.Builder
targetLocations(TargetLocation... targetLocations)
A location is a combination of Amazon Web Services Regions and/or Amazon Web Services 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.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder
build
-
-
-
-
Method Detail
-
documentName
StartAutomationExecutionRequest.Builder documentName(String documentName)
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.
- Parameters:
documentName
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentVersion
StartAutomationExecutionRequest.Builder documentVersion(String documentVersion)
The version of the Automation runbook to use for this execution.
- Parameters:
documentVersion
- The version of the Automation runbook to use for this execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
StartAutomationExecutionRequest.Builder parameters(Map<String,? extends Collection<String>> parameters)
A key-value map of execution parameters, which match the declared parameters in the Automation runbook.
- Parameters:
parameters
- A key-value map of execution parameters, which match the declared parameters in the Automation runbook.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
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.
- Parameters:
clientToken
- User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mode
StartAutomationExecutionRequest.Builder mode(String mode)
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
- Parameters:
mode
- The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ExecutionMode
,ExecutionMode
-
mode
StartAutomationExecutionRequest.Builder mode(ExecutionMode mode)
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
- Parameters:
mode
- The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ExecutionMode
,ExecutionMode
-
targetParameterName
StartAutomationExecutionRequest.Builder targetParameterName(String targetParameterName)
The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
- Parameters:
targetParameterName
- The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
StartAutomationExecutionRequest.Builder targets(Collection<Target> targets)
A key-value mapping to target resources. Required if you specify TargetParameterName.
- Parameters:
targets
- A key-value mapping to target resources. Required if you specify TargetParameterName.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
StartAutomationExecutionRequest.Builder targets(Target... targets)
A key-value mapping to target resources. Required if you specify TargetParameterName.
- Parameters:
targets
- A key-value mapping to target resources. Required if you specify TargetParameterName.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
StartAutomationExecutionRequest.Builder targets(Consumer<Target.Builder>... targets)
A key-value mapping to target resources. Required if you specify TargetParameterName.
This is a convenience method that creates an instance of theTarget.Builder
avoiding the need to create one manually viaTarget.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#targets(List
.) - Parameters:
targets
- a consumer that will call methods onTarget.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#targets(java.util.Collection
)
-
targetMaps
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 can't be specified together.
- Parameters:
targetMaps
- A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetMaps
StartAutomationExecutionRequest.Builder targetMaps(Map<String,? extends Collection<String>>... targetMaps)
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
- Parameters:
targetMaps
- A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxConcurrency
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
.- Parameters:
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 is10
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxErrors
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetLocations
StartAutomationExecutionRequest.Builder targetLocations(Collection<TargetLocation> targetLocations)
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.
- Parameters:
targetLocations
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetLocations
StartAutomationExecutionRequest.Builder targetLocations(TargetLocation... targetLocations)
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.
- Parameters:
targetLocations
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetLocations
StartAutomationExecutionRequest.Builder targetLocations(Consumer<TargetLocation.Builder>... targetLocations)
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.
This is a convenience method that creates an instance of theTargetLocation.Builder
avoiding the need to create one manually viaTargetLocation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#targetLocations(List
.) - Parameters:
targetLocations
- a consumer that will call methods onTargetLocation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#targetLocations(java.util.Collection
)
-
tags
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-value pairs:
-
Key=environment,Value=test
-
Key=OS,Value=Windows
To add tags to an existing automation, use the AddTagsToResource operation.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
tags
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-value pairs:
-
Key=environment,Value=test
-
Key=OS,Value=Windows
To add tags to an existing automation, use the AddTagsToResource operation.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
tags
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-value pairs:
-
Key=environment,Value=test
-
Key=OS,Value=Windows
To add tags to an existing automation, use the AddTagsToResource operation.
Tag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#tags(List
.) - Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection
)
-
-
alarmConfiguration
StartAutomationExecutionRequest.Builder alarmConfiguration(AlarmConfiguration alarmConfiguration)
The CloudWatch alarm you want to apply to your automation.
- Parameters:
alarmConfiguration
- The CloudWatch alarm you want to apply to your automation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmConfiguration
default StartAutomationExecutionRequest.Builder alarmConfiguration(Consumer<AlarmConfiguration.Builder> alarmConfiguration)
The CloudWatch alarm you want to apply to your automation.
This is a convenience method that creates an instance of theAlarmConfiguration.Builder
avoiding the need to create one manually viaAlarmConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toalarmConfiguration(AlarmConfiguration)
.- Parameters:
alarmConfiguration
- a consumer that will call methods onAlarmConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
alarmConfiguration(AlarmConfiguration)
-
overrideConfiguration
StartAutomationExecutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
StartAutomationExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-