Amazon Simple Notification Service (Amazon SNS) is a messaging service in the Amazon Web Service (AWS) ecosystem. Publishers send their messages to the applicable SNS topics. Subscribers consume those messages as notifications from Amazon via various protocols (such as Lambda and Amazon SQS) by subscribing to the topics that matter to them. When using an Amazon SNS Notification Publisher, PingFederate is the publisher, and the intended recipients are the subscribers. Topics are the destinations, to which PingFederate publishes messages. When configuring an Amazon SNS Notification Publisher instance, you must specify an Amazon SNS topic.

For more information about Amazon SNS and topic management, please refer to AWS documentation on Amazon SNS (docs.aws.amazon.com/sns/latest/dg/welcome.html).

  1. Go to the System > Notification Publishers screen.
  2. Click Create New Instance to create a new instance of the Amazon SNS Notification Publisher.

    To modify an existing instance, select it by its name under Instance Name instead.

  3. On the Instance Configuration screen, configure the notification publisher instance as follows.
    Field Description
    SNS Topic ARN The Amazon Resource Name (ARN) topic to which PingFederate publishes messages.

    Enter an ARN in this format: arn:aws:[service]:[region]:[accountid]:[resourceType/resourcePath]

    Max Payload Size The maximum payload size in kilobytes.

    Click Show Advanced Fields to reveal this field. Enter a value between 1 and 8192.

    The default value is 256.

PingFederate categorizes notification messages into various event types. Each event type comes with a set of relevant information to help subscribers craft the final message for the intended audience. For more information, refer to the subsequent topic.