AwsApiGatewayV2ApiDetails

import type { AwsApiGatewayV2ApiDetails } from "https://aws-api.deno.dev/v0.4/services/securityhub.ts?docs=full";

Contains information about a version 2 API in Amazon API Gateway.

interface AwsApiGatewayV2ApiDetails {

ApiEndpoint?: string | null;

ApiId?: string | null;

ApiKeySelectionExpression?: string | null;

CorsConfiguration?: AwsCorsConfiguration | null;

CreatedDate?: string | null;

Description?: string | null;

Name?: string | null;

ProtocolType?: string | null;

RouteSelectionExpression?: string | null;

Version?: string | null;

}

§Properties

ApiEndpoint?: string | null

[src]

The URI of the API.

Uses the format _<api-id>_.execute-api._<region>_.amazonaws.com

The stage name is typically appended to the URI to form a complete path to a deployed API stage.

ApiId?: string | null

[src]

The identifier of the API.

ApiKeySelectionExpression?: string | null

[src]

An API key selection expression. Supported only for WebSocket APIs.

CorsConfiguration?: AwsCorsConfiguration | null

[src]

A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.

CreatedDate?: string | null

[src]

Indicates when the API was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.

Description?: string | null

[src]

A description of the API.

Name?: string | null

[src]

The name of the API.

ProtocolType?: string | null

[src]

The API protocol for the API.

Valid values: WEBSOCKET | HTTP

RouteSelectionExpression?: string | null

[src]

The route selection expression for the API.

For HTTP APIs, must be ${request.method} ${request.path}. This is the default value for HTTP APIs.

For WebSocket APIs, there is no default value.

Version?: string | null

[src]

The version identifier for the API.