WHERE DO I START?
You are here:... (Miscellaneous) > Notifications > AWS SNS

AWS SNS

Add an AWS SNS notification

  1. Type a name for the SNS notification.
  2. Ensure the Enabled checkbox is selected.
  3. Select an AWS Authentication method.
    Tip   If you have an existing role/user created from an AWS integration setup, you can just attach another policy to that role/user. Navigate to the role/user in the IAM Console, and under Managed Policies, click Attach Policy then skip to step ix in the IAM Role instructions, or skip to step viii if you chose Access Key.
    1. If you selected IAM Role:
    2. If you selected Access Key:
  4. Navigate to the SNS console.
  5. Click Topics on the left-hand menu.
  6. Copy the ARN from the ARN column next to the desired topic. Paste the value into the Topic ARN field in the SNS Notification window in Netuitive.
  7. Back in the SNS console, select the same topic, and then click Edit topic policy in the Actions menu.
  8. Under the Allow these users to publish messages to this topic section, select Only these AWS users and add the Account ID from Netuitive to the field.
  9. Click Update Policy.
  10. Return to Netuitive and optionally select Custom from the Payload drop-down menu. A text field will open after selecting Custom. Create a custom JSON payload in the textbox. You can use the following variables to make your notification more dynamic. To test your template, go here or visit the GitHub page.
    VariableDescription
    ${eventCategory.name}

    The event category ( (Info), (Warning), or (Critical)).

    ${elementFqn}The Fully Qualified Name (FQN) of the element.
    ${elementId}The type of element (e.g., SERVER, ELB, EC2, RDS, etc.).
    ${elementLocation}The location of the element.
    ${elementName}The friendly name for the element.
    ${policyId}The policy identification number.
    ${policyName}The name of the policy.
    ${eventTimestamp}The time (in UTC) the event occurred.
    ${policyDescription}The description of the policy that generated the event.
    Example(s)   Below is the default payload used in the SNS integration, but it's a good starting place for creating a custom JSON payload.
    {
      "timestamp": "${eventTimestamp}",
      "category": "${eventCategory}",
      "element": {
        "fqn": "${elementFqn}",
        "name": "${elementId}",
        "location": "${elementLocation}"
      },
      "policy": {
        "name": "${policyName}",
        "description": "${policyDescription}"
      }
    }
  11. Click Save.