Integrate with Amazon RDS

Overview

What does the integration offer?

Amazon RDS (Relational Database Service) provides cost-efficient, resizeable capacity for an industry-standard relational database and manages everyday database administration tasks.

Amazon RDS sends notifications of database events through SNS. Jira Service Management acts as a dispatcher for these notifications, determines the right people to notify based on on-call schedules – notifies them using email, text messages (SMS), phone calls, and iPhone & Android push notifications, and escalates alerts until they are acknowledged or closed. Amazon RDS sends DB notifications like shutdown or backup, and Jira Service Management ensures the right people are notified.

How does the integration work?

When an alert is created in Amazon RDS, an alert is created in Jira Service Management automatically through the integration.

Set up the integration

Amazon RDS is an API-based integration. Setting it up involves the following steps:

Add an Amazon RDS integration in Jira Service Management
Set up a subscription in Amazon RDS

Add Amazon RDS integration

If you're using the Free or Standard plan in Jira Service Management, you can only add this integration from your team’s operations page. To access the feature through Settings (gear icon) > Products (under JIRA SETTINGS) > OPERATIONS, you need to be on Premium or Enterprise plan.

Adding an integration from your team’s operations page makes your team the owner of the integration. This means Jira Service Management assigns the alerts received through this integration to your team only.

To add an Amazon RDS integration in Jira Service Management:

Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select “Amazon RDS”.
On the next screen, enter a name for the integration.
Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.
Select Continue.
The integration is saved at this point.
Expand the Steps to configure the integration section and copy the integration URL, which includes Jira Service Management endpoint and the API key.
You will use this URL while configuring the integration in Amazon RDS later.
Select Turn on integration.
The rules you create for the integration will work only if you turn on the integration.

Set up a subscription in Amazon RDS

Create an SNS topic. For details, see Getting started with Amazon SNS.
Add an HTTPS subscription to your topic with the integration URL (copied while adding the integration in Jira Service Management) as the endpoint. For details on how to add an HTTPS subscription, see What is an Amazon SNS?
If the configuration is successful, a confirmation alert is created in Jira Service Management.
Create an event subscription from the RDS Dashboard that sends notifications to the SNS topic you created earlier. Learn more about working with Amazon RDS event notification.

Sample payload sent from Amazon RDS

Create alert payload (in JSON format)

{
  "Type":"Notification",
  "MessageId":"1cf7a0eb-4179-4181-b15b-ea22c5axxx",
  "TopicArn":"arn:aws:sns:us-east-1:08931xxxxxx:CloudWatchHTTPAlarms",
  "Subject":"ALARM: \"cpuUtilTest\" in US - N. Virginia",
  "Message":"{\"Event Source\":\"db-instance\",\"Event Time\":\"2014-10-28 08:13:15.339\",\"Identifier Link\":\"https://console.aws.amazon.com/rds/home?region=us-east-1#\\nSourceId: aydentifayir \",\"Event ID\":\"http://docs.amazonwebservices.com/AmazonRDS/latest/UserGuide/USER_Events.html#RDS-EVENT-0019\",\"Event Message\":\"Restored from DB instance mydbinstins to 2014-10-28 08:00:00.0\"}",
  "Timestamp":"2012-08-05T22:31:30.673Z",
  "SignatureVersion":"1",
  "Signature":"XrsO2wtE0b+xxxxxxxxxlimTUg+rV4U9RmNSSBEdlmyWvtGgpjebsmNv1wkjUsBQOJZjZnpZp5FBn6quAn3twNdRMmMLf15lv6ESbxxxxxxxxxxxx/ZLwiH9Pr/cxVYOR0aPQBPDwTYn8w6g=",
  "SigningCertURL":"https://sns.us-east-1.amazonaws.com/SimpleNotificationService-f3ecfb7224c7233fexxxxxxf.pem",
  "UnsubscribeURL":"https://sns.us-east-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:us-east-1:08931xxxxxxx:CloudWatchHTTPAlarms:1841c5ca-ddda-xxxxxxbfb-bf0cf15813db"
}

{
  "TopicArn": "arn:aws:sns:us-east-1:089xxxxxxxxx:CloudWatchHTTPAlarms",
  "Subject": "ALARM: \"cpuUtilTest\" in US - N. Virginia",
  "Event Source": "db-instance",
  "Event ID": "http://docs.amazonwebservices.com/AmazonRDS/latest/UserGuide/USER_Events.html#RDS-EVENT-0019",
  "Event Message": "Restored from DB instance mydbinstins to 2014-10-28 08:00:00.0",
  "Identifier Link": "https://console.aws.amazon.com/rds/home?region=us-east-1#",
  "SourceId": "sourceID"
}