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-apigateway-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émantiques
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 |
|---|---|
|
aws_solutions_constructs.aws_apigateway_sqs
|
|
@aws-solutions-constructs/aws-apigateway-sqs
|
|
software.amazon.awsconstructs.services.apigatewaysqs
|
Overview
AWS Solutions Construct implémente une API REST Amazon API Gateway connectée à une file d'attente Amazon SQS.
Voici une définition de modèle déployable minimale dans TypeScript :
import { ApiGatewayToSqs, ApiGatewayToSqsProps } from "@aws-solutions-constructs/aws-apigateway-sqs"; new ApiGatewayToSqs(this, 'ApiGatewayToSqsPattern', {});
Initializer
new ApiGatewayToSqs(scope: Construct, id: string, props: ApiGatewayToSqsProps);
Paramètres
-
scope
Construct -
id
string -
propsApiGatewayToSqsProps
Accessoires de construction de modèle
| Nom | Type | Description |
|---|---|---|
| ApigatewayProps ? |
api.RestApiProps
|
Props fournis par l'utilisateur en option pour remplacer les accessoires par défaut de la API Gateway. |
| QueueProps ? |
sqs.QueueProps
|
Props fournis par l'utilisateur en option pour remplacer les accessoires par défaut de la file d'attente. |
| Déploiement DeadletterQueue ? |
boolean
|
Indique s'il faut déployer une file d'attente secondaire à utiliser comme file d'attente de lettres mortes. La valeur par défaut est true. |
| MaxReceiveCount |
number
|
Nombre de fois qu'un message peut être défile d'attente sans succès avant d'être déplacé vers la file d'attente de lettres mortes. |
| AllowCreateOperation ? |
boolean
|
Indique s'il faut déployer une méthode API Gateway pour les opérations Create sur la file d'attente (par exemple SQS:SendMessage). |
| CreateRequestTemplate ? |
string
|
Remplacer le modèle de demande API Gateway par défaut pour la méthode Create, siallowCreateOperationa la valeurtrue. |
| AllowreadOperation ? |
boolean
|
Indique s'il faut déployer une méthode API Gateway pour les opérations Read sur la file d'attente (par exemple SQS:ReceiveMessage). |
| ReadRequestTemplate ? |
string
|
Remplacer le modèle de requête API Gateway par défaut pour la méthode Read, siallowReadOperationa la valeurtrue. |
| AllowDeleteOperation ? |
boolean
|
Indique s'il faut déployer une méthode API Gateway pour les opérations Delete sur la file d'attente (c'est-à-dire SQS:DeleteMessage). |
| DeleteRequestTemplate ? |
string
|
Remplacer le modèle de demande API Gateway par défaut pour la méthode Delete, siallowDeleteOperationa la valeurtrue. |
| LogGroupProps ? |
logs.LogGroupProps
|
Accessoires fournis par l'utilisateur pour remplacer les accessoires par défaut du groupe de journaux CloudWatch Logs. |
Propriétés du modèle
| Nom | Type | Description |
|---|---|---|
| AppiGateway |
api.RestApi
|
Renvoie une instance de l'API Gateway API créée par le modèle. |
| ApigateWayCloudWatchRole |
iam.Role
|
Renvoie une instance du rôle IAM créé par le modèle qui active la journalisation des accès à partir de l'API Gateway API vers CloudWatch. |
| ApigateWayLogGroup |
logs.LogGroup
|
Renvoie une instance du groupe de journaux créé par le modèle auquel les journaux d'accès API REST de API Gateway d'API sont envoyés. |
| ApigateWayRole |
iam.Role
|
Renvoie une instance du rôle IAM créé par le modèle pour l'API Gateway API. |
| 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. |
| SQSqueue |
sqs.Queue
|
Renvoie une instance de la file d'attente SQS créée par le modèle. |
Exemples de scénario d'utilisation
| Méthode | Chemin de la demande | Corps de la demande | Action de la file | Description |
|---|---|---|---|---|
| GET |
/
|
sqs::ReceiveMessage
|
Récupère un message de la file d'attente. | |
| POST |
/
|
{ "data": "Hello World!" }
|
sqs::SendMessage
|
Remet un message dans la file d'attente. |
| DELETE |
/message?receiptHandle=[value]
|
sqs::DeleteMessage
|
Supprime un message spécifié de la file d'attente |
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 API Gateway
-
Déployer un point de terminaison API optimisé pour les périphériques
-
Activer la journalisation CloudWatch pour API Gateway
-
Configurer le rôle IAM d'accès minimal aux privilèges pour API Gateway
-
Définissez l'AuthorizationType par défaut pour toutes les méthodes d'API sur IAM
-
Activer le suivi X-Ray
File d'attente Amazon SQS
-
Déployer la file d'attente de lettres mortes SQS pour la file d'attente SQS source
-
Activer le chiffrement côté serveur pour la file d'attente SQS source à l'aide de la clé KMS gérée par AWS
-
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-apigateway-sqs |
