Amazon SNS account details

To establish a connection to Amazon SNS, you must add an account that defines the account details to connect with. You can define these details by creating a configuration object in the App Connect Dashboard, the Red Hat® OpenShift® web console or CLI, or the Kubernetes CLI.

Account parameters

You can define one or more accounts for Amazon SNS.

For each account that you require, you can specify a new set of account details in any of the following ways:

  • If you are using the App Connect Dashboard, either complete the Account details fields in the Create configuration panel, or specify the account parameters in an accounts.yaml file before importing it into the Create configuration panel. For more information, see Accounts type.
  • If you are using the Red Hat OpenShift web console or CLI, or the Kubernetes CLI, specify the account parameters in an accounts.yaml file, and then use this configuration file to create a configuration object. For more information, see Creating the file for a configuration object of type Accounts.

The set of required and optional Account fields or parameters are listed in the following table.

For information about locating the values for these account parameters, see Locating the values for the account parameters.

Field Parameter Values Condition Description

Account name

name

User defined

Required

The name of an Amazon SNS account that is used in the exported flow.

Secret access key

secretAccessKey

User defined

Required

The secret access key for Amazon SNS.

Access key ID

accessKeyId

User defined

Required

The access key ID for the Amazon SNS account.

Region

region

User defined

Required

The region of your Amazon SNS instance (for example, us-east-2).

Locating the values for the account parameters

To obtain connection values for Amazon SNS, complete the following steps.
  1. Sign in to your Amazon Web Services account.
  2. You can find the value for the region parameter at the end of the URL when you are logged in to the AWS Management Console (for example, https://us-east-2.console.aws.amazon.com/console/home?region=us-east-2#).
  3. To find values for the secretAccessKey and accessKeyId parameters, click your account name on the navigation bar and select My Security Credentials.
  4. Existing access key IDs are listed on the AWS IAM Credentials tab. To create an access key, click Create access key, then click Download credentials to download the access key ID and secret access key.

Example

Remember: An accounts.yaml file that defines one or more accounts must always begin with the following line:
accounts:

  amazonsns:
    - name: Account 1
      credentials:
        secretAccessKey: aB1cDEFghIJKlmNOpqRS23t4U5VWXxzABCDEFGhI
        accessKeyId: ABCDEF1GHIJ23KLMN4OP
        region: us-east-2
      endpoint: {}