Skip to content

RosHttpApiProps

Properties for defining a RosHttpApi.

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

Initializer 

import { RosHttpApiProps } from '@alicloud/ros-cdk-apig'
const rosHttpApiProps: RosHttpApiProps = { ... }

Properties

Name Type Description
httpApiName string | @alicloud/ros-cdk-core.IResolvable No description.
agentProtocols @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] No description.
aiProtocols @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] No description.
authConfig @alicloud/ros-cdk-core.IResolvable | AuthConfigProperty No description.
basePath string | @alicloud/ros-cdk-core.IResolvable No description.
belongGatewayId string | @alicloud/ros-cdk-core.IResolvable No description.
builtinRouteNames @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] No description.
deployConfigs @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DeployConfigsProperty[] No description.
description string | @alicloud/ros-cdk-core.IResolvable No description.
enableAuth boolean | @alicloud/ros-cdk-core.IResolvable No description.
firstByteTimeout number | @alicloud/ros-cdk-core.IResolvable No description.
ingressConfig @alicloud/ros-cdk-core.IResolvable | IngressConfigProperty No description.
modelCategory string | @alicloud/ros-cdk-core.IResolvable No description.
onlyChangeConfig boolean | @alicloud/ros-cdk-core.IResolvable No description.
protocols @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] No description.
removeBasePathOnForward boolean | @alicloud/ros-cdk-core.IResolvable No description.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable No description.
strategy string | @alicloud/ros-cdk-core.IResolvable No description.
type string | @alicloud/ros-cdk-core.IResolvable No description.
versionConfig @alicloud/ros-cdk-core.IResolvable | VersionConfigProperty No description.

httpApiNameRequired 

public readonly httpApiName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

agentProtocolsOptional 

public readonly agentProtocols: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

aiProtocolsOptional 

public readonly aiProtocols: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

authConfigOptional 

public readonly authConfig: IResolvable | AuthConfigProperty;

basePathOptional 

public readonly basePath: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

belongGatewayIdOptional 

public readonly belongGatewayId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

builtinRouteNamesOptional 

public readonly builtinRouteNames: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

deployConfigsOptional 

public readonly deployConfigs: IResolvable | IResolvable | DeployConfigsProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DeployConfigsProperty[]

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

enableAuthOptional 

public readonly enableAuth: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

firstByteTimeoutOptional 

public readonly firstByteTimeout: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

ingressConfigOptional 

public readonly ingressConfig: IResolvable | IngressConfigProperty;

modelCategoryOptional 

public readonly modelCategory: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

onlyChangeConfigOptional 

public readonly onlyChangeConfig: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

protocolsOptional 

public readonly protocols: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

removeBasePathOnForwardOptional 

public readonly removeBasePathOnForward: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

strategyOptional 

public readonly strategy: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

typeOptional 

public readonly type: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

versionConfigOptional 

public readonly versionConfig: IResolvable | VersionConfigProperty;