software.amazon.awssdk.services.ssm.model

Class StartAutomationExecutionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.StartAutomationExecutionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartAutomationExecutionRequest.Builder,StartAutomationExecutionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartAutomationExecutionRequest
extends SsmRequest
implements ToCopyableBuilder<StartAutomationExecutionRequest.Builder,StartAutomationExecutionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartAutomationExecutionRequest.Builder

Method Summary

Modifier and Type	Method and Description
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() Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTargetLocations() Returns true if the TargetLocations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTargetMaps() Returns true if the TargetMaps property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTargets() Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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 Regions and/or 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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

documentName

public 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.

Returns:

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.

documentVersion

public final String documentVersion()

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

Returns:

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

hasParameters

public final boolean hasParameters()

Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

parameters

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.

You can use hasParameters() to see if a value was sent in this field.

Returns:

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

clientToken

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.

Returns:

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

mode

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

Returns:

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

See Also:

ExecutionMode

modeAsString

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

Returns:

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

See Also:

ExecutionMode

targetParameterName

public final String targetParameterName()

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

Returns:

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

hasTargets

public final boolean hasTargets()

Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

targets

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.

You can use hasTargets() to see if a value was sent in this field.

Returns:

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

hasTargetMaps

public final boolean hasTargetMaps()

Returns true if the TargetMaps property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

targetMaps

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.

You can use hasTargetMaps() to see if a value was sent in this field.

Returns:

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

maxConcurrency

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.

Returns:

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.

maxErrors

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.

Returns:

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.

hasTargetLocations

public final boolean hasTargetLocations()

Returns true if the TargetLocations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

targetLocations

public final List<TargetLocation> targetLocations()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTargetLocations() to see if a value was sent in this field.

Returns:

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

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

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 patch baseline, use the AddTagsToResource operation.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

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 patch baseline, use the AddTagsToResource operation.

toBuilder

public StartAutomationExecutionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartAutomationExecutionRequest.Builder,StartAutomationExecutionRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static StartAutomationExecutionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartAutomationExecutionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo