» Resource: aws_api_gateway_rest_api

Provides an API Gateway REST API.

» Example Usage

» Basic 

resource "aws_api_gateway_rest_api" "MyDemoAPI" {
  name        = "MyDemoAPI"
  description = "This is my API for demonstration purposes"
}

» Regional Endpoint Type 

resource "aws_api_gateway_rest_api" "example" {
  name = "regional-example"

  endpoint_configuration {
    types = ["REGIONAL"]
  }
}

» Argument Reference

The following arguments are supported:

  • name - (Required) The name of the REST API
  • description - (Optional) The description of the REST API
  • endpoint_configuration - (Optional) Nested argument defining API endpoint configuration including endpoint type. Defined below.
  • binary_media_types - (Optional) The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
  • minimum_compression_size - (Optional) Minimum response size to compress for the REST API. Integer between -1 and 10485760 (10MB). Setting a value greater than -1 will enable compression, -1 disables compression (default).
  • body - (Optional) An OpenAPI specification that defines the set of routes and integrations to create as part of the REST API.
  • policy - (Optional) JSON formatted policy document that controls access to the API Gateway. For more information about building AWS IAM policy documents with Terraform, see the AWS IAM Policy Document Guide
  • api_key_source - (Optional) The source of the API key for requests. Valid values are HEADER (default) and AUTHORIZER.

Note: If the body argument is provided, the OpenAPI specification will be used to configure the resources, methods and integrations for the Rest API. If this argument is provided, the following resources should not be managed as separate ones, as updates may cause manual resource updates to be overwritten:

» endpoint_configuration

  • types - (Required) A list of endpoint types. This resource currently only supports managing a single value. Valid values: EDGE, REGIONAL or PRIVATE. If unspecified, defaults to EDGE. Must be declared as REGIONAL in non-Commercial partitions. Refer to the documentation for more information on the difference between edge-optimized and regional APIs.

» Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - The ID of the REST API
  • root_resource_id - The resource ID of the REST API's root
  • created_date - The creation date of the REST API
  • execution_arn - The execution ARN part to be used in lambda_permission's source_arn when allowing API Gateway to invoke a Lambda function, e.g. arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j, which can be concatenated with allowed stage, method and resource path.

» Import

aws_api_gateway_rest_api can be imported by using the REST API ID, e.g.

$ terraform import aws_api_gateway_rest_api.example 12345abcde