aws-cdk-lib.aws_apigatewayv2.HttpApiAttributes

HttpApiAttributes Struct

Attributes for importing an HttpApi into the CDK.

Source

aws-apigatewayv2/lib/http/api.ts

Type last changed

v2.112.0 · 1 Dec 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const httpApiAttributes: apigatewayv2.HttpApiAttributes = {
  httpApiId: 'httpApiId',

  // the properties below are optional
  apiEndpoint: 'apiEndpoint',
};

Properties

apiEndpointstringapi_endpointstrapiEndpointStringApiEndpointstringApiEndpoint*string= throws an error if apiEndpoint i…#

The endpoint URL of the HttpApi.

default

Default: throws an error if apiEndpoint is accessed.

httpApiIdstringhttp_api_idstrhttpApiIdStringHttpApiIdstringHttpApiId*stringrequired#

The identifier of the HttpApi.