aws-apigateway-sqs

모든 클래스는 활발히 개발 중이며 향후 버전에서 이전 버전과 호환되지 않는 변경 또는 제거 될 수 있습니다. 이들은 적용되지 않습니다의미 체계 버전 관리모델을 검색합니다. 즉, 이 패키지를 사용할 수도 있지만 이 패키지의 최신 버전으로 업그레이드할 때 소스 코드를 업데이트해야 할 수도 있습니다.

참고: 적절한 기능을 보장하려면 프로젝트의 AWS 솔루션 구성 패키지와 AWS CDK 패키지가 동일한 버전이어야 합니다.

언어	패키지
Python	aws_solutions_constructs.aws_apigateway_sqs
타이프 스크립트	@aws-solutions-constructs/aws-apigateway-sqs
Java	software.amazon.awsconstructs.services.apigatewaysqs

Overview

이 AWS 솔루션 구성은 Amazon SQS 대기열에 연결된 Amazon API 게이트웨이 REST API를 구현합니다.

다음은 TypeScript 터의 최소 배포 가능한 패턴 정의입니다.

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

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

Initializer

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

파라미터

• scopeConstruct

• idstring

• propsApiGatewayToSqsProps

소품 패턴 구성

이름	유형	설명
어피게이트웨이 소품?	api.RestApiProps	API Gateway 기본 소품을 재정의하는 선택적 사용자 제공 소품.
대기열 소품?	sqs.QueueProps	대기열의 기본 소품을 재정의하는 선택적 사용자 제공 소품입니다.
배포데드 레터 큐?	boolean	배달 못한 편지 대기열로 사용할 보조 대기열을 배포할지 여부입니다. 기본값은 true입니다.
maxReceiveCount	number	배달 못한 편지 대기열로 이동되기 전에 메시지가 대기열에서 빼지 못한 횟수입니다.
만들기작업 허용하시겠습니까?	boolean	큐에 만들기 작업을위한 API Gateway 메소드를 배포할지 여부 (즉, SQS:sendMessage).
요청 템플릿을 작성하시겠습니까?	string	Create 메서드에 대한 기본 API Gateway 요청 템플릿 재정의 (allowCreateOperation다음의 경우 이 로 설정됩니다.true.
읽기 작업이 허용됩니까?	boolean	대기열에 읽기 작업을위한 API Gateway 메소드를 배포할지 여부 (즉, SQ:ReceiveMessage).
읽기 요청 템플릿	string	Read 메서드에 대한 기본 API Gateway 요청 템플릿을 재정의합니다 (allowReadOperation다음의 경우 이 로 설정됩니다.true.
삭제 작업을 허용하시겠습니까?	boolean	대기열에 삭제 작업을위한 API Gateway 메소드를 배포할지 여부 (즉, SQS:deleteMessage).
삭제 요청 템플릿?	string	Delete 메서드에 대한 기본 API Gateway 요청 템플릿 재정의 (allowDeleteOperation다음의 경우 이 로 설정됩니다.true.
로그그룹Props?	logs.LogGroupProps	CloudWatch Logs 로그 그룹의 기본 소품을 무시하기 위한 선택적 사용자 제공 소품입니다.

패턴 속성

이름	유형	설명
ApiGateway	api.RestApi	패턴에 의해 생성 된 API Gateway REST API의 인스턴스를 돌려줍니다.
아피게이트웨이클라우드워치역할	iam.Role	API Gateway REST API에서 CloudWatch 로의 액세스 로깅을 활성화하는 패턴으로 생성된 IAM 역할의 인스턴스를 반환합니다.
어피게이트웨이로그 그룹	logs.LogGroup	API Gateway REST API 액세스 로그가 전송되는 패턴으로 생성된 로그 그룹의 인스턴스를 반환합니다.
에이피게이트웨이의 역할	iam.Role	API Gateway REST API의 패턴으로 생성된 IAM 역할의 인스턴스를 반환합니다.
데드 레터 큐?	sqs.Queue	패턴에 의해 생성 된 데드 레터 큐의 인스턴스를 돌려줍니다 (배포 된 경우).
분류: SQqueue	sqs.Queue	패턴에 의해 생성된 SQS 대기열의 인스턴스를 반환합니다.

API 사용

방법	요청 경로	요청 본문	대기열 작업	설명
GET	/		sqs::ReceiveMessage	대기열에서 메시지를 검색합니다.
POST	/	{ "data": "Hello World!" }	sqs::SendMessage	대기열로 메시지를 전달합니다.
DELETE	/message?receiptHandle=[value]		sqs::DeleteMessage	대기열에서 지정된 메시지를 삭제합니다.

기본 설정

재정의없이이 패턴을 즉시 구현하면 다음과 같은 기본값이 설정됩니다.

Amazon API Gateway

• 엣지 최적화 API 엔드포인트 배포

• API Gateway 대한 CloudWatch 로깅 사용

• API Gateway 대한 최소 권한 액세스 IAM 역할 구성

• 모든 API 메소드에 대한 기본 권한 부여 유형을 IAM으로 설정

• X-Ray 추적

Amazon SQS 대기열

• 소스 SQS 대기열에 대한 SQS 배달 못한 편지 대기열 배포

• AWS 관리형 KMS 키를 사용하여 소스 SQS 대기열에 대해 서버 측 암호화를 활성화합니다.

• 전송 중인 데이터의 암호화 강제 시행

Architecture

GitHub

이 패턴의 코드를 보려면 문제 및 끌어오기 요청을 작성/조회하는 등의 작업을 수행합니다.
	@aws -솔루션 - 구성/aws-apigateway - 스퀘어