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
| Name | Type | Description |
|---|---|---|
httpApiName |
string | @alicloud/ros-cdk-core.IResolvable |
Property httpApiName: The name of the API. |
protocols |
@alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] |
Property protocols: List of API Access Protocols. |
basePath |
string | @alicloud/ros-cdk-core.IResolvable |
Property basePath: The base path of the API should start with a \/. |
description |
string | @alicloud/ros-cdk-core.IResolvable |
Property description: Description of API. |
type |
string | @alicloud/ros-cdk-core.IResolvable |
Property type: The type of HTTP API, Valid values: * Http * Rest * WebSocket * HttpIngress. |
httpApiNameRequired
public readonly httpApiName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property httpApiName: The name of the API.
protocolsRequired
public readonly protocols: IResolvable | string | IResolvable[];
- Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]
Property protocols: List of API Access Protocols.
basePathOptional
public readonly basePath: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property basePath: The base path of the API should start with a \/.
descriptionOptional
public readonly description: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property description: Description of API.
typeOptional
public readonly type: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property type: The type of HTTP API, Valid values: * Http * Rest * WebSocket * HttpIngress.