Skip to content

RosHttpApiProps

Properties for defining a RosHttpApi.

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

Initializer 

import ros_cdk_apig
ros_cdk_apig.RosHttpApiProps(
  http_api_name: typing.Union[str, IResolvable],
  agent_protocols: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  ai_protocols: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  auth_config: typing.Union[IResolvable, AuthConfigProperty] = None,
  base_path: typing.Union[str, IResolvable] = None,
  belong_gateway_id: typing.Union[str, IResolvable] = None,
  builtin_route_names: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  deploy_configs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DeployConfigsProperty]]] = None,
  description: typing.Union[str, IResolvable] = None,
  enable_auth: typing.Union[bool, IResolvable] = None,
  first_byte_timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  ingress_config: typing.Union[IResolvable, IngressConfigProperty] = None,
  model_category: typing.Union[str, IResolvable] = None,
  only_change_config: typing.Union[bool, IResolvable] = None,
  protocols: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  remove_base_path_on_forward: typing.Union[bool, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  strategy: typing.Union[str, IResolvable] = None,
  type: typing.Union[str, IResolvable] = None,
  version_config: typing.Union[IResolvable, VersionConfigProperty] = None
)

Properties

Name Type Description
http_api_name typing.Union[str, ros_cdk_core.IResolvable] No description.
agent_protocols typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] No description.
ai_protocols typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] No description.
auth_config typing.Union[ros_cdk_core.IResolvable, AuthConfigProperty] No description.
base_path typing.Union[str, ros_cdk_core.IResolvable] No description.
belong_gateway_id typing.Union[str, ros_cdk_core.IResolvable] No description.
builtin_route_names typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] No description.
deploy_configs typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DeployConfigsProperty]]] No description.
description typing.Union[str, ros_cdk_core.IResolvable] No description.
enable_auth typing.Union[bool, ros_cdk_core.IResolvable] No description.
first_byte_timeout typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
ingress_config typing.Union[ros_cdk_core.IResolvable, IngressConfigProperty] No description.
model_category typing.Union[str, ros_cdk_core.IResolvable] No description.
only_change_config typing.Union[bool, ros_cdk_core.IResolvable] No description.
protocols typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] No description.
remove_base_path_on_forward typing.Union[bool, ros_cdk_core.IResolvable] No description.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] No description.
strategy typing.Union[str, ros_cdk_core.IResolvable] No description.
type typing.Union[str, ros_cdk_core.IResolvable] No description.
version_config typing.Union[ros_cdk_core.IResolvable, VersionConfigProperty] No description.

http_api_nameRequired 

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

agent_protocolsOptional 

agent_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]]]

ai_protocolsOptional 

ai_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]]]

auth_configOptional 

auth_config: typing.Union[IResolvable, AuthConfigProperty]

base_pathOptional 

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

belong_gateway_idOptional 

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

builtin_route_namesOptional 

builtin_route_names: 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]]]

deploy_configsOptional 

deploy_configs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DeployConfigsProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DeployConfigsProperty]]]

descriptionOptional 

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

enable_authOptional 

enable_auth: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

first_byte_timeoutOptional 

first_byte_timeout: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

ingress_configOptional 

ingress_config: typing.Union[IResolvable, IngressConfigProperty]

model_categoryOptional 

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

only_change_configOptional 

only_change_config: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

protocolsOptional 

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]]]

remove_base_path_on_forwardOptional 

remove_base_path_on_forward: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

resource_group_idOptional 

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

strategyOptional 

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

typeOptional 

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

version_configOptional 

version_config: typing.Union[IResolvable, VersionConfigProperty]