apis

Creates, updates, deletes or gets an api resource or lists apis in a region

Overview

Name	apis
Type	Resource
Description	The AWS::ApiGatewayV2::Api resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway Developer Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer Guide.*
Id	aws.apigatewayv2.apis

Fields

Name	Datatype	Description
route_selection_expression	string	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.
body_s3_location	object	The S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location. If you specify a Body or BodyS3Location, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
description	string	The description of the API.
api_endpoint	string
base_path	string	Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs.
fail_on_warnings	boolean	Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
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 endpoint.
disable_schema_validation	boolean	Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
name	string	The name of the API. Required unless you specify an OpenAPI definition for Body or S3BodyLocation.
target	string	This property is part 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. Supported only for HTTP APIs.
credentials_arn	string	This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
cors_configuration	object	A CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.
version	string	A version identifier for the API.
protocol_type	string	The API protocol. Valid values are WEBSOCKET or HTTP. Required unless you specify an OpenAPI definition for Body or S3BodyLocation.
route_key	string	This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
api_id	string
body	object	The OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location. If you specify a Body or BodyS3Location, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
tags	object	The collection of tags. Each tag element is associated with a given resource.
api_key_selection_expression	string	An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all apis in a region.

SELECT
region,
route_selection_expression,
body_s3_location,
description,
api_endpoint,
base_path,
fail_on_warnings,
disable_execute_api_endpoint,
disable_schema_validation,
name,
target,
credentials_arn,
cors_configuration,
version,
protocol_type,
route_key,
api_id,
body,
tags,
api_key_selection_expression
FROM aws.apigatewayv2.apis
WHERE region = 'us-east-1';

Gets all properties from an individual api.

SELECT
region,
route_selection_expression,
body_s3_location,
description,
api_endpoint,
base_path,
fail_on_warnings,
disable_execute_api_endpoint,
disable_schema_validation,
name,
target,
credentials_arn,
cors_configuration,
version,
protocol_type,
route_key,
api_id,
body,
tags,
api_key_selection_expression
FROM aws.apigatewayv2.apis
WHERE region = 'us-east-1' AND data__Identifier = '<ApiId>';

INSERT example

Use the following StackQL query and manifest file to create a new api resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.apigatewayv2.apis (
 RouteSelectionExpression,
 BodyS3Location,
 Description,
 BasePath,
 FailOnWarnings,
 DisableExecuteApiEndpoint,
 DisableSchemaValidation,
 Name,
 Target,
 CredentialsArn,
 CorsConfiguration,
 Version,
 ProtocolType,
 RouteKey,
 Body,
 Tags,
 ApiKeySelectionExpression,
 region
)
SELECT 
'{{ RouteSelectionExpression }}',
 '{{ BodyS3Location }}',
 '{{ Description }}',
 '{{ BasePath }}',
 '{{ FailOnWarnings }}',
 '{{ DisableExecuteApiEndpoint }}',
 '{{ DisableSchemaValidation }}',
 '{{ Name }}',
 '{{ Target }}',
 '{{ CredentialsArn }}',
 '{{ CorsConfiguration }}',
 '{{ Version }}',
 '{{ ProtocolType }}',
 '{{ RouteKey }}',
 '{{ Body }}',
 '{{ Tags }}',
 '{{ ApiKeySelectionExpression }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.apigatewayv2.apis (
 RouteSelectionExpression,
 BodyS3Location,
 Description,
 BasePath,
 FailOnWarnings,
 DisableExecuteApiEndpoint,
 DisableSchemaValidation,
 Name,
 Target,
 CredentialsArn,
 CorsConfiguration,
 Version,
 ProtocolType,
 RouteKey,
 Body,
 Tags,
 ApiKeySelectionExpression,
 region
)
SELECT 
 '{{ RouteSelectionExpression }}',
 '{{ BodyS3Location }}',
 '{{ Description }}',
 '{{ BasePath }}',
 '{{ FailOnWarnings }}',
 '{{ DisableExecuteApiEndpoint }}',
 '{{ DisableSchemaValidation }}',
 '{{ Name }}',
 '{{ Target }}',
 '{{ CredentialsArn }}',
 '{{ CorsConfiguration }}',
 '{{ Version }}',
 '{{ ProtocolType }}',
 '{{ RouteKey }}',
 '{{ Body }}',
 '{{ Tags }}',
 '{{ ApiKeySelectionExpression }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: api
    props:
      - name: RouteSelectionExpression
        value: '{{ RouteSelectionExpression }}'
      - name: BodyS3Location
        value:
          Etag: '{{ Etag }}'
          Bucket: '{{ Bucket }}'
          Version: '{{ Version }}'
          Key: '{{ Key }}'
      - name: Description
        value: '{{ Description }}'
      - name: BasePath
        value: '{{ BasePath }}'
      - name: FailOnWarnings
        value: '{{ FailOnWarnings }}'
      - name: DisableExecuteApiEndpoint
        value: '{{ DisableExecuteApiEndpoint }}'
      - name: DisableSchemaValidation
        value: '{{ DisableSchemaValidation }}'
      - name: Name
        value: '{{ Name }}'
      - name: Target
        value: '{{ Target }}'
      - name: CredentialsArn
        value: '{{ CredentialsArn }}'
      - name: CorsConfiguration
        value:
          AllowOrigins:
            - '{{ AllowOrigins[0] }}'
          AllowCredentials: '{{ AllowCredentials }}'
          ExposeHeaders:
            - '{{ ExposeHeaders[0] }}'
          AllowHeaders:
            - '{{ AllowHeaders[0] }}'
          MaxAge: '{{ MaxAge }}'
          AllowMethods:
            - '{{ AllowMethods[0] }}'
      - name: Version
        value: '{{ Version }}'
      - name: ProtocolType
        value: '{{ ProtocolType }}'
      - name: RouteKey
        value: '{{ RouteKey }}'
      - name: Body
        value: {}
      - name: Tags
        value: {}
      - name: ApiKeySelectionExpression
        value: '{{ ApiKeySelectionExpression }}'

DELETE example

/*+ delete */
DELETE FROM aws.apigatewayv2.apis
WHERE data__Identifier = '<ApiId>'
AND region = 'us-east-1';

Permissions

To operate on the apis resource, the following permissions are required:

Create

apigateway:POST,
apigateway:PUT,
s3:getObject

Update

apigateway:PATCH,
apigateway:GET,
apigateway:PUT,
apigateway:POST,
s3:getObject

Read

apigateway:GET,
s3:getObject

Delete

apigateway:GET,
apigateway:DELETE,
s3:getObject

List

apigateway:GET,
s3:getObject