Package software.amazon.awssdk.services.ssm.model

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 Details

    • 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:

    • 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:

    • 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 the Target.Builder avoiding the need to create one manually via Target.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targets(List<Target>).

      Parameters:
      targets - a consumer that will call methods on Target.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 is 10.
      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 the TargetLocation.Builder avoiding the need to create one manually via TargetLocation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetLocations(List<TargetLocation>).

      Parameters:
      targetLocations - a consumer that will call methods on TargetLocation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the AlarmConfiguration.Builder avoiding the need to create one manually via AlarmConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to alarmConfiguration(AlarmConfiguration).

      Parameters:
      alarmConfiguration - a consumer that will call methods on AlarmConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      StartAutomationExecutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartAutomationExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.