interface HttpApiAttributes
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Apigatewayv2.HttpApiAttributes |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#HttpApiAttributes |
Java | software.amazon.awscdk.services.apigatewayv2.HttpApiAttributes |
Python | aws_cdk.aws_apigatewayv2.HttpApiAttributes |
TypeScript (source) | aws-cdk-lib » aws_apigatewayv2 » 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 { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const httpApiAttributes: apigatewayv2.HttpApiAttributes = {
httpApiId: 'httpApiId',
// the properties below are optional
apiEndpoint: 'apiEndpoint',
};
Properties
Name | Type | Description |
---|---|---|
http | string | The identifier of the HttpApi. |
api | string | The 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.