API Gateway

An API key selection expression. Valid values: `$context.authorizer.usageIdentifierKey`, `$request.header.x-api-key`. Defaults to `$request.header.x-api-key`. Applicable for WebSocket APIs

The [API mapping key](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-mapping-template-reference.html)

A version identifier for the API. Must be between 1 and 64 characters in length

Map of API gateway authorizers to create

An OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs

The cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs

Controls if resources should be created

Whether to create a certificate for the domain. Since certificate validate only works on public domains, this will be ignore if `private_zone` is set to `true`

Whether to create API domain name resource

Whether to create Route53 records for the domain name

Whether to create routes and integrations resources

Whether to create default stage

Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs

Whether to deploy the stage. `HTTP` APIs are auto-deployed by default

The description of the API. Must be less than or equal to 1024 characters in length

Whether clients can invoke the API by using the default execute-api endpoint. By default, clients can invoke the API with the default `{api_id}.execute-api.{region}.amazonaws.com endpoint`. To require that clients use a custom domain name to invoke the API, disable the default endpoint

The domain name to use for API gateway

The ARN of an AWS-managed certificate that will be used by the endpoint for the domain name. AWS Certificate Manager is the only supported source

ARN of the AWS-issued certificate used to validate custom domain ownership (when certificate_arn is issued via an ACM Private CA or mutual_tls_authentication is configured with an ACM-imported certificate.)

Whether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults to `false`. Applicable for HTTP APIs

Optional domain name of the Hosted Zone where the domain should be created

The IP address types that can invoke the API. Valid values: ipv4, dualstack. Use ipv4 to allow only IPv4 addresses to invoke your API, or use dualstack to allow both IPv4 and IPv6 addresses to invoke your API. Defaults to ipv4.

The mutual TLS authentication configuration for the domain name

The name of the API. Must be less than or equal to 128 characters in length

Indicates the hosted zone being looked up is private. Certificate validation will fail if this is set to true.

The API protocol. Valid values: `HTTP`, `WEBSOCKET`

Region where the resource(s) will be managed. Defaults to the Region set in the provider configuration

Part of quick create. Specifies any route key. Applicable for HTTP APIs

The route selection expression for the API. Defaults to `$request.method $request.path`

Map of API gateway routes with integrations

Settings for logging access in this stage. Use the aws_api_gateway_account resource to configure [permissions for CloudWatch Logging](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html#set-up-access-logging-permissions)

The identifier of a client certificate for the stage. Use the `aws_api_gateway_client_certificate` resource to configure a client certificate. Supported only for WebSocket APIs

The default route settings for the stage

The description for the stage. Must be less than or equal to 1024 characters in length

The name of the stage. Must be between 1 and 128 characters in length

A mapping of tags to assign to the stage resource

A map that defines the stage variables for the stage

A list of record types to create for the subdomain(s)

An optional list of subdomains to use for API gateway

A mapping of tags to assign to API gateway resources

The ARN of the certificate

The ARN of the API

URI of the API, of the form `https://{api-id}.execute-api.{region}.amazonaws.com` for HTTP APIs and `wss://{api-id}.execute-api.{region}.amazonaws.com` for WebSocket APIs

The ARN prefix to be used in an `aws_lambda_permission`'s `source_arn` attribute or in an `aws_iam_policy` to authorize access to the `@connections` API

The API identifier

Map of API Gateway Authorizer(s) created and their attributes

The API mapping selection expression for the domain name

The ARN of the domain name

The domain name configuration

The Amazon Route 53 Hosted Zone ID of the endpoint

The domain name identifier

The target domain name

Map of the integrations created and their attributes

Map of the routes created and their attributes

Arn of cloudwatch log group created

Name of cloudwatch log group created

The stage ARN

Domain name of the stage (useful for CloudFront distribution)

The ARN prefix to be used in an aws_lambda_permission's source_arn attribute or in an aws_iam_policy to authorize access to the @connections API

The stage identifier

The URL to invoke the API pointing to the stage

Map of VPC links created and their attributes