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 in the API Gateway Developer Guide. For more information about HTTP APIs, see HTTP APIs in the API Gateway Developer Guide.
Id	awscc.apigatewayv2.apis

Fields

get (all properties)

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	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.
▶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.
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. 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 for more information.
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.
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.
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.
api_endpoint	string
description	string	The description of the API.
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.
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.
api_id	string
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.
ip_address_type	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
api_id	string
region	string	AWS region.

For more information, see AWS::ApiGatewayV2::Api.

Methods

Name	Resource	Accessible by	Required Params
create_resource	apis	INSERT	region
delete_resource	apis	DELETE	Identifier, region
update_resource	apis	UPDATE	Identifier, PatchDocument, region
list_resources	apis_list_only	SELECT	region
get_resource	apis	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual api.

SELECT
  region,
  route_selection_expression,
  body,
  body_s3_location,
  base_path,
  credentials_arn,
  cors_configuration,
  route_key,
  target,
  fail_on_warnings,
  api_endpoint,
  description,
  disable_execute_api_endpoint,
  disable_schema_validation,
  name,
  version,
  protocol_type,
  api_id,
  tags,
  api_key_selection_expression,
  ip_address_type
FROM awscc.apigatewayv2.apis
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ api_id }}';

list (identifiers only)

Lists all apis in a region.

SELECT
  region,
  api_id
FROM awscc.apigatewayv2.apis_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.apigatewayv2.apis (
  RouteSelectionExpression,
  Body,
  BodyS3Location,
  BasePath,
  CredentialsArn,
  CorsConfiguration,
  RouteKey,
  Target,
  FailOnWarnings,
  Description,
  DisableExecuteApiEndpoint,
  DisableSchemaValidation,
  Name,
  Version,
  ProtocolType,
  Tags,
  ApiKeySelectionExpression,
  IpAddressType,
  region
)
SELECT
  '{{ route_selection_expression }}',
  '{{ body }}',
  '{{ body_s3_location }}',
  '{{ base_path }}',
  '{{ credentials_arn }}',
  '{{ cors_configuration }}',
  '{{ route_key }}',
  '{{ target }}',
  '{{ fail_on_warnings }}',
  '{{ description }}',
  '{{ disable_execute_api_endpoint }}',
  '{{ disable_schema_validation }}',
  '{{ name }}',
  '{{ version }}',
  '{{ protocol_type }}',
  '{{ tags }}',
  '{{ api_key_selection_expression }}',
  '{{ ip_address_type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apigatewayv2.apis (
  RouteSelectionExpression,
  Body,
  BodyS3Location,
  BasePath,
  CredentialsArn,
  CorsConfiguration,
  RouteKey,
  Target,
  FailOnWarnings,
  Description,
  DisableExecuteApiEndpoint,
  DisableSchemaValidation,
  Name,
  Version,
  ProtocolType,
  Tags,
  ApiKeySelectionExpression,
  IpAddressType,
  region
)
SELECT
  '{{ route_selection_expression }}',
  '{{ body }}',
  '{{ body_s3_location }}',
  '{{ base_path }}',
  '{{ credentials_arn }}',
  '{{ cors_configuration }}',
  '{{ route_key }}',
  '{{ target }}',
  '{{ fail_on_warnings }}',
  '{{ description }}',
  '{{ disable_execute_api_endpoint }}',
  '{{ disable_schema_validation }}',
  '{{ name }}',
  '{{ version }}',
  '{{ protocol_type }}',
  '{{ tags }}',
  '{{ api_key_selection_expression }}',
  '{{ ip_address_type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: api
  props:
    - name: route_selection_expression
      value: '{{ route_selection_expression }}'
    - name: body
      value: {}
    - name: body_s3_location
      value:
        etag: '{{ etag }}'
        bucket: '{{ bucket }}'
        version: '{{ version }}'
        key: '{{ key }}'
    - name: base_path
      value: '{{ base_path }}'
    - name: credentials_arn
      value: '{{ credentials_arn }}'
    - name: cors_configuration
      value:
        allow_origins:
          - '{{ allow_origins[0] }}'
        allow_credentials: '{{ allow_credentials }}'
        expose_headers:
          - '{{ expose_headers[0] }}'
        allow_headers:
          - '{{ allow_headers[0] }}'
        max_age: '{{ max_age }}'
        allow_methods:
          - '{{ allow_methods[0] }}'
    - name: route_key
      value: '{{ route_key }}'
    - name: target
      value: '{{ target }}'
    - name: fail_on_warnings
      value: '{{ fail_on_warnings }}'
    - name: description
      value: '{{ description }}'
    - name: disable_execute_api_endpoint
      value: '{{ disable_execute_api_endpoint }}'
    - name: disable_schema_validation
      value: '{{ disable_schema_validation }}'
    - name: name
      value: '{{ name }}'
    - name: version
      value: '{{ version }}'
    - name: protocol_type
      value: '{{ protocol_type }}'
    - name: tags
      value: {}
    - name: api_key_selection_expression
      value: '{{ api_key_selection_expression }}'
    - name: ip_address_type
      value: '{{ ip_address_type }}'

UPDATE example

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

/*+ update */
UPDATE awscc.apigatewayv2.apis
SET PatchDocument = string('{{ {
    "RouteSelectionExpression": route_selection_expression,
    "Body": body,
    "BodyS3Location": body_s3_location,
    "BasePath": base_path,
    "CredentialsArn": credentials_arn,
    "CorsConfiguration": cors_configuration,
    "RouteKey": route_key,
    "Target": target,
    "FailOnWarnings": fail_on_warnings,
    "Description": description,
    "DisableExecuteApiEndpoint": disable_execute_api_endpoint,
    "DisableSchemaValidation": disable_schema_validation,
    "Name": name,
    "Version": version,
    "Tags": tags,
    "ApiKeySelectionExpression": api_key_selection_expression,
    "IpAddressType": ip_address_type
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ api_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.apigatewayv2.apis
WHERE
  Identifier = '{{ api_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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