View a markdown version of this page

aws-evenements-rule-sqs - Constructions dans les Solutions d'AWS
PrésentationInitialiseurModèle de constructionPropriétés de modèleParamètres par défautArchitectureGitHub

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

aws-evenements-rule-sqs

Toutes les classes sont en cours de développement actif et sujettes à des modifications ou à des suppressions non rétrocompatibles dans n'importe quelle version future. Celles-ci ne sont pas assujetties à laGestion de versions sémantiquesModèle. Cela signifie que même si vous pouvez les utiliser, vous devrez peut-être mettre à jour votre code source lors de la mise à niveau vers une version plus récente de ce package.

Remarque: Pour garantir une bonne fonctionnalité, les packages AWS Solutions Constructs et AWS CDK de votre projet doivent être la même version.

Langage Package
Python 		aws_solutions_constructs.aws_events_rule_sqs
TypeScript 		@aws-solutions-constructs/aws-events-rule-sqs
Java 		software.amazon.awsconstructs.services.eventsrulesqs

Overview

Ce modèle implémente une règle Amazon CloudWatch Events connectée à une file d'attente Amazon SQS.

Voici une définition de modèle déployable minimale : 


import { Duration } from '@aws-cdk/core';
import * as events from '@aws-cdk/aws-events';
import * as iam from '@aws-cdk/aws-iam';
import { EventsRuleToSqsProps, EventsRuleToSqs } from "@aws-solutions-constructs/aws-events-rule-sqs";

const props: EventsRuleToSqsProps = {
    eventRuleProps: {
      schedule: events.Schedule.rate(Duration.minutes(5))
    }
};

const constructStack = new EventsRuleToSqs(this, 'test-construct', props);

// Grant yourself permissions to use the Customer Managed KMS Key
const policyStatement = new iam.PolicyStatement({
    actions: ["kms:Encrypt", "kms:Decrypt"],
    effect: iam.Effect.ALLOW,
    principals: [ new iam.AccountRootPrincipal() ],
    resources: [ "*" ]
});

constructStack.encryptionKey?.addToResourcePolicy(policyStatement);

Initializer


new EventsRuleToSqs(scope: Construct, id: string, props: EventsRuleToSqsProps);

Paramètres

Modèle de construction

Nom Type Description
EventTruleProps events.RuleProps Propriétés fournies par l'utilisateur pour remplacer les propriétés par défaut de la règle CloudWatch Events.
QueueObj existant ? sqs.Queue Une file d'attente SQS existante facultative à utiliser à la place de la file d'attente par défaut. Fournissant à la fois ceci etqueuePropsprovoquera une erreur.
QueueProps ? sqs.QueueProps Propriétés facultatives fournies par l'utilisateur pour remplacer les propriétés par défaut de la file d'attente SQS. Ignoré si unexistingQueueObjest fourni.
EnableQueueUrging ? boolean Indique s'il faut accorder des autorisations supplémentaires à la fonction Lambda lui permettant de purger la file d'attente SQS. La valeur par défaut est false.
Déploiement DeadletterQueue ? boolean Indique s'il faut créer une file d'attente secondaire à utiliser comme file d'attente de lettres mortes. La valeur par défaut est true.
DeadletterQueueProps ? sqs.QueueProps Props fournis par l'utilisateur en option pour remplacer les accessoires par défaut de la file d'attente de lettres mortes. Utilisé uniquement si ledeployDeadLetterQueueest défini sur true.
MaxReceiveCount ? number Nombre de fois qu'un message peut être déplacé sans succès avant d'être déplacé vers la file d'attente de lettres mortes. La valeur par défaut est 15.
EnableEncryptionWithCustomerManagedKey ? boolean Indique s'il faut utiliser une clé de chiffrement gérée par le client, soit gérée par cette application CDK, soit importée. Si vous importez une clé de chiffrement, elle doit être spécifiée dans laencryptionKeypour cette construction.
encryptionKey ? kms.Key Une clé de chiffrement existante facultative à utiliser à la place de la clé de chiffrement par défaut.
EncryptionKeyProps ? kms.KeyProps Propriétés facultatives fournies par l'utilisateur pour remplacer les propriétés par défaut de la clé de chiffrement.

Propriétés de modèle

Nom Type Description
EventsRègle events.Rule Renvoie une instance de la règle Events créée par le modèle.
SQSqueue sqs.Queue Renvoie une instance de la file d'attente SQS créée par le modèle.
encryptionKey kms.Key Renvoie une instance de la clé de chiffrement créée par le modèle.
DeadletterQueue ? sqs.Queue Renvoie une instance de la file d'attente de lettres mortes créée par le modèle, si une instance est déployée.

Paramètres par défaut

L'implémentation prête à l'emploi de ce modèle sans remplacement définira les valeurs par défaut suivantes :

Amazon CloudWatch Events

  • Accordez les autorisations les moins privilèges aux événements CloudWatch afin de les publier dans la file d'attente SQS.

File d'attente Amazon SQS

  • Déployer une file d'attente de lettres mortes pour la file d'attente source.

  • Activer le chiffrement côté serveur pour la file d'attente source à l'aide d'une clé AWS KMS gérée par le client.

  • Application du chiffrement des données en transit.

Architecture

GitHub

Pour afficher le code de ce modèle, créer/afficher les problèmes et les demandes d'extraction, et plus encore :
@aws -solutions-constructs/aws-events-rule-sqs