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

http_api_name^Required

http_api_name: typing.Union[str, IResolvable]

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

Property httpApiName: The name of the HTTP API.

agent_protocols^Optional

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

Property agentProtocols: The agent protocols of the HTTP API.

ai_protocols^Optional

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

Property aiProtocols: The AI protocols of the HTTP API.

auth_config^Optional

auth_config: typing.Union[IResolvable, AuthConfigProperty]

• Type: typing.Union[ros_cdk_core.IResolvable, AuthConfigProperty]

Property authConfig: The authentication configuration.

base_path^Optional

base_path: typing.Union[str, IResolvable]

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

Property basePath: The base path of the HTTP API.

belong_gateway_id^Optional

belong_gateway_id: typing.Union[str, IResolvable]

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

Property belongGatewayId: The gateway ID that the HTTP API belongs to.

builtin_route_names^Optional

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

Property builtinRouteNames: The builtin route names.

deploy_configs^Optional

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

Property deployConfigs: The deploy configurations of the HTTP API.

description^Optional

description: typing.Union[str, IResolvable]

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

Property description: The description of the HTTP API.

enable_auth^Optional

enable_auth: typing.Union[bool, IResolvable]

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

Property enableAuth: Whether to enable authentication.

first_byte_timeout^Optional

first_byte_timeout: typing.Union[typing.Union[int, float], IResolvable]

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

Property firstByteTimeout: The first byte timeout.

ingress_config^Optional

ingress_config: typing.Union[IResolvable, IngressConfigProperty]

• Type: typing.Union[ros_cdk_core.IResolvable, IngressConfigProperty]

Property ingressConfig: The ingress configuration of the HTTP API.

model_category^Optional

model_category: typing.Union[str, IResolvable]

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

Property modelCategory: The model category.

only_change_config^Optional

only_change_config: typing.Union[bool, IResolvable]

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

Property onlyChangeConfig: Whether to only change config without triggering redeployment.

True means only modify configuration without triggering redeployment.

protocols^Optional

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: The protocols supported by the HTTP API.

remove_base_path_on_forward^Optional

remove_base_path_on_forward: typing.Union[bool, IResolvable]

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

Property removeBasePathOnForward: Whether to remove the base path on forward.

resource_group_id^Optional

resource_group_id: typing.Union[str, IResolvable]

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

Property resourceGroupId: The ID of the resource group.

strategy^Optional

strategy: typing.Union[str, IResolvable]

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

Property strategy: The strategy of the HTTP API.

type^Optional

type: typing.Union[str, IResolvable]

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

Property type: The type of the HTTP API.

version_config^Optional

version_config: typing.Union[IResolvable, VersionConfigProperty]

• Type: typing.Union[ros_cdk_core.IResolvable, VersionConfigProperty]

Property versionConfig: The version configuration of the HTTP API.