Skip to content

HttpApiProps

Properties for defining a HttpApi.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-httpapi

Initializer 

import ros_cdk_apig
ros_cdk_apig.HttpApiProps(
  http_api_name: typing.Union[str, IResolvable],
  protocols: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  base_path: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  type: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
http_api_name typing.Union[str, ros_cdk_core.IResolvable] Property httpApiName: The name of the API.
protocols typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property protocols: List of API Access Protocols.
base_path typing.Union[str, ros_cdk_core.IResolvable] Property basePath: The base path of the API should start with a \/.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: Description of API.
type typing.Union[str, ros_cdk_core.IResolvable] Property type: The type of HTTP API, Valid values: * Http * Rest * WebSocket * HttpIngress.

http_api_nameRequired 

http_api_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property httpApiName: The name of the API.

protocolsRequired 

protocols: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property protocols: List of API Access Protocols.

base_pathOptional 

base_path: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property basePath: The base path of the API should start with a \/.

descriptionOptional 

description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: Description of API.

typeOptional 

type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property type: The type of HTTP API, Valid values: * Http * Rest * WebSocket * HttpIngress.