@aws-cdk_aws-apigatewayv2-alpha.HttpApiAttributes
interface HttpApiAttributes
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Apigatewayv2.Alpha.HttpApiAttributes |
![]() | github.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#HttpApiAttributes |
![]() | software.amazon.awscdk.services.apigatewayv2.alpha.HttpApiAttributes |
![]() | aws_cdk.aws_apigatewayv2_alpha.HttpApiAttributes |
![]() | @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
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.