Optional 43

• api_key_selection_expressionstring, default nullAn 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
• api_mapping_keystring, default nullThe [API mapping key](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-mapping-template-reference.html)
• api_versionstring, default nullA version identifier for the API. Must be between 1 and 64 characters in length
• authorizersmap({...}), default {}Map of API gateway authorizers to create
• bodystring, default nullAn OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs
• cors_configurationobject({...}), default nullThe cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs
• createbool, default trueControls if resources should be created
• create_certificatebool, default trueWhether 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
• create_domain_namebool, default trueWhether to create API domain name resource
• create_domain_recordsbool, default trueWhether to create Route53 records for the domain name
• create_routes_and_integrationsbool, default trueWhether to create routes and integrations resources
• create_stagebool, default trueWhether to create default stage
• credentials_arnstring, default nullPart of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs
• deploy_stagebool, default trueWhether to deploy the stage. HTTP APIs are auto-deployed by default
• descriptionstring, default nullThe description of the API. Must be less than or equal to 1024 characters in length
• disable_execute_api_endpointbool, default nullWhether 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
• domain_namestring, default ""The domain name to use for API gateway
• domain_name_certificate_arnstring, default nullThe 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
• domain_name_ownership_verification_certificate_arnstring, default nullARN 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.)
• fail_on_warningsbool, default nullWhether 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
• hosted_zone_namestring, default nullOptional domain name of the Hosted Zone where the domain should be created
• ip_address_typestring, default nullThe 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.
• mutual_tls_authenticationmap(string), default {}The mutual TLS authentication configuration for the domain name
• namestring, default ""The name of the API. Must be less than or equal to 128 characters in length
• private_zonebool, default falseIndicates the hosted zone being looked up is private. Certificate validation will fail if this is set to true.
• protocol_typestring, default "HTTP"The API protocol. Valid values: HTTP, WEBSOCKET
• regionstring, default nullRegion where the resource(s) will be managed. Defaults to the Region set in the provider configuration
• route_keystring, default nullPart of quick create. Specifies any route key. Applicable for HTTP APIs
• route_selection_expressionstring, default nullThe route selection expression for the API. Defaults to $request.method $request.path
• routesmap({...}), default {}Map of API gateway routes with integrations
• stage_access_log_settingsobject({...}), default {}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)
• stage_client_certificate_idstring, default nullThe 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
• stage_default_route_settingsobject({...}), default {}The default route settings for the stage
• stage_descriptionstring, default nullThe description for the stage. Must be less than or equal to 1024 characters in length
• stage_namestring, default "$default"The name of the stage. Must be between 1 and 128 characters in length
• stage_tagsmap(string), default {}A mapping of tags to assign to the stage resource
• stage_variablesmap(string), default {}A map that defines the stage variables for the stage
• subdomain_record_typeslist(string), default ["A","AAAA"]A list of record types to create for the subdomain(s)
• subdomainslist(string), default []An optional list of subdomains to use for API gateway
• tagsmap(string), default {}A mapping of tags to assign to API gateway resources
• targetstring, default nullPart of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Applicable for HTTP APIs
• vpc_link_tagsmap(string), default {}A map of tags to add to the VPC Links created
• vpc_linksmap({...}), default {}Map of VPC Link definitions to create