aws_apigatewayv2_api

account_id

Type: STRING

api_arn

Type: STRING

api_endpoint

Type: STRING
Provider name: ApiEndpoint
Description: The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

api_gateway_managed

Type: BOOLEAN
Provider name: ApiGatewayManaged
Description: Specifies whether an API is managed by API Gateway. You can’t update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

api_id

Type: STRING
Provider name: ApiId
Description: The API ID.

api_key_selection_expression

Type: STRING
Provider name: ApiKeySelectionExpression
Description: An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

cors_configuration

Type: STRUCT
Provider name: CorsConfiguration
Description: A CORS configuration. Supported only for HTTP APIs.

• allow_credentials
  Type: BOOLEAN
  Provider name: AllowCredentials
  Description: Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
  
• allow_headers
  Type: UNORDERED_LIST_STRING
  Provider name: AllowHeaders
  Description: Represents a collection of allowed headers. Supported only for HTTP APIs.
  
• allow_methods
  Type: UNORDERED_LIST_STRING
  Provider name: AllowMethods
  Description: Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
  
• allow_origins
  Type: UNORDERED_LIST_STRING
  Provider name: AllowOrigins
  Description: Represents a collection of allowed origins. Supported only for HTTP APIs.
  
• expose_headers
  Type: UNORDERED_LIST_STRING
  Provider name: ExposeHeaders
  Description: Represents a collection of exposed headers. Supported only for HTTP APIs.
  
• max_age
  Type: INT32
  Provider name: MaxAge
  Description: The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
  

created_date

Type: TIMESTAMP
Provider name: CreatedDate
Description: The timestamp when the API was created.

description

Type: STRING
Provider name: Description
Description: The description of the API.

disable_execute_api_endpoint

Type: BOOLEAN
Provider name: DisableExecuteApiEndpoint
Description: 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 endpoint.

disable_schema_validation

Type: BOOLEAN
Provider name: DisableSchemaValidation
Description: Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

import_info

Type: UNORDERED_LIST_STRING
Provider name: ImportInfo
Description: The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

name

Type: STRING
Provider name: Name
Description: The name of the API.

protocol_type

Type: STRING
Provider name: ProtocolType
Description: The API protocol.

route_selection_expression

Type: STRING
Provider name: RouteSelectionExpression
Description: The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

tags

Type: UNORDERED_LIST_STRING

version

Type: STRING
Provider name: Version
Description: A version identifier for the API.

warnings

Type: UNORDERED_LIST_STRING
Provider name: Warnings
Description: The warning messages reported when failonwarnings is turned on during API import.