aws-apigateway-kinesisstreams - Konstrukte für AWS S-Lösungen

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

aws-apigateway-kinesisstreams

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_kinesisstreams
Typoskript
@aws-solutions-constructs/aws-apigateway-kinesisstreams
Java
software.amazon.awsconstructs.services.apigatewaykinesisstreams

Overview

Dieses Muster implementiert eine Amazon API Gateway REST-API, die mit einem Amazon Kinesis Datenstrom verbunden ist.

Hier ist eine minimale bereitstellbare Musterdefinition in TypeScript:

import { ApiGatewayToKinesisStreams, ApiGatewayToKinesisStreamsProps } from '@aws-solutions-constructs/aws-apigateway-kinesisstreams'; new ApiGatewayToKinesisStreams(this, 'test-apigw-kinesis', {});

Initializer

new ApiGatewayToKinesisStreams(scope: Construct, id: string, props: ApiGatewayToKinesisStreamsProps);

Parameter

Muster Konstrukt Requisiten

Name Typ Beschreibung
ApigatewayProps? api.RestApiProps Optionale, vom Benutzer bereitgestellte Requisiten zum Überschreiben der Standard-Requisiten für die API Gateway REST-API
PutRecordRequestTemplate? string API Gateway -Anforderungsvorlage für die PutRecord -Aktion Wenn nicht angegeben, wird ein Standardwert verwendet.
PutRecordRequestModel? api.ModelOptions API Gateway -Anforderungsmodell für die PutRecord -Aktion Wenn nicht angegeben, wird ein Standardwert erstellt.
PutRecordsRequestTemplate? string API Gateway Anforderungsvorlage für die PutRecords -Aktion. Wenn nicht angegeben, wird ein Standardwert verwendet.
PutRecordRequestModel? api.ModelOptions API Gateway -Anforderungsmodell für die PutRecords Aktion Wenn nicht angegeben, wird ein Standardwert erstellt.
Bestehend StreamObj? kinesis.Stream Vorhandene Instanz von Kinesis Stream, die sowohl diese als auchkinesisStreamPropsführt zu einem -Fehler.
KinesisStreamProps? kinesis.StreamProps Optionale, vom Benutzer bereitgestellte Requisiten zum Überschreiben der Standard-Requisiten für den Kinesis Stream.
LogGroupProps? logs.LogGroupProps Optionale, vom Benutzer bereitgestellte Requisiten zum Überschreiben der Standardprops für die CloudWatch Logs s-Protokollgruppe

Muster-Eigenschaften

Name Typ Beschreibung
Apigateway-Version api.RestApi Gibt eine Instanz der API Gateway REST-API zurück, die durch das Muster erstellt wurde.
ApigatewayRole iam.Role Gibt eine Instanz der IAM-Rolle zurück, die durch das Muster für die API Gateway REST-API 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.
KinesisStream kinesis.Stream Gibt eine Instanz des Kinesis Streams zurück, der durch das Muster erstellt wurde.

Beispiele zu API-Nutzung

Art Anfordern Anforderungstext Warteschlangen-Aktion Beschreibung
POST /record
{ "data": "Hello World!", "partitionKey": "pk001" }
kinesis:PutRecord Schreibt einen einzelnen Datensatz in den Stream.
POST /records
{ "records": [ { "data": "abc", "partitionKey": "pk001" }, { "data": "xyz", "partitionKey": "pk001" } ] }
kinesis:PutRecords Schreibt mehrere Datensätze in einem einzigen Aufruf in den Stream.

Standardeinstellungen

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

Amazon API Gateway

  • Stellen Sie einen Edge-optimierten API-Endpunkt bereit.

  • Aktivieren Sie die CloudWatch Protokollierung für API Gateway.

  • Konfigurieren Sie die 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.

  • Überprüfen Sie den Anforderungstext, bevor Sie Daten an Kinesis übergeben.

Amazon Kinesis Data Stream

  • Konfigurieren Sie IAM-Rolle für den Zugriff auf die geringste Berechtigung für Kinesis Stream.

  • Aktivieren Sie die serverseitige Verschlüsselung für Kinesis Stream mit AWS Managed KMS Key.

Architecture

GitHub

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