@Generated(value="software.amazon.awssdk:codegen") public final class StartAutomationExecutionRequest extends SsmRequest implements ToCopyableBuilder<StartAutomationExecutionRequest.Builder,StartAutomationExecutionRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
StartAutomationExecutionRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
AlarmConfiguration |
alarmConfiguration()
The CloudWatch alarm you want to apply to your automation.
|
static StartAutomationExecutionRequest.Builder |
builder() |
String |
clientToken()
User-provided idempotency token.
|
String |
documentName()
The name of the SSM document to run.
|
String |
documentVersion()
The version of the Automation runbook to use for this execution.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasParameters()
For responses, this returns true if the service returned a value for the Parameters property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
boolean |
hasTargetLocations()
For responses, this returns true if the service returned a value for the TargetLocations property.
|
boolean |
hasTargetMaps()
For responses, this returns true if the service returned a value for the TargetMaps property.
|
boolean |
hasTargets()
For responses, this returns true if the service returned a value for the Targets property.
|
String |
maxConcurrency()
The maximum number of targets allowed to run this task in parallel.
|
String |
maxErrors()
The number of errors that are allowed before the system stops running the automation on additional targets.
|
ExecutionMode |
mode()
The execution mode of the automation.
|
String |
modeAsString()
The execution mode of the automation.
|
Map<String,List<String>> |
parameters()
A key-value map of execution parameters, which match the declared parameters in the Automation runbook.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends StartAutomationExecutionRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
Optional metadata that you assign to a resource.
|
List<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.
|
List<Map<String,List<String>>> |
targetMaps()
A key-value mapping of document parameters to target resources.
|
String |
targetParameterName()
The name of the parameter used as the target resource for the rate-controlled execution.
|
List<Target> |
targets()
A key-value mapping to target resources.
|
StartAutomationExecutionRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final 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 Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.
public final String documentVersion()
The version of the Automation runbook to use for this execution.
public final boolean hasParameters()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final Map<String,List<String>> parameters()
A key-value map of execution parameters, which match the declared parameters in the Automation runbook.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasParameters() method.
public final String clientToken()
User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
public final ExecutionMode mode()
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
If the service returns an enum value that is not available in the current SDK version, mode will return
ExecutionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
modeAsString().
ExecutionModepublic final String modeAsString()
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
If the service returns an enum value that is not available in the current SDK version, mode will return
ExecutionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
modeAsString().
ExecutionModepublic final String targetParameterName()
The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
public final boolean hasTargets()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<Target> targets()
A key-value mapping to target resources. Required if you specify TargetParameterName.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTargets() method.
public final boolean hasTargetMaps()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<Map<String,List<String>>> targetMaps()
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTargetMaps() method.
public final 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.
10.public final 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.
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.
public final boolean hasTargetLocations()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTargetLocations() method.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
Key=environment,Value=test
Key=OS,Value=Windows
To add tags to an existing automation, use the AddTagsToResource operation.
public final AlarmConfiguration alarmConfiguration()
The CloudWatch alarm you want to apply to your automation.
public StartAutomationExecutionRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<StartAutomationExecutionRequest.Builder,StartAutomationExecutionRequest>toBuilder in class SsmRequestpublic static StartAutomationExecutionRequest.Builder builder()
public static Class<? extends StartAutomationExecutionRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.