Help Docs

Amazon DocumentDB Cluster Actions

With Site24x7's IT Automation framework, you can create an action profile to automatically start, stop, or force a failover for Amazon DocumentDB clusters in your network. You can trigger the automation in response to various alert events happening in your monitored AWS environment, like when a metric exceeds the defined threshold value or for monitor-level status changes like Up, Down, or Trouble.

Required permissions

Ensure the following read-level permissions are present in the policy attached to the Site24x7 IAM entity or IAM role created.

  • rds:StartCluster
  • rds:StopCluster
  • rds:FailoverDBCluster

Creating an automation

  1. Log in to the Site24x7 web console and go to Admin > IT Automation Templates > Add Automation Templates.
  2. Click the drop-down and select the action to be performed: DocumentDB Cluster Actions.
  3. Enter a Display Name.
  4. Action to be performed: Choose DocumentDB Cluster Start, DocumentDB Cluster Stop, or Force a Failover for a Cluster from the drop-down menu.
  5. Select Resource Type: Choose the type of monitor.
  6. Document DB Cluster: Choose the host.
  7. Next, select the instances where the action should be performed. 
    • Max Allowed Action Execution Time: The maximum number of seconds Site24x7 should wait before the request times out. The execution time is set to 15 seconds by default. You can define an execution time between one and 90 seconds.
    • Send the Automation Result via Email: You can choose to receive an email regarding the automation result by toggling this setting to Yes. Automation results can be shared via email to your User Alert Group configured in the Notification Profile. This email will contain parameters including the automation name, the type of automation, the incident reason, the destination hosts, and more.
  8. Save the profile.

Simulate the automation

Before mapping the action profile, you can test its functionality by invoking the operational task manually within the Site24x7 console or by using our REST APIs. This is to check whether the appropriate write-level permissions required to execute the reboot action are in place. To test the profile, navigate back to the IT Automation summary page (Admin > IT Automation) and click the play icon AppStream Play Icon next to the appropriate template to execute a dry run.

Map the action profile

To execute the automation, map the action profile to the desired alert event. You can either map the profile to a predefined monitor-level event type or to a custom attribute-level event type.

Was this document helpful?

Would you like to help us improve our documents? Tell us what you think we could do better.

We're sorry to hear that you're not satisfied with the document. We'd love to learn what we could do to improve the experience.

Thanks for taking the time to share your feedback. We'll use your feedback to improve our online help resources.

Shortlink has been copied!