Notifications

This section will help you understand the logic on the notifications about backup executions.

Topics

• Overview
• Prerequisites
  • Create a SNS Topic
  • Add IAM Policy with permissions to access the SNS Topic
• Enable notifications
• Disable notifications

Overview

Backup offers the possibility to send backup status information to an SNS Topic so that the information can be sent to any email, sms or third-party tool subscribed to it.

Notification parameters can also be found in the emory configuration file with the following format:

Notificator:
  active: true
  SNSArn: arn:aws:sns:us-east-2:123456789012:MyTopic

---

Prerequisites

Create a SNS Topic

Before you can start working with the backup notifications you will need to create an SNS Topic in your AWS Account. To do so, follow these guidelines based on the AWS Documentation https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html:

1. Sign in to the Amazon SNS console.

2. Do one of the following:

   • If no topics have ever been created under your AWS account before, read the description of Amazon SNS on the home page.
   • If topics have been created under your AWS account before, on the navigation panel, choose Topics.

3. On the Topics page, choose Create topic.

4. On the Create topic page, in the Details section, do the following:

   • For Type, choose a topic type (Standard or FIFO).
   • Enter a Name for the topic. For a FIFO topic, add .fifo to the end of the name.
   • (Optional) Enter a Display name for the topic.
   • (Optional) For a FIFO topic, you can choose content-based message deduplication to enable default message deduplication. For more information, see Message deduplication for FIFO topics.

5. (Optional) Expand the Encryption section and do the following. For more information, see Encryption at rest.

   • Choose Enable encryption.

   • Specify the customer master key (CMK). For more information, see Key terms. For each CMK type, the Description, Account, and CMK ARN are displayed.

     Important

     If you aren't the owner of the CMK, or if you log in with an account that doesn't have the kms:ListAliases and kms:DescribeKey permissions, you won't be able to view information about the CMK on the Amazon SNS console.

     Ask the owner of the CMK to grant you these permissions. For more information, see the AWS KMS API Permissions: Actions and Resources Reference in the AWS Key Management Service Developer Guide.

     • The AWS managed CMK for Amazon SNS (Default) alias/aws/sns is selected by default.

       Note

       Keep the following in mind:

       • The first time you use the AWS Management Console to specify the AWS managed CMK for Amazon SNS for a topic, AWS KMS creates the AWS managed CMK for Amazon SNS.

       • Alternatively, the first time you use the Publish action on a topic with SSE enabled, AWS KMS creates the AWS managed CMK for Amazon SNS.

     • To use a custom CMK from your AWS account, choose the Customer master key (CMK) field and then choose the custom CMK from the list.

       Note

       For instructions on creating custom CMKs, see Creating Keys in the AWS Key Management Service Developer Guide

     • To use a custom CMK ARN from your AWS account or from another AWS account, enter it into the Customer master key (CMK) field.

6. (Optional) By default, only the topic owner can publish or subscribe to the topic. To configure additional access permissions, expand the Access policy section. For more information, see Identity and access management in Amazon SNS and Example cases for Amazon SNS access control.

   Note

   When you create a topic using the console, the default policy uses the aws:SourceOwner condition key. This key is similar to aws:SourceAccount.

7. (Optional) To configure how Amazon SNS retries failed message delivery attempts, expand the Delivery retry policy (HTTP/S) section. For more information, see Amazon SNS message delivery retries.

8. (Optional) To configure how Amazon SNS logs the delivery of messages to CloudWatch, expand the Delivery status logging section. For more information, see Amazon SNS message delivery status.

9. (Optional) To add metadata tags to the topic, expand the Tags section, enter a Key and a Value (optional) and choose Add tag. For more information, see Configuring tags for an Amazon SNS topic.

10. Choose Create topic.

    The topic is created and the MyTopic page is displayed.

    The topic's Name, ARN, (optional) Display name, and Topic owner's AWS account ID are displayed in the Details section.

11. Copy the topic ARN to the clipboard, for example:

    arn:aws:sns:us-east-2:123456789012:MyTopic

Add IAM Policy with permissions to access the SNS Topic

Your SAP server must have permission to at least the following actions:

• sns:Publish

