Using the AWS Systems Manager Automation Execution task in Bamboo


You can use the AWS Systems Manager Automation Execution task to start, stop, or signal an AWS Systems Manager Automation execution.

Configuration

To configure an AWS Systems Manager Automation Execution task:

  1. Navigate to the Tasks configuration tab for the job (this will be the default job if creating a new plan).
  2. Click the name of an existing AWS Systems Manager Automation Execution task, or click Add Task and then AWS Systems Manager Automation Execution to create a new task.
  3. Complete the following settings:

    1. Common to all tasks

    • Actions supported by this task:

      Start Automation Execution

      Treat waiting status as success

      Check to stop monitoring when the automation reaches 'Waiting' status

      Document NameSpecify the Automation document name.
      Document Version(Optional) Specify the Automation document version.
      Parameters

      (Optional) Specify the execution parameters, which match the declared parameters in the Automation document. (JSON – inline or via URL) – refer to Parameters for details.

      Target Definition Type
      Target Maps(Optional) Specify the key-value mapping of document parameters to target resources. (JSON – inline or via URL) – refer to About Targets and Target Maps for details.
      Target Parameter Name(Optional) Specify the name of the parameter used as the target resource for the rate-controlled execution
      Targets(Optional) Specify the key-value mapping to target resources. (JSON – inline or via URL) – refer to About Targets and Targets for details.
      Target Locations(Optional) Specify the combination of AWS Regions and/or AWS accounts where you want to execute the Automation. (JSON – inline or via URL) – refer to Running Automation Workflows in Multiple AWS Regions and Accounts and Target Locations for details.
      Max Concurrency(Optional) Specify the maximum number of targets allowed to run this task in parallel (integer or percent)
      Max Errors(Optional) Specify the number of errors that are allowed before the system stops running the automation on additional targets (integer or percent)
      Advanced OptionsSpecify the combination of AWS Regions and/or AWS accounts where you want to execute the Automation. (JSON – inline or via URL).
      ModeSelect the execution mode of the automation.
      Await Desired Status TimeoutSpecify how long to await the automation execution reaching the desired status (seconds, 0 to skip).

      Send Automation Signal

      Automation Execution ID

      Specify the execution ID of the Automation to signal.

      Signal Type
      Select the type of signal.
      Signal Payload
      (Optional) Specify the data sent with the signal. (JSON – inline or via URL) – refer to Payload for details

      Stop Automation Execution


      Automation Execution ID
      see Send Automation Signal above
      Type
      Select the stop request type.

Variables

Start Automation Execution

Send Automation Signal

Stop Automation Execution

N/A

How-to Articles

Frequently Asked Questions (FAQ)