The AWS::ApiGateway::RestApi
resource creates a REST API. For more information, see restapi:create in the Amazon API Gateway REST API Reference.
On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.
api_key_source_type
(String) The source of the API key for metering requests according to a usage plan. Valid values are: HEADER
to read the API key from the X-API-Key
header of a request. AUTHORIZER
to read the API key from the UsageIdentifierKey
from a custom authorizer.binary_media_types
(List of String) The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.body
(String) An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.body_s3_location
(Attributes) The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. (see below for nested schema)clone_from
(String) The ID of the RestApi that you want to clone from.description
(String) The description of the RestApi.disable_execute_api_endpoint
(Boolean) Specifies whether clients can invoke your API by using the default execute-api
endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpointendpoint_configuration
(Attributes) A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parameters
property. (see below for nested schema)fail_on_warnings
(Boolean) A query parameter to indicate whether to rollback the API update (true
) or not (false
) when a warning is encountered. The default value is false
.minimum_compression_size
(Number) A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.mode
(String) This property applies only when you use OpenAPI to define your REST API. The Mode
determines how API Gateway handles resource updates.
Valid values are overwrite
or merge
.
For overwrite
, the new API definition replaces the existing one. The existing API identifier remains unchanged.
For merge
, the new API definition is merged with the existing API.
If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is overwrite
. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.
Use the default mode to define top-level RestApi
properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.name
(String) The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.parameters
(String) Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation
as a parameters
value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
.policy
(String) A policy document that contains the permissions for the RestApi
resource. To set the ARN for the policy, use the !Join
intrinsic function with ""
as delimiter and values of "execute-api:/"
and "*"
.tags
(Attributes List) The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:
. The tag value can be up to 256 characters. (see below for nested schema)id
(String) Uniquely identifies the resource.rest_api_id
(String)root_resource_id
(String)body_s3_location
Optional:
bucket
(String) The name of the S3 bucket where the OpenAPI file is stored.e_tag
(String) The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.key
(String) The file name of the OpenAPI file (Amazon S3 object name).version
(String) For versioning-enabled buckets, a specific version of the OpenAPI file.endpoint_configuration
Optional:
types
(List of String) A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE"
. For a regional API and its custom domain name, the endpoint type is REGIONAL
. For a private API, the endpoint type is PRIVATE
.vpc_endpoint_ids
(List of String) A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE
endpoint type.tags
Required:
key
(String)value
(String)Import is supported using the following syntax:
$ terraform import awscc_apigateway_rest_api.example <resource ID>