Use this example as a template to add the permissions if needed:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": "sns:Publish",
            "Resource": "arn:aws:sns:eu-west-1:${AWS::AccountId}:<sns_topic_arn>"
        }
    ]
}

Enable notifications

To be able to send this information to a subscribed service you will need to follow this steps:

1. Open the configuration wizard as SAP Database Administrator user:

   /opt/emory/emory 
   

2. Select Monitoring from the main menu:

   ? CxLink Backup:  [Use arrows to move, enter to select, type to filter]
     --------------------------------------------------------------------------------
     Storage Providers profiles
     Set storage providers for backup/restore, disaster recovery and system copy
     Backups Lifecycle settings
     > Monitoring
     --------------------------------------------------------------------------------
     License
     --------------------------------------------------------------------------------
     Logging file settings
     Debug traces
     Show relevant information of this CxLink Backup
     --------------------------------------------------------------------------------
     Catalog & Backups management
     --------------------------------------------------------------------------------
     Generate troubleshooting package to be sent to Syntax Support
     --------------------------------------------------------------------------------
     Exit
   

3. Select External endpoint notification (AWS SNS Service):

   ? CxLink Backup: Monitoring
   ? Select :   [Use arrows to move, enter to select, type to filter]
   Syntax Dashboard notification
   Local monitoring
   > External endpoint notification (AWS SNS Service)
   Back
   

4. Select Enable external endpoint monitoring:

   ? CxLink Backup: Monitoring
   ? Select :  External endpoint notification (AWS SNS Service)
   ? Select :  [Use arrows to move, enter to select, type to filter]
   > Enable external endpoint monitoring
   Back
   

5. Select Set AWS SNS Endpoint:

   ? CxLink Backup: Monitoring
   ? Select :  External endpoint notification (AWS SNS Service)
   ? Select : Enable external endpoint monitoring
   ? Select :  [Use arrows to move, enter to select, type to filter]
   > Set AWS SNS Endpoint
   Disable external endpoint monitoring
   Back
   

6. Fill profile name from your AWS credentials file if one has to be used or leave it empty to access using instance service role, role ARN if role has to be assumed, region and AWS SNS Topic ARN to be used from the list:

   ? CxLink Backup: Monitoring
   ? Select :  External endpoint notification (AWS SNS Service)
   ? Select : Enable external endpoint monitoring
   ? Select : Set AWS SNS Endpoint
   ? AWS command line profile name: default
   ? AssumeRole Arn:
   ? AWS Region: eu-west-1
   ? AWS SNS Topic ARN:  [Use arrows to move, enter to select, type to filter, ? for more help]
   > arn:aws:sns:eu-west-1:742189430206:AWSemory.fifo
     arn:aws:sns:eu-west-1:742189430206:AWSemory_Demo
   

7. You can now select Return and Exit to save the configuration if no other action should be taken.

---

Disable notifications

To be able to send this information to a subscribed service you will need to follow this steps:

1. Open the configuration wizard as SAP Database Administrator user:

   /opt/emory/emory 
   

2. Select Monitoring from the main menu:

   ? CxLink Backup:  [Use arrows to move, enter to select, type to filter]
     --------------------------------------------------------------------------------
     Storage Providers profiles
     Set storage providers for backup/restore, disaster recovery and system copy
     Backups Lifecycle settings
     > Monitoring
     --------------------------------------------------------------------------------
     License
     --------------------------------------------------------------------------------
     Logging file settings
     Debug traces
     Show relevant information of this CxLink Backup
     --------------------------------------------------------------------------------
     Catalog & Backups management
     --------------------------------------------------------------------------------
     Generate troubleshooting package to be sent to Syntax Support
     --------------------------------------------------------------------------------
     Exit
   

3. Select External endpoint notification (AWS SNS Service):

   ? CxLink Backup: Monitoring
   ? Select :   [Use arrows to move, enter to select, type to filter]
   Syntax Dashboard notification
   Local monitoring
   > External endpoint notification (AWS SNS Service)
   Back
   

4. Select Disable external endpoint monitoring:

   ? CxLink Backup: Monitoring
   ? Select :  External endpoint notification (AWS SNS Service)
   ? Select :  [Use arrows to move, enter to select, type to filter]
   > Disable external endpoint monitoring
   Back
   

5. You can now select Return and Exit to save the configuration if no other action should be taken.