awssolutionsconstructsawsapigatewaysqs

README

aws-apigateway-sqs module

---

---

Reference Documentation:	https://docs.aws.amazon.com/solutions/latest/constructs/

Language	Package
Python	aws_solutions_constructs.aws_apigateway_sqs
Typescript	@aws-solutions-constructs/aws-apigateway-sqs
Java	software.amazon.awsconstructs.services.apigatewaysqs

Overview

This AWS Solutions Construct implements an Amazon API Gateway connected to an Amazon SQS queue pattern.

Here is a minimal deployable pattern definition 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);

Parameters

• scope Construct
• id string
• props ApiGatewayToSqsProps

Pattern Construct Props

Name	Type	Description
apiGatewayProps?	api.RestApiProps	Optional user-provided props to override the default props for the API Gateway.
queueProps?	sqs.QueueProps	Optional user-provided props to override the default props for the queue.
deployDeadLetterQueue?	boolean	Whether to deploy a secondary queue to be used as a dead letter queue. Defaults to true.
maxReceiveCount	number	The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue.
allowCreateOperation?	boolean	Whether to deploy an API Gateway Method for Create operations on the queue (i.e. sqs:SendMessage).
createRequestTemplate?	string	Override the default API Gateway Request template for Create method, if allowCreateOperation set to true.
allowReadOperation?	boolean	Whether to deploy an API Gateway Method for Read operations on the queue (i.e. sqs:ReceiveMessage).
readRequestTemplate?	string	Override the default API Gateway Request template for Read method, if allowReadOperation set to true.
allowDeleteOperation?	boolean	Whether to deploy an API Gateway Method for Delete operations on the queue (i.e. sqs:DeleteMessage).
deleteRequestTemplate?	string	Override the default API Gateway Request template for Delete method, if allowDeleteOperation set to true.
logGroupProps?	logs.LogGroupProps	User provided props to override the default props for for the CloudWatchLogs LogGroup.

Pattern Properties

Name	Type	Description
apiGateway	api.RestApi	Returns an instance of the API Gateway REST API created by the pattern.
apiGatewayRole	iam.Role	Returns an instance of the iam.Role created by the construct for API Gateway.
apiGatewayCloudWatchRole?	iam.Role	Returns an instance of the iam.Role created by the construct for API Gateway for CloudWatch access.
apiGatewayLogGroup	logs.LogGroup	Returns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch.
sqsQueue	sqs.Queue	Returns an instance of the SQS queue created by the pattern.
deadLetterQueue?	sqs.DeadLetterQueue	Returns an instance of the DeadLetterQueue created by the pattern.

Sample API Usage

Method	Request Path	Request Body	Queue Action	Description
GET	/		sqs::ReceiveMessage	Retrieves a message from the queue.
POST	/	{ "data": "Hello World!" }	sqs::SendMessage	Delivers a message to the queue.
DELETE	/message?receiptHandle=[value]		sqs::DeleteMessage	Deletes a specified message from the queue

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

Amazon API Gateway

• Deploy an edge-optimized API endpoint
• Enable CloudWatch logging for API Gateway
• Configure least privilege access IAM role for API Gateway
• Set the default authorizationType for all API methods to IAM
• Enable X-Ray Tracing

Amazon SQS Queue

• Deploy SQS dead-letter queue for the source SQS Queue
• Enable server-side encryption for source SQS Queue using AWS Managed KMS Key
• Enforce encryption of data in transit

Architecture

---

© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Documentation

Overview

CDK constructs for defining an interaction between an AWS Lambda function and an Amazon S3 bucket.

Index

• func ApiGatewayToSqs_IsConstruct(x interface{}) *bool
• func NewApiGatewayToSqs_Override(a ApiGatewayToSqs, scope constructs.Construct, id *string, ...)
• type ApiGatewayToSqs
  • func NewApiGatewayToSqs(scope constructs.Construct, id *string, props *ApiGatewayToSqsProps) ApiGatewayToSqs
• type ApiGatewayToSqsProps

Functions

func ApiGatewayToSqs_IsConstruct

func ApiGatewayToSqs_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewApiGatewayToSqs_Override

func NewApiGatewayToSqs_Override(a ApiGatewayToSqs, scope constructs.Construct, id *string, props *ApiGatewayToSqsProps)

Types

type ApiGatewayToSqs

type ApiGatewayToSqs interface {
	constructs.Construct
	ApiGateway() awsapigateway.RestApi
	ApiGatewayCloudWatchRole() awsiam.Role
	ApiGatewayLogGroup() awslogs.LogGroup
	ApiGatewayRole() awsiam.Role
	DeadLetterQueue() *awssqs.DeadLetterQueue
	Node() constructs.Node
	SqsQueue() awssqs.Queue
	ToString() *string
}

func NewApiGatewayToSqs

func NewApiGatewayToSqs(scope constructs.Construct, id *string, props *ApiGatewayToSqsProps) ApiGatewayToSqs

type ApiGatewayToSqsProps

type ApiGatewayToSqsProps struct {
	// Whether to deploy an API Gateway Method for Create operations on the queue (i.e. sqs:SendMessage).
	AllowCreateOperation *bool `json:"allowCreateOperation"`
	// Whether to deploy an API Gateway Method for Delete operations on the queue (i.e. sqs:DeleteMessage).
	AllowDeleteOperation *bool `json:"allowDeleteOperation"`
	// Whether to deploy an API Gateway Method for Read operations on the queue (i.e. sqs:ReceiveMessage).
	AllowReadOperation *bool `json:"allowReadOperation"`
	// Optional user-provided props to override the default props for the API Gateway.
	ApiGatewayProps interface{} `json:"apiGatewayProps"`
	// API Gateway Request template for Create method, if allowCreateOperation set to true.
	CreateRequestTemplate *string `json:"createRequestTemplate"`
	// Optional user provided properties for the dead letter queue.
	DeadLetterQueueProps *awssqs.QueueProps `json:"deadLetterQueueProps"`
	// API Gateway Request template for Delete method, if allowDeleteOperation set to true.
	DeleteRequestTemplate *string `json:"deleteRequestTemplate"`
	// Whether to deploy a secondary queue to be used as a dead letter queue.
	DeployDeadLetterQueue *bool `json:"deployDeadLetterQueue"`
	// Existing instance of SQS queue object, providing both this  and queueProps will cause an error.
	ExistingQueueObj awssqs.Queue `json:"existingQueueObj"`
	// User provided props to override the default props for the CloudWatchLogs LogGroup.
	LogGroupProps *awslogs.LogGroupProps `json:"logGroupProps"`
	// The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue.
	MaxReceiveCount *float64 `json:"maxReceiveCount"`
	// User provided props to override the default props for the SQS queue.
	QueueProps *awssqs.QueueProps `json:"queueProps"`
	// API Gateway Request template for Get method, if allowReadOperation set to true.
	ReadRequestTemplate *string `json:"readRequestTemplate"`
}