HttpApiAttributes

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

Bases: object

(experimental) Attributes for importing an HttpApi into the CDK.

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

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

Stability

experimental

ExampleMetadata

fixture=_generated

Example:

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

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

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

Attributes

api_endpoint

(experimental) The endpoint URL of the HttpApi.

Default
  • throws an error if apiEndpoint is accessed.

Stability

experimental

Return type

Optional[str]

http_api_id

(experimental) The identifier of the HttpApi.

Stability

experimental

Return type

str