メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

Amazon API Gateway メソッドの統合

Integration は、Amazon API Gateway (API Gateway) メソッドが呼び出すターゲットバックエンドに関する情報を指定する AWS::ApiGateway::Method リソースのプロパティです。

構文

JSON

Copy
{ "CacheKeyParameters" : [ String, ... ], "CacheNamespace" : String, "Credentials" : String, "IntegrationHttpMethod" : String, "IntegrationResponses" : [ IntegrationResponse, ... ], "PassthroughBehavior" : String, "RequestParameters" : { 文字列: 文字列, ... }, "RequestTemplates" : { 文字列: 文字列, ... }, "Type" : String, "Uri" : String }

YAML

Copy
CacheKeyParameters: - 文字列 CacheNamespace: String Credentials: String IntegrationHttpMethod: String IntegrationResponses: IntegrationResponse PassthroughBehavior: String RequestParameters: 文字列: 文字列 RequestTemplates: 文字列: 文字列 Type: String Uri: String

プロパティ

CacheKeyParameters

API Gateway がキャッシュする値を持つリクエストパラメーターのリスト。

Required: No

Type: List of String values

CacheNamespace

キャッシュされた関連パラメーターの API 固有のタググループ。

Required: No

Type: String

Credentials

統合に必要な認証情報。API Gateway が引き受ける AWS Identity and Access Management (IAM) ロールを指定するには、ロールの Amazon リソースネーム (ARN) を指定します。呼び出し元の ID をリクエストから渡すよう要求するには、arn:aws:iam::*:user/* を指定します。

AWS Lambda (Lambda) 関数でリソースベースのアクセス権限を使用するには、このプロパティを指定しないでください。API Gateway に関数の呼び出しを許可するには、AWS::Lambda::Permission リソースを使用します。詳細については、AWS Lambda Developer Guide の「Allow Amazon API Gateway to Invoke a Lambda Function」を参照してください。

Required: No

Type: String

IntegrationHttpMethod

統合の HTTP メソッドタイプ。

Required: Conditional。Type プロパティでは、MOCK を指定した場合、このプロパティはオプションです。 他のすべてのタイプでは、このプロパティを指定する必要があります。

Type: String

IntegrationResponses

メソッドのバックエンドがリクエストの処理を完了した後に API Gateway が生成するレスポンス。API Gateway がバックエンドレスポンスを開示する方法を制御できるように、API Gateway はバックエンドのレスポンスを傍受します。たとえば、定義したコードに、バックエンドステータスコードをマッピングできます。

Required: No

Amazon API Gateway のメソッドの統合 IntegrationResponseType: リスト

PassthroughBehavior

API Gateway が対象バックエンドにリクエストを渡すときを示します。この動作は、リクエストの Content-Type ヘッダーと、そのマッピングテンプレートを定義するかどうかによって異なります。

詳細と有効な値については、API Gateway APIリファレンスpassthroughBehavior フィールドを参照してください。

Required: No

Type: String

RequestParameters

API Gateway がバックエンドリクエストとともに送信するリクエストパラメーター。リクエストパラメーターをキーと値のペア (文字列から文字列へのマッピング) として指定します。送信先がキー、ソースが値です。

パターン integration.request.location.name を使用して送信先を指定します。location は、querystringpath、または header で、name は一意の有効なパラメーター名です。

ソースは、既存のメソッドリクエストパラメーターまたは静的な値である必要があります。静的な値は、一重引用符で囲まれ、リクエスト内の送信先に基づいて事前にエンコードされている必要があります。

Required: No

: キーと値のペアのマッピング

RequestTemplates

リクエストペイロードに適用される Apache Velocity テンプレートのマップ。API Gateway が使用するテンプレートは、クライアントにより送信される Content-Type ヘッダーの値に基づいています。コンテンツタイプ値はキーで、テンプレートは次のスニペットのような値 (文字列として指定) です。

Copy
"application/json": "{\n \"statusCode\": \"200\"\n}"

テンプレートの詳細については、API Gateway 開発者ガイド の「API Gateway API リクエストとレスポンスペイロードのマッピングテンプレートのリファレンス」を参照してください。

Required: No

: キーと値のペアのマッピング

Type

メソッドが実行するバックエンドのタイプ (HTTPMOCK など)。すべての有効な値については、Amazon API Gateway REST API リファレンスIntegration リソースの type プロパティを参照してください。

Required: Yes

Type: String

Uri

統合の Uniform Resource Identifier (URI)。

Type プロパティに HTTP を指定した場合、API エンドポイント URL を指定します。

Type プロパティに MOCK を指定した場合、このプロパティを指定しないでください。

Type プロパティに AWS を指定した場合、arn:aws:apigateway:region:subdomain.service|service:path|action/service_api の形式に従う AWS Service を指定します。たとえば、Lambda 関数の URI は arn:aws:apigateway:region:lambda:path/path の形式に従います。パスの形式は通常 /2015-03-31/functions/LambdaFunctionARN/invocations です。詳細については、Amazon API Gateway REST API リファレンス にある統合リソースの uri プロパティを参照してください。

Required: Conditional。Type プロパティに HTTP または AWS を指定した場合は、このプロパティを指定する必要があります。

Type: String

このページの内容: