x-amazon-apigateway-any-method オブジェクト - Amazon API Gateway

x-amazon-apigateway-any-method オブジェクト

OpenAPI Path Item オブジェクトの API Gateway キャッチオール ANY メソッドの OpenAPI Operation オブジェクトを指定します。このオブジェクトは、他の Operation オブジェクトとともに指定でき、明示的に宣言されていない HTTP メソッドをキャッチします。

次の表は、API Gateway が拡張するプロパティを示します。他の OpenAPI Operation プロパティについては、OpenAPI の仕様を参照してください。

プロパティ
プロパティ名 タイプ 説明
isDefaultRoute Boolean ルートが $default ルートであるかどうかを指定します。HTTP API でのみサポートされます。詳細については、「HTTP API のルートの使用」を参照してください。
x-amazon-apigateway-integration x-amazon-apigateway-integration オブジェクト メソッドとバックエンドの統合を指定します。これは、OpenAPI Operation オブジェクトの拡張プロパティです。統合のタイプは、AWSAWS_PROXYHTTPHTTP_PROXY、または MOCK です。

x-amazon-apigateway-any-method の例

次の例では、プロキシリソース {proxy+}ANY メソッドで Lambda 関数 TestSimpleProxy と統合しています。

"/{proxy+}": { "x-amazon-apigateway-any-method": { "produces": [ "application/json" ], "parameters": [ { "name": "proxy", "in": "path", "required": true, "type": "string" } ], "responses": {}, "x-amazon-apigateway-integration": { "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789012:function:TestSimpleProxy/invocations", "passthroughBehavior": "when_no_match", "httpMethod": "POST", "type": "aws_proxy" }

次の例では、Lambda 関数 HelloWorld と連動する HTTP API の $default ルートを作成します。

"/$default": { "x-amazon-apigateway-any-method": { "isDefaultRoute": true, "x-amazon-apigateway-integration": { "type": "AWS_PROXY", "httpMethod": "POST", "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789012:function:HelloWorld/invocations", "timeoutInMillis": 1000, "connectionType": "INTERNET", "payloadFormatVersion": 1.0 } } }