翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# aws-apigateway-sqs
<a name="aws-apigateway-sqs"></a>

![\[alt text not found\]](http://docs.aws.amazon.com/ja_jp/solutions/latest/constructs/images/experimental.png)


 すべてのクラスは積極的に開発されており、将来のバージョンでは下位互換性がない変更または削除の対象となります。これらは、[セマンティックバージョン管理](https://semver.org/)モデル。つまり、これらのパッケージを使用するかもしれませんが、このパッケージの新しいバージョンにアップグレードするときにソースコードを更新する必要があるかもしれません。

**注意:** 正しく機能するためには、プロジェクト内の AWS ソリューション構築パッケージと AWS CDK パッケージが同じバージョンである必要があります。


|  **言語**  |  **パッケージ**  | 
| --- | --- | 
|  ![\[alt text not found\]](http://docs.aws.amazon.com/ja_jp/solutions/latest/constructs/images/python.png) Python  |  aws\$1solutions\$1constructs.aws\$1apigateway\$1sqs  | 
|  ![\[alt text not found\]](http://docs.aws.amazon.com/ja_jp/solutions/latest/constructs/images/typescript.png) TypeScript  |  @aws-solutions-constructs/aws-apigateway-sqs  | 
|  ![\[alt text not found\]](http://docs.aws.amazon.com/ja_jp/solutions/latest/constructs/images/java.png) Java  |  software.amazon.awsconstructs.services.apigatewaysqs  | 

## Overview
<a name="overview-2"></a>

 この AWS ソリューション構築物は、Amazon SQS キューに接続された Amazon API Gateway REST API を実装します。

 TypeScript の最小限のデプロイ可能なパターン定義は次のとおりです。

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

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

## Initializer
<a name="initializer-2"></a>

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

 *パラメータ* 
+  scope[https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Construct.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Construct.html) 
+  id`string` 
+  props[`ApiGatewayToSqsProps`](#pattern-construct-props-2) 

## パターン構成プロパティ
<a name="pattern-construct-props-2"></a>


|  **名前**  |  **タイプ**  |  **説明**  | 
| --- | --- | --- | 
|  ApigateWayProps？  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApiProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApiProps.html)  |  API Gateway のデフォルトの小道具を上書きするオプションのユーザー提供の小道具です。 | 
|  QueueProp? |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.QueueProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.QueueProps.html)  |  オプションのユーザ提供の小道具で、キューのデフォルトの小道具を上書きします。 | 
|  デプロイデッドレッターキュー？  |  boolean  |  デッドレターキューとして使用するセカンダリキューを展開するかどうか。デフォルトは true です。 | 
|  maxReceiveCount  |  number  |  デッドレターキューに移動する前に、メッセージがデキューに失敗した回数。 | 
|  作成操作を許可しますか? |  boolean  |  キューに Create 操作用の API Gateway メソッドをデプロイするかどうか (SQS: SendMessage)。 | 
|  リクエストテンプレートを作成しますか? |  string  |  Create メソッドのデフォルトの API Gateway リクエストテンプレートを上書きします (allowCreateOperationは、 に設定されます。true。 | 
|  操作を許可しますか? |  boolean  |  読み込み操作用の API Gateway メソッドをキューにデプロイするかどうか (SQS: ReceiveMessage)。 | 
|  readRequestテンプレートですか？  |  string  |  Read メソッドのデフォルトの API Gateway リクエストテンプレートをオーバーライドします (allowReadOperationは、 に設定されます。true。 | 
|  削除操作を許可しますか? |  boolean  |  削除操作のためのAPI Gateway メソッドをキューにデプロイするかどうか（SQS: DeleteMessage）。 | 
|  要求テンプレートを削除しますか? |  string  |  Delete メソッドのデフォルトの API Gateway リクエストテンプレートを上書きします (allowDeleteOperationは、 に設定されます。true。 | 
|  LogGroupPropsかな？  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroupProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroupProps.html)  |  CloudWatch Logs ロググループのデフォルトの小道具を上書きする、オプションのユーザー指定の小道具です。 | 

## パターンプロパティ
<a name="pattern-properties-2"></a>


|  **名前**  |  **タイプ**  |  **説明**  | 
| --- | --- | --- | 
|  apigateway  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApi.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApi.html)  |  パターンによって作成された API Gateway REST API のインスタンスを返します。 | 
|  APIGatewayクラウドウォッチロール  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html)  |  API Gateway REST API から CloudWatch へのアクセスロギングを有効にするパターンによって作成された IAM ロールのインスタンスを返します。 | 
|  APIGateWayLogGroup  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroup.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroup.html)  |  API Gateway REST API アクセスログが送信されるパターンによって作成されたロググループのインスタンスを返します。 | 
|  APIGateWayRole  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html)  |  API Gateway REST API のパターンによって作成された IAM ロールのインスタンスを返します。 | 
|  デッドレッターキュー？  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.Queue.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.Queue.html)  |  パターンによって作成されたデッドレターキューのインスタンスを返します（デプロイされている場合）。 | 
|  SQUEUE  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.Queue.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.Queue.html)  |  パターンによって作成された SQS キューのインスタンスを返します。 | 

## API の使用例
<a name="sample-api-usage"></a>


|  **方法**  |  **リクエストパス**  |  **リクエストボディ**  |  **キューアクション**  |  **説明**  | 
| --- | --- | --- | --- | --- | 
|  GET  |  /  |   |  sqs::ReceiveMessage  |  キューからメッセージを取得します。 | 
|  POST  |  /  |  \$1 "data": "Hello World\$1" \$1  |  sqs::SendMessage  |  メッセージをキューに配信します。 | 
|  DELETE  |  /message?receiptHandle=[value]  |   |  sqs::DeleteMessage  |  指定されたメッセージをキューから削除します。 | 

## デフォルト設定
<a name="default-settings-2"></a>

 オーバーライドなしでこのパターンをすぐに実装すると、次のデフォルトが設定されます。

### Amazon API Gateway
<a name="amazon-api-gateway-2"></a>
+  エッジ最適化 API エンドポイントのデプロイ 
+  API Gateway での CloudWatch によるロギングの有効化 
+  API Gateway の最小権限アクセス IAM ロールを設定する 
+  すべての API メソッドのデフォルトの認証タイプを IAM に設定する 
+  X-Ray トレースを有効にする

### Amazon SQS キュー
<a name="amazon-sqs-queue"></a>
+  ソース SQS キューの SQS デッドレターキューのデプロイ 
+  AWS マネージド KMS キーを使用したソース SQS キューのサーバー側の暗号化を有効にする 
+  転送時のデータの暗号化を強制する 

## Architecture
<a name="architecture-2"></a>

![\[Diagram showing Amazon API Gateway, CloudWatch, and Simple Queue Service interactions with roles.\]](http://docs.aws.amazon.com/ja_jp/solutions/latest/constructs/images/aws-apigateway-sqs.png)


## GitHub
<a name="github-2"></a>


|  **このパターンのコードを表示するには、問題を作成/表示し、プル要求などを行います。**  | 
| --- | 
|  ![\[Circular icon with a graduation cap symbol representing education or learning.\]](http://docs.aws.amazon.com/ja_jp/solutions/latest/constructs/images/GitHub-Mark-32px.png)  |  [@aws-ソリューション-構築/aws-apigateway-sqs](https://github.com/awslabs/aws-solutions-constructs/tree/master/source/patterns/%40aws-solutions-constructs/aws-apigateway-sqs)  |