Adaptateur Amazon SNS

L'adaptateur Amazon SNS permet d'accéder aux services de notification Amazon Simple Notification Service (SNS). Cet adaptateur se connecte aux rubriques SNS à l'aide de clés AWS. L'adaptateur peut récupérer et envoyer des notifications de et vers les rubriques SNS d'AWS auxquelles l'utilisateur est abonné.

Ce document présente l'adaptateur Amazon SNS et décrit ses spécifications fonctionnelles. Amazon Simple Notification Service est un fournisseur de services de notification capable de livrer des messages en masse, essentiellement à des utilisateurs mobiles. Amazon SNS permet de créer des rubriques. Une rubrique est un canal de communication logique qui permet de lancer la livraison en masse d'une catégorie de message spécifique. Les rubriques prennent en charge la messagerie à débit élevé, push et vers de nombreux destinataires. L'adaptateur SNS a pour fonction d'accéder aux rubriques SNS auxquelles l'utilisateur est abonné pour récupérer et envoyer des notifications de et vers celles-ci. Les rubriques SNS résident à différents emplacements géographiques gérés par Amazon Web Services (AWS). Dans AWS, chaque région géographique est désignée par un code de région propre. Pour spécifier une région dans les propriétés de l'adaptateur, le code exact doit être utilisé. Pour en savoir plus sur le service SNS d'AWS, consultez la page https://aws.amazon.com/sns/.

L'adaptateur Amazon SNS utilise la fonctionnalité PUT pour envoyer des notifications vers une rubrique spécifiée en tant que cible dans une carte de sortie. Un adaptateur SNS ne peut pas être utilisé comme source dans une carte d'entrée. Les notifications peuvent uniquement être au format texte. L'adaptateur Amazon SNS ne prend pas en charge l'option d'importation de schémas prédéfinie (predefined-schema-import).

Un utilisateur AWS Identity and Access Management (IAM) peut être créé dans AWS pour accéder aux services SNS. Cet utilisateur représente la personne ou l'application qui l'utilise pour interagir avec AWS. Cet utilisateur est différent de l'utilisateur racine d'un compte AWS. Pour plus d'informations, voir . https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html

Propriétés et commandes de l'adaptateur

Cette section présente les propriétés de l'adaptateur à configurer pour définir les connexions et les actions, et importer des schémas dans l'interface utilisateur Web dans LNK. Le tableau suivant répertorie toutes les propriétés, leur portée, si elles sont requises ou non, et les commandes de l'adaptateur vers lesquelles elles redirigent pour une utilisation dans les mappes compilées et les exécutions de mappe. Une portée "DI" signifie que la propriété est énumérée de manière dynamique ; l'adaptateur est invoqué pendant la configuration d'action pour fournir l'ensemble de valeurs autorisées pour cette propriété. Une description détaillée des propriétés est fournie après le tableau.

Tableau 1. Propriétés de l'adaptateur SNS
Propriété de l'adaptateur	Portée CO : Connexion DI : Reconnaissance IC : Carte d'entrée OC : Carte de sortie G : Fonction GET P : Fonction PUT	Obligatoire	Une commande d'adaptateur correspondante doit être directement utilisée dans les fonctions GET et PUT
accessKey= access_key	CO	Oui	-AK `access_key`
secretKey= secret_key	CO	Oui	-SK `secret_key`
region= region_name	CO	Oui	-R `region_name`
topicArn= topic_arn	DI/OC/P	Oui	-TARN `topic_arn`
create Topic= create_topic	OC/P	Non	-CT
logging=info\|errors\|verbose\|off	OC/P	Non	-T[E\|V]?[+]? `[file_name]`
append_log=true\|false	IC/OC/G/P	Non	-T[E\|V]?[+]? `[file_name]`
log_file_name=file_name	OC/P	Non	-T[E\|V]?[+]? `[file_name]`

accessKey= access_key

Cette propriété spécifie la clé d'accès de l'utilisateur AWS pour la connexion. La clé d'accès est utilisée pour signer les demandes par programmation envoyées aux appels d'API AWS via l'adaptateur. La clé d'accès peut être utilisée avec -ACCESSKEY ou -AK command.

