AWS Management Console AWS CLI AWS SDK API Amazon SNS AWS CloudFormation

Application d'une politique de filtrage d'abonnement

Vous pouvez appliquer une politique de filtrage à un abonnement Amazon SNS à l'aide de la console Amazon SNS. Ou, pour appliquer des politiques par programmation, vous pouvez utiliser l'API Amazon SNS, AWS Command Line Interface le AWS CLI() ou AWS tout autre SDK compatible avec Amazon SNS. Vous pouvez également utiliser AWS CloudFormation.

Important

AWS des services tels que IAM et Amazon SNS utilisent un modèle informatique distribué appelé cohérence éventuelle. Les ajouts ou modifications de politique de filtrage d'abonnement nécessitent jusqu'à 15 minutes pour prendre effet.

AWS Management Console

Connectez-vous à la console Amazon SNS.
Dans le panneau de navigation, choisissez Abonnements.
Sélectionnez un abonnement, puis choisissez Edit (Modifier).
Sur la page Edit (Modifier), développez la section Subscription filter policy (Stratégie de filtrage d'abonnement).
Choisissez entre le filtrage basé sur les attributs ou le filtrage basé sur la charge utile.
Dans le champ JSON editor (Éditeur JSON), indiquez le corps JSON de votre stratégie de filtrage.
Sélectionnez Enregistrer les modifications.

Amazon SNS applique votre politique de filtrage à l'abonnement.

AWS CLI

Pour appliquer une politique de filtrage avec le AWS Command Line Interface (AWS CLI), utilisez la set-subscription-attributescommande, comme indiqué dans l'exemple suivant. Pour l'option --attribute-name, spécifiez FilterPolicy. Pour --attribute-value, spécifiez votre politique JSON.


$ aws sns set-subscription-attributes --subscription-arn arn:aws:sns: ... --attribute-name FilterPolicy --attribute-value '{"store":["example_corp"],"event":["order_placed"]}'

Pour fournir un code JSON valide pour votre politique, placez les noms et les valeurs d'attributs entre guillemets. Vous devez également placer la totalité de l'argument de la politique entre guillemets. Pour éviter l'échappement des guillemets, vous pouvez utiliser des apostrophes pour entourer la politique et des guillemets pour entourer les noms et les valeurs JSON, comme illustré dans l'exemple ci-dessus.

Si vous souhaitez passer du filtrage des messages basé sur les attributs (par défaut) au filtrage des messages basé sur la charge utile, vous pouvez également utiliser la set-subscription-attributescommande. Pour l'option --attribute-name, spécifiez FilterPolicyScope. Pour --attribute-value, spécifiez MessageBody.


$ aws sns set-subscription-attributes --subscription-arn arn:aws:sns: ... --attribute-name FilterPolicyScope --attribute-value MessageBody

Pour vérifier que votre politique de filtre a été appliquée, utilisez la commande get-subscription-attributes. Les attributs dans la sortie du terminal doivent afficher votre politique de filtre pour la clé FilterPolicy, comme illustré dans l'exemple suivant:


$ aws sns get-subscription-attributes --subscription-arn arn:aws:sns: ...
{
    "Attributes": {
        "Endpoint": "endpoint . . .", 
        "Protocol": "https",
        "RawMessageDelivery": "false", 
        "EffectiveDeliveryPolicy": "delivery policy . . .",
        "ConfirmationWasAuthenticated": "true", 
        "FilterPolicy": "{\"store\": [\"example_corp\"], \"event\": [\"order_placed\"]}", 
        "FilterPolicyScope": "MessageAttributes",
        "Owner": "111122223333", 
        "SubscriptionArn": "arn:aws:sns: . . .", 
        "TopicArn": "arn:aws:sns: . . ."
    }
}

AWS SDK

Les exemples de code suivants montrent comment utiliserSetSubscriptionAttributes.

Important

Si vous utilisez l'exemple SDK for Java 2.x, la classe SNSMessageFilterPolicy n'est pas disponible dès le départ. Pour obtenir des instructions sur l'installation de cette classe, consultez l'exemple du GitHub site Web.

CLI

AWS CLI

Pour définir des attributs d'abonnement

L'exemple set-subscription-attributes suivant définit l'attribut RawMessageDelivery sur un abonnement SQS.


aws sns set-subscription-attributes \
    --subscription-arn arn:aws:sns:us-east-1:123456789012:mytopic:f248de18-2cf6-578c-8592-b6f1eaa877dc \
    --attribute-name RawMessageDelivery \
    --attribute-value true

Cette commande ne produit aucun résultat.

L'exemple set-subscription-attributes suivant définit un attribut FilterPolicy sur un abonnement SQS.


aws sns set-subscription-attributes \
    --subscription-arn arn:aws:sns:us-east-1:123456789012:mytopic:f248de18-2cf6-578c-8592-b6f1eaa877dc \
    --attribute-name FilterPolicy \
    --attribute-value "{ \"anyMandatoryKey\": [\"any\", \"of\", \"these\"] }"

Cette commande ne produit aucun résultat.

L'exemple set-subscription-attributes suivant supprime l'attribut FilterPolicy d'un abonnement SQS.


aws sns set-subscription-attributes \
    --subscription-arn arn:aws:sns:us-east-1:123456789012:mytopic:f248de18-2cf6-578c-8592-b6f1eaa877dc \
    --attribute-name FilterPolicy \
    --attribute-value "{}"

Cette commande ne produit aucun résultat.

Pour plus de détails sur l'API, reportez-vous SetSubscriptionAttributesà la section Référence des AWS CLI commandes.

Java

Kit SDK pour Java 2.x

Note

Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le référentiel d’exemples de code AWS.


import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.sns.SnsClient;
import software.amazon.awssdk.services.sns.model.SnsException;
import java.util.ArrayList;

/**
 * Before running this Java V2 code example, set up your development
 * environment, including your credentials.
 *
 * For more information, see the following documentation topic:
 *
 * https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
 */
public class UseMessageFilterPolicy {
    public static void main(String[] args) {
        final String usage = """

                Usage:    <subscriptionArn>

                Where:
                   subscriptionArn - The ARN of a subscription.

                """;

        if (args.length != 1) {
            System.out.println(usage);
            System.exit(1);
        }

        String subscriptionArn = args[0];
        SnsClient snsClient = SnsClient.builder()
                .region(Region.US_EAST_1)
                .build();

        usePolicy(snsClient, subscriptionArn);
        snsClient.close();
    }

    public static void usePolicy(SnsClient snsClient, String subscriptionArn) {
        try {
            SNSMessageFilterPolicy fp = new SNSMessageFilterPolicy();
            // Add a filter policy attribute with a single value
            fp.addAttribute("store", "example_corp");
            fp.addAttribute("event", "order_placed");

            // Add a prefix attribute
            fp.addAttributePrefix("customer_interests", "bas");

            // Add an anything-but attribute
            fp.addAttributeAnythingBut("customer_interests", "baseball");

            // Add a filter policy attribute with a list of values
            ArrayList<String> attributeValues = new ArrayList<>();
            attributeValues.add("rugby");
            attributeValues.add("soccer");
            attributeValues.add("hockey");
            fp.addAttribute("customer_interests", attributeValues);

            // Add a numeric attribute
            fp.addAttribute("price_usd", "=", 0);

            // Add a numeric attribute with a range
            fp.addAttributeRange("price_usd", ">", 0, "<=", 100);

            // Apply the filter policy attributes to an Amazon SNS subscription
            fp.apply(snsClient, subscriptionArn);

        } catch (SnsException e) {
            System.err.println(e.awsErrorDetails().errorMessage());
            System.exit(1);
        }
    }
}

Pour plus de détails sur l'API, reportez-vous SetSubscriptionAttributesà la section Référence des AWS SDK for Java 2.x API.

Python

Kit SDK pour Python (Boto3)

Note

Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le référentiel d’exemples de code AWS.


class SnsWrapper:
    """Encapsulates Amazon SNS topic and subscription functions."""

    def __init__(self, sns_resource):
        """
        :param sns_resource: A Boto3 Amazon SNS resource.
        """
        self.sns_resource = sns_resource


    @staticmethod
    def add_subscription_filter(subscription, attributes):
        """
        Adds a filter policy to a subscription. A filter policy is a key and a
        list of values that are allowed. When a message is published, it must have an
        attribute that passes the filter or it will not be sent to the subscription.

        :param subscription: The subscription the filter policy is attached to.
        :param attributes: A dictionary of key-value pairs that define the filter.
        """
        try:
            att_policy = {key: [value] for key, value in attributes.items()}
            subscription.set_attributes(
                AttributeName="FilterPolicy", AttributeValue=json.dumps(att_policy)
            )
            logger.info("Added filter to subscription %s.", subscription.arn)
        except ClientError:
            logger.exception(
                "Couldn't add filter to subscription %s.", subscription.arn
            )
            raise

Pour plus de détails sur l'API, consultez SetSubscriptionAttributesle AWS manuel de référence de l'API SDK for Python (Boto3).

API Amazon SNS

Pour appliquer une politique de filtrage à l'API Amazon SNS, effectuez une demande d'action SetSubscriptionAttributes. Définissez le paramètre AttributeName sur FilterPolicy et définissez le paramètre AttributeValue sur votre politique de filtre JSON.

Si vous souhaitez passer du filtrage des messages basé sur les attributs (par défaut) au filtrage des messages basé sur la charge utile, vous pouvez également utiliser l'action SetSubscriptionAttributes. Définissez le paramètre AttributeName sur FilterPolicyScope, puis le paramètre AttributeValue sur MessageBody.

AWS CloudFormation

Pour appliquer une politique de filtrage en utilisant AWS CloudFormation, utilisez un modèle JSON ou YAML pour créer une AWS CloudFormation pile. Pour plus d'informations, consultez la FilterPolicypropriété de la AWS::SNS::Subscription ressource dans le guide de AWS CloudFormation l'utilisateur et l'exemple de AWS CloudFormation modèle.

Connectez-vous à la console AWS CloudFormation.
Sélectionnez Créer une pile.
Sur la page Select Template (Sélectionner un modèle), choisissez Upload a template to Amazon S3 (Charger un modèle dans Amazon S3), sélectionnez le fichier, puis Next (Suivant).
Sur la page Spécification de détails de base de données, procédez comme suit :
1. Pour le Nom de la pile, tapez MyFilterPolicyStack.
2. Pour myHttpEndpoint, saisissez le point de terminaison HTTP auquel vous souhaitez vous abonner à votre sujet.
  
  Astuce
  Si vous n'avez pas de point de terminaison HTTP, vous pouvez créer en.
Dans la page Options, choisissez Next (Suivant).
Sur la page Review (Vérification), choisissez Create (Créer).

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Correspondance de valeur de chaîne

Suppression d'une politique de filtrage d'abonnement

Application d'une politique de filtrage d'abonnement

Important

AWS Management Console

AWS CLI

AWS SDK

Important

Note

Note

API Amazon SNS

AWS CloudFormation

Astuce