TrafficControlProps
Properties for defining a TrafficControl.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-trafficcontrol
Initializer
import { TrafficControlProps } from '@alicloud/ros-cdk-apigateway'
const trafficControlProps: TrafficControlProps = { ... }
Properties
| Name | Type | Description |
|---|---|---|
apiDefault | number | @alicloud/ros-cdk-core.IResolvable | Property apiDefault: Default API traffic value. |
trafficControlName | string | @alicloud/ros-cdk-core.IResolvable | Property trafficControlName: The name of the throttling policy. |
trafficControlUnit | string | @alicloud/ros-cdk-core.IResolvable | Property trafficControlUnit: The unit to be used in the throttling policy. |
appDefault | string | @alicloud/ros-cdk-core.IResolvable | Property appDefault: Default APP traffic value. |
description | string | @alicloud/ros-cdk-core.IResolvable | Property description: Description of the traffic control, less than 180 characters. |
special | @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | SpecialProperty[] | Property special: Special traffic controls. |
userDefault | string | @alicloud/ros-cdk-core.IResolvable | Property userDefault: Default user traffic value. |
apiDefaultRequired
public readonly apiDefault: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
Property apiDefault: Default API traffic value.
trafficControlNameRequired
public readonly trafficControlName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property trafficControlName: The name of the throttling policy.
The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (_). It cannot start with an underscore.
trafficControlUnitRequired
public readonly trafficControlUnit: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property trafficControlUnit: The unit to be used in the throttling policy.
Valid values: - SECOND - MINUTE - HOUR - DAY
appDefaultOptional
public readonly appDefault: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property appDefault: Default APP traffic value.
descriptionOptional
public readonly description: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property description: Description of the traffic control, less than 180 characters.
specialOptional
public readonly special: IResolvable | IResolvable | SpecialProperty[];
- Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | SpecialProperty[]
Property special: Special traffic controls.
userDefaultOptional
public readonly userDefault: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property userDefault: Default user traffic value.