secretKey= secret_key

Cette propriété spécifie la clé secrète de l'utilisateur AWS pour la connexion. Comme le nom d'utilisateur et le mot de passe, l'ID de clé d'accès et la clé d'accès secrète sont obligatoires pour authentifier les demandes PUT d'une rubrique SNS. La clé secrète peut être transmise à l'adaptateur avec la commande -SECRETKEY ou -SK.

region= region_name

L'adaptateur utilise le nom de la région pour se connecter à une région AWS pour le compte de l'utilisateur IAM. Une région peut être transmise à l'adaptateur avec la commande -REGION ou -R.

topicArn= topic_arn

Le format de rubrique ARN (Amazon Resource Name) est utilisé pour identifier chaque rubrique dans AWS. Cette propriété spécifie l'ARN de la rubrique où sont stockées les notifications. Lors de la configuration des actions, l'adaptateur SNS propose différentes options pour sélectionner l'ARN d'une rubrique parmi celles disponibles dans la région en question. La propriété topic_arn peut également être transmise à la carte d'entrée ou de sortie de l'adaptateur à l'aide de la commande -TOPICARN ou -TARN.

Pour créer une rubrique SNS, reportez-vous au lien suivant : https://docs.aws.amazon.com/gettingstarted/latest/deploy/creating-an-sns-topic.html.

createTopic= create_topic

Lorsque cette propriété est spécifiée, le système demande à l'adaptateur SNS de créer une rubrique avec le nom transmis dans la propriété "topic_arn", si celle-ci n'existe pas déjà. Cette propriété est facultative. Lorsque la propriété create_topic n'est pas spécifiée, l'adaptateur vérifie si la rubrique existe. Si ce n'est pas le cas, il génère une erreur. L'option Créer une rubrique peut être transmise à la carte d'entrée ou de sortie de l'adaptateur à l'aide de la commande -CREATETOPIC ou -CT.

logging=info|errors|verbose|off

Cette propriété spécifie le niveau de journalisation à utiliser pour le log (trace) file produit par l'adaptateur. Par défaut, la valeur est "off". La valeur "info" signifie de consigner les messages d'information et d'erreur, la valeur "error" signifie de consigner uniquement les messages d'erreur et la valeur "verbose" signifie de consigner les messages de débogage et de niveau de trace en plus des messages d'information et d'erreur.

append_log=true|false

Cette propriété spécifie l'indicateur qui signale l'action à prendre lorsque le log file spécifié existe déjà. Lorsque la valeur est "true", les messages du journal sont annexés au fichier. Lorsque la valeur est "false", le fichier est tronqué et les messages sont écrits dans le fichier vide. La valeur par défaut est true.

log_file_name=file_name

Il s'agit du nom du log file où les messages du journal doivent être écrits. S'il n'est pas spécifié, le système utilise le nom du fichier journal par défaut m4s3.trc et stocke le fichier dans le directory où se trouve la carte compilée exécutée.

Exemples_{Exemples de fonction de mappe PUT (fonction GET non prise en charge dans l'adaptateur SNS)}

Dans l'exemple suivant, supposons que l'adaptateur utilisé dans une fonction PUT soit défini comme suit :

PUT("SNS", " -AK AKSOMEACCESSKEY -SK SkSomeSecretKey/dBLo -R US_WEST_2 -TARN arn:aws:sns:us-west-2:123456789012:gsg-signup-notifications", inputdata) Dans ce cas, si la rubrique "gsg-signup-notifications" n'existe pas dans la région spécifiée, l'adaptateur génère une erreur en raison de l'absence de -CREATETOPIC/-CT.

Supposons à présent que la fonction de mappe PUT soit définie comme suit :

PUT("SNS", " -AK AKSOMEACCESSKEY -SK SkSomeSecretKey/dBLo -R US_WEST_2 -TARN arn:aws:sns:us-west-2:123456789012:gsg-signup-notifications -CT",inputdata)

Dans ce cas, l'adaptateur crée l'ARN de la rubrique avant d'envoyer la notification vers la nouvelle rubrique.