HttpApiProps

Properties for defining a HttpApi.

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

Initializer

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

Properties

httpApiName^Required

public readonly httpApiName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property httpApiName: The name of the HTTP API.

agentProtocols^Optional

public readonly agentProtocols: IResolvable | string | IResolvable[];

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

Property agentProtocols: The agent protocols of the HTTP API.

aiProtocols^Optional

public readonly aiProtocols: IResolvable | string | IResolvable[];

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

Property aiProtocols: The AI protocols of the HTTP API.

authConfig^Optional

public readonly authConfig: IResolvable | AuthConfigProperty;

• Type: @alicloud/ros-cdk-core.IResolvable | AuthConfigProperty

Property authConfig: The authentication configuration.

basePath^Optional

public readonly basePath: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property basePath: The base path of the HTTP API.

belongGatewayId^Optional

public readonly belongGatewayId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

builtinRouteNames^Optional

public readonly builtinRouteNames: IResolvable | string | IResolvable[];

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

Property builtinRouteNames: The builtin route names.

deployConfigs^Optional

public readonly deployConfigs: IResolvable | IResolvable | DeployConfigsProperty[];

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

Property deployConfigs: The deploy configurations of the HTTP API.

description^Optional

public readonly description: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of the HTTP API.

enableAuth^Optional

public readonly enableAuth: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableAuth: Whether to enable authentication.

firstByteTimeout^Optional

public readonly firstByteTimeout: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property firstByteTimeout: The first byte timeout.

ingressConfig^Optional

public readonly ingressConfig: IResolvable | IngressConfigProperty;

• Type: @alicloud/ros-cdk-core.IResolvable | IngressConfigProperty

Property ingressConfig: The ingress configuration of the HTTP API.

modelCategory^Optional

public readonly modelCategory: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property modelCategory: The model category.

onlyChangeConfig^Optional

public readonly onlyChangeConfig: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

True means only modify configuration without triggering redeployment.

protocols^Optional

public readonly protocols: IResolvable | string | IResolvable[];

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

Property protocols: The protocols supported by the HTTP API.

removeBasePathOnForward^Optional

public readonly removeBasePathOnForward: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

resourceGroupId^Optional

public readonly resourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.

strategy^Optional

public readonly strategy: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property strategy: The strategy of the HTTP API.

type^Optional

public readonly type: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property type: The type of the HTTP API.

versionConfig^Optional

public readonly versionConfig: IResolvable | VersionConfigProperty;

• Type: @alicloud/ros-cdk-core.IResolvable | VersionConfigProperty

Property versionConfig: The version configuration of the HTTP API.