aws-apigateway-sqs

Alle Klassen befinden sich in aktiver Entwicklung und unterliegen nicht abwärtskompatiblen Änderungen oder Entfernen in jeder zukünftigen Version. Diese unterliegen nicht derSemantische VersionierungModell. Dies bedeutet, dass Sie möglicherweise Ihren Quellcode aktualisieren müssen, wenn Sie ein Upgrade auf eine neuere Version dieses Pakets durchführen.

Hinweis: Um eine ordnungsgemäße Funktionalität sicherzustellen, müssen die AWS Solutions Constructs Pakete und AWS CDK-Pakete in Ihrem Projekt dieselbe Version aufweisen.

Sprache	Paket
Python	aws_solutions_constructs.aws_apigateway_sqs
TypeScript	@aws-solutions-constructs/aws-apigateway-sqs
Java	software.amazon.awsconstructs.services.apigatewaysqs

Overview

Dieses AWS Solutions Construct implementiert eine Amazon API Gateway REST-API, die mit einer Amazon SQS Warteschlange verbunden ist.

Hier ist eine minimale bereitstellbare Musterdefinition in TypeScript:

import { ApiGatewayToSqs, ApiGatewayToSqsProps } from "@aws-solutions-constructs/aws-apigateway-sqs";

new ApiGatewayToSqs(this, 'ApiGatewayToSqsPattern', {});

Initializer

new ApiGatewayToSqs(scope: Construct, id: string, props: ApiGatewayToSqsProps);

Parameter

• BereichConstruct

• idstring

• propsApiGatewayToSqsProps

Muster-Konstrukt

Name	Typ	Beschreibung
ApigatewayProps?	api.RestApiProps	Optionale, vom Benutzer bereitgestellte Requisiten zum Überschreiben der Standard-Requisiten für das API Gateway.
QueueProps?	sqs.QueueProps	Optionale, vom Benutzer bereitgestellte Requisiten zum Überschreiben der Standard-Requisiten für die Warteschlange.
DeployDeadletterQueue?	boolean	Gibt an, ob eine sekundäre Warteschlange bereitgestellt wird, die als Warteschlange für unzustellbare Nachrichten dient. Standardeinstellung: true.
MaxReceiveCount	number	— Die Anzahl, wie oft eine Nachricht nicht erfolgreich entfernt werden kann, bevor sie in die Warteschlange für unzustellbare Nachrichten verschoben wird.
AllowCreateOperation?	boolean	Gibt an, ob eine API Gateway -Methode für Create-Operationen in der Warteschlange bereitgestellt werden soll (dh SQS:SendMessage).
CreateRequestTemplate?	string	Überschreiben Sie die standardmäßige API Gateway -Anforderungsvorlage für die Create-Methode, wennallowCreateOperationwird auf gesetzttrue.
ReadOperation zulassen?	boolean	Gibt an, ob eine API Gateway -Methode für Lesevorgänge in der Warteschlange bereitgestellt werden soll (dh SQS: ReceiveMessage).
ReadRequestTemplate?	string	Überschreiben Sie die standardmäßige API Gateway -Anforderungsvorlage für die Read-Methode, wennallowReadOperationwird auf gesetzttrue.
AllowDeleteOperation?	boolean	Gibt an, ob eine API Gateway -Methode für Löschvorgänge in der Warteschlange bereitgestellt werden soll (dh SQS:DeleteMessage).
DeleteRequestTemplate?	string	Überschreiben Sie die standardmäßige API Gateway -Anforderungsvorlage für die Delete-Methode, wennallowDeleteOperationwird auf gesetzttrue.
LogGroupProps?	logs.LogGroupProps	Optionale, die vom Benutzer bereitgestellte Requisiten zum Überschreiben der Standardprops für die CloudWatch Logs s-Protokollgruppe

Muster-Eigenschaften

Name	Typ	Beschreibung
ApiGateway-	api.RestApi	Gibt eine Instanz der API Gateway REST-API zurück, die durch das Muster erstellt wurde.
ApigatewayCloudWatchRole	iam.Role	Gibt eine Instanz der IAM-Rolle zurück, die durch das Muster erstellt wurde, das die Zugriffsprotokollierung von der API Gateway REST-API zu CloudWatch ermöglicht.
ApigatewayLogGroup	logs.LogGroup	Gibt eine Instanz der Protokollgruppe zurück, die durch das Muster erstellt wurde, an das API Gateway REST-API-Zugriffsprotokolle gesendet werden.
ApigatewayRole	iam.Role	Gibt eine Instanz der IAM-Rolle zurück, die durch das Muster für die API Gateway REST-API erstellt wurde.
DeadLetterQueue?	sqs.Queue	Gibt eine Instanz der Warteschlange für toten Buchstaben zurück, die durch das Muster erstellt wurde, wenn eine bereitgestellt wird.
SQSQueue	sqs.Queue	Gibt eine Instanz der SQS-Warteschlange zurück, die durch das Muster erstellt wurde.

Beispiele zu Nutzungssproben

Art	Anfrage-Pfad	Anforderungstext	Warteschlangen-Aktion	Beschreibung
GET	/		sqs::ReceiveMessage	Ruft eine Nachricht aus der Warteschlange
POST	/	{ "data": "Hello World!" }	sqs::SendMessage	Übergibt eine Nachricht an die Warteschlange
DELETE	/message?receiptHandle=[value]		sqs::DeleteMessage	Löscht eine angegebene Nachricht aus der Warteschlange

Standardeinstellungen

Die vorgefertigte Implementierung dieses Musters ohne Überschreibungen setzt die folgenden Standardwerte:

Amazon API Gateway

• Bereitstellen eines Edge-optimierten API-Endpunkts

• Aktivieren der CloudWatch Protokollierung für API Gateway

• Konfigurieren der IAM-Rolle für den Zugriff auf die geringste Berechtigung für API Gateway

• Legen Sie den standardmäßigen AuthorizationType für alle API-Methoden auf IAM fest

• Aktivieren der X-Ray blaufverfolgung

Amazon SQS-Warteschlange

• Bereitstellen einer SQS-Warteschlange für unzustellbare Nachrichten für die SQS-Quellwarteschlange

• Aktivieren der serverseitigen Verschlüsselung für Quell-SQS-Warteschlange mithilfe von AWS verwalteten KMS-Schlüssel

• Erzwingen der Verschlüsselung von Daten während der Übertragung

Architecture

GitHub

Um den Code für dieses Muster anzuzeigen, erstellen/anzeigen Probleme und Pull-Anforderungen usw.:
	@aws -solutions-constructs/aws-apigateway-sqs