HttpApiAttributes

class aws_cdk.aws_apigatewayv2.HttpApiAttributes(*, http_api_id, api_endpoint=None)

Bases: object

Attributes for importing an HttpApi into the CDK.

Parameters:

  • http_api_id (str) – The identifier of the HttpApi.

  • api_endpoint (Optional[str]) – The endpoint URL of the HttpApi. Default: - throws an error if apiEndpoint is accessed.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2

http_api_attributes = apigatewayv2.HttpApiAttributes(
    http_api_id="httpApiId",

    # the properties below are optional
    api_endpoint="apiEndpoint"
)

Attributes

api_endpoint

The endpoint URL of the HttpApi.

Default:

  • throws an error if apiEndpoint is accessed.

http_api_id

The identifier of the HttpApi.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#aws-resource-apigatewayv2-api-return-values