AWS API Gateway Gateway Response

This page shows how to write Terraform and CloudFormation for API Gateway Gateway Response and write them securely.

aws_api_gateway_gateway_response (Terraform)

The Gateway Response in API Gateway can be configured in Terraform with the resource name aws_api_gateway_gateway_response. The following sections describe 3 examples of how to use the resource and its parameters.

Example Usage from GitHub

github-iconvistaprint/TerraformModules
resource "aws_api_gateway_gateway_response" "response_4xx" {
  rest_api_id   = var.api
  status_code   = "500"
  response_type = "DEFAULT_4XX"
  response_templates = {
    "application/json" = "{\"message\":$context.error.messageString}"
github-iconRyxias/go-chuuni
resource "aws_api_gateway_gateway_response" "unauthorized" {
  rest_api_id   = aws_api_gateway_rest_api.default.id
  response_type = "UNAUTHORIZED"
  status_code   = "401"

  response_templates = {
github-iconairbnb/rudolph
resource "aws_api_gateway_gateway_response" "unauthorized" {
  rest_api_id   = aws_api_gateway_rest_api.api_gateway.id
  response_type = "UNAUTHORIZED"
  status_code   = "401"

  response_templates = {

Parameters

Explanation in Terraform Registry

Provides an API Gateway Gateway Response for a REST API Gateway.

AWS::ApiGateway::GatewayResponse (CloudFormation)

The GatewayResponse in ApiGateway can be configured in CloudFormation with the resource name AWS::ApiGateway::GatewayResponse. The following sections describe how to use the resource and its parameters.

Parameters

Explanation in CloudFormation Registry

The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API. For more information, see API Gateway Responses in the API Gateway Developer Guide.

Frequently asked questions

What is AWS API Gateway Gateway Response?

AWS API Gateway Gateway Response is a resource for API Gateway of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.

Where can I find the example code for the AWS API Gateway Gateway Response?

For Terraform, the vistaprint/TerraformModules, Ryxias/go-chuuni and airbnb/rudolph source code examples are useful. See the Terraform Example section for further details.