@aws-cdk_aws-apigatewayv2-alpha.HttpApiAttributes

interface HttpApiAttributes ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.HttpApiAttributes
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#HttpApiAttributes
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.HttpApiAttributes
Pythonaws_cdk.aws_apigatewayv2_alpha.HttpApiAttributes
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป HttpApiAttributes

Attributes for importing an HttpApi into the CDK.

Example

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

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

Properties

NameTypeDescription
httpApiId๐Ÿ”นstringThe identifier of the HttpApi.
apiEndpoint?๐Ÿ”นstringThe endpoint URL of the HttpApi.

httpApiId๐Ÿ”น

Type: string

The identifier of the HttpApi.


apiEndpoint?๐Ÿ”น

Type: string (optional, default: throws an error if apiEndpoint is accessed.)

The endpoint URL of the HttpApi.