InstanceProps

Properties for defining a Instance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-waf3-instance

Initializer

import { InstanceProps } from '@alicloud/ros-cdk-waf3'
const instanceProps: InstanceProps = { ... }

Properties

Name	Type	Description
payType	string | @alicloud/ros-cdk-core.IResolvable	Property payType: The billing method of the firewall instance.
region	string | @alicloud/ros-cdk-core.IResolvable	Property region: Web Application Firewall is available in the following regions: regions in the Chinese mainland, China (Hong Kong), Singapore (Singapore), Malaysia (Kuala Lumpur), US (Silicon Valley), Australia (Sydney), Germany (Frankfurt), India (Mumbai), Indonesia (Jakarta), UAE (Dubai), and Japan (Tokyo).
additionalProtectionNodes	number | @alicloud/ros-cdk-core.IResolvable	Property additionalProtectionNodes: Each protection cluster has at least two protection nodes, and each node provides the protection capabilities of up to 5,000 QPS for HTTP requests or up to 3,000 QPS for HTTPS requests.
apiSecurity	boolean | @alicloud/ros-cdk-core.IResolvable	Property apiSecurity: The API security feature detects responses with specified characteristics to check whether data leaks occur.
autoPay	boolean | @alicloud/ros-cdk-core.IResolvable	Property autoPay: Whether to auto pay the bill.
autoRenew	boolean | @alicloud/ros-cdk-core.IResolvable	Property autoRenew: Whether to auto renew the prepay instance.
botAppProtection	boolean | @alicloud/ros-cdk-core.IResolvable	Property botAppProtection: Bot management module for App protection.
botWebProtection	boolean | @alicloud/ros-cdk-core.IResolvable	Property botWebProtection: Bot management module for Web application protection.
domainsExtension	number | @alicloud/ros-cdk-core.IResolvable	Property domainsExtension: If the actual number of required access domain names exceeds the number of free domain names in the version, the number of domain names can be expanded according to this specification.Domain name counting does not differentiate between domain name types. The main domain name, sub-domain name, and pan-domain name are each counted as one domain name.
elasticQps	number | @alicloud/ros-cdk-core.IResolvable	Property elasticQps: The burstable QPS (pay-as-you-go) feature is suitable for scenarios that involve short-term or sudden traffic surges, for example, during promotions.
exclusiveIpAddress	number | @alicloud/ros-cdk-core.IResolvable	Property exclusiveIpAddress: Excluesive IP address number.
fraudDetection	boolean | @alicloud/ros-cdk-core.IResolvable	Property fraudDetection: You can enable this feature only after you enable the bot management module.
ignoreExisting	boolean | @alicloud/ros-cdk-core.IResolvable	Property ignoreExisting: Whether to ignore existing WAF3 instance False: ROS will perform a uniqueness check.If the WAF3 instance exists, an error will be reported when creating it. True: ROS will not check the uniqueness.If the WAF3 instance exists, the creation process will be ignored. If the WAF3 instance is not created by ROS, it will be ignored during update and delete stage.
intelligentLoadBalancing	boolean | @alicloud/ros-cdk-core.IResolvable	Property intelligentLoadBalancing: Intelligent load balancer for WAF instance.
logService	boolean | @alicloud/ros-cdk-core.IResolvable	Property logService: Log service for WAF instance.
logStorage	number | @alicloud/ros-cdk-core.IResolvable	Property logStorage: Log storage capacity.
period	number | @alicloud/ros-cdk-core.IResolvable	Property period: The subscription period of the firewallIf PeriodUnit is month, the valid range is 1, 3, 6 If periodUnit is year, the valid range is 1, 2, 3.
periodUnit	string | @alicloud/ros-cdk-core.IResolvable	Property periodUnit: The unit of the subscription duration.
qpsExtension	number | @alicloud/ros-cdk-core.IResolvable	Property qpsExtension: Extended QPS.
trafficBillingProtectionThreshold	number | @alicloud/ros-cdk-core.IResolvable	Property trafficBillingProtectionThreshold: In pay-as-you-go WAF 3.0, the traffic billing protection feature is automatically enabled to prevent unexpected and unusually high bills that result from unpredictable factors such as HTTP flood attacks. A bill is not generated for an hour if the peak traffic exceeds the traffic billing protection threshold within the hour. Then, your WAF instance is added to a sandbox. If the peak traffic is lower than the traffic billing protection threshold the next hour, your WAF instance is removed from the sandbox.
wafVersion	string | @alicloud/ros-cdk-core.IResolvable	Property wafVersion: The version of WAF3.0.

---

payType^Required

public readonly payType: string | IResolvable;

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

Property payType: The billing method of the firewall instance.

Valid values: PayAsYouGo: pay-as-you-go Subscription: subscription

---

region^Required

public readonly region: string | IResolvable;

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

Property region: Web Application Firewall is available in the following regions: regions in the Chinese mainland, China (Hong Kong), Singapore (Singapore), Malaysia (Kuala Lumpur), US (Silicon Valley), Australia (Sydney), Germany (Frankfurt), India (Mumbai), Indonesia (Jakarta), UAE (Dubai), and Japan (Tokyo).

If your origin server is deployed within the Chinese mainland, select Chinese Mainland. If your origin server is deployed outside the Chinese mainland, select Outside Chinese mainland. Intelligent region selection is supported.

---

additionalProtectionNodes^Optional

public readonly additionalProtectionNodes: number | IResolvable;

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

Property additionalProtectionNodes: Each protection cluster has at least two protection nodes, and each node provides the protection capabilities of up to 5,000 QPS for HTTP requests or up to 3,000 QPS for HTTPS requests.

You can add protection nodes to increase protection capabilities.

---

apiSecurity^Optional

public readonly apiSecurity: boolean | IResolvable;

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

Property apiSecurity: The API security feature detects responses with specified characteristics to check whether data leaks occur.

After you enable the feature, WAF is authorized to perform related analysis on your data. If you select Chinese Mainland, service deployment and data processing are performed in the Chinese mainland.

---

autoPay^Optional

public readonly autoPay: boolean | IResolvable;

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

Property autoPay: Whether to auto pay the bill.

---

autoRenew^Optional

public readonly autoRenew: boolean | IResolvable;

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

Property autoRenew: Whether to auto renew the prepay instance.

---

botAppProtection^Optional

public readonly botAppProtection: boolean | IResolvable;

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

Property botAppProtection: Bot management module for App protection.

---

botWebProtection^Optional

public readonly botWebProtection: boolean | IResolvable;

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

Property botWebProtection: Bot management module for Web application protection.

---

domainsExtension^Optional

public readonly domainsExtension: number | IResolvable;

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

Property domainsExtension: If the actual number of required access domain names exceeds the number of free domain names in the version, the number of domain names can be expanded according to this specification.Domain name counting does not differentiate between domain name types. The main domain name, sub-domain name, and pan-domain name are each counted as one domain name.

---

elasticQps^Optional

public readonly elasticQps: number | IResolvable;

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

Property elasticQps: The burstable QPS (pay-as-you-go) feature is suitable for scenarios that involve short-term or sudden traffic surges, for example, during promotions.

In these scenarios, the traffic peak may exceed the sum of the maximum QPS that is supported by your WAF edition and the extended QPS. If you enable the feature, you are charged based on the amount of excess QPS resources that you use. This helps prevent your domain names from being added to a sandbox when QPS resources are excessively used and helps ensure service continuity.

---

exclusiveIpAddress^Optional

public readonly exclusiveIpAddress: number | IResolvable;

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

Property exclusiveIpAddress: Excluesive IP address number.

---

fraudDetection^Optional

public readonly fraudDetection: boolean | IResolvable;

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

Property fraudDetection: You can enable this feature only after you enable the bot management module.

If abnormal phone numbers are used in logon or registration scenarios, anomaly tags are matched. Requests from the abnormal phone numbers are blocked or CAPTCHA verification is required. You are charged based on the number of times that anomaly tags are matched.

---

ignoreExisting^Optional

public readonly ignoreExisting: boolean | IResolvable;

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

Property ignoreExisting: Whether to ignore existing WAF3 instance False: ROS will perform a uniqueness check.If the WAF3 instance exists, an error will be reported when creating it. True: ROS will not check the uniqueness.If the WAF3 instance exists, the creation process will be ignored. If the WAF3 instance is not created by ROS, it will be ignored during update and delete stage.

---

intelligentLoadBalancing^Optional

public readonly intelligentLoadBalancing: boolean | IResolvable;

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

Property intelligentLoadBalancing: Intelligent load balancer for WAF instance.

---

logService^Optional

public readonly logService: boolean | IResolvable;

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

Property logService: Log service for WAF instance.

---

logStorage^Optional

public readonly logStorage: number | IResolvable;

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

Property logStorage: Log storage capacity.

---

period^Optional

public readonly period: number | IResolvable;

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

Property period: The subscription period of the firewallIf PeriodUnit is month, the valid range is 1, 3, 6 If periodUnit is year, the valid range is 1, 2, 3.

---

periodUnit^Optional

public readonly periodUnit: string | IResolvable;

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

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

---

qpsExtension^Optional

public readonly qpsExtension: number | IResolvable;

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

Property qpsExtension: Extended QPS.

---

trafficBillingProtectionThreshold^Optional

public readonly trafficBillingProtectionThreshold: number | IResolvable;

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

Property trafficBillingProtectionThreshold: In pay-as-you-go WAF 3.0, the traffic billing protection feature is automatically enabled to prevent unexpected and unusually high bills that result from unpredictable factors such as HTTP flood attacks. A bill is not generated for an hour if the peak traffic exceeds the traffic billing protection threshold within the hour. Then, your WAF instance is added to a sandbox. If the peak traffic is lower than the traffic billing protection threshold the next hour, your WAF instance is removed from the sandbox.

---

wafVersion^Optional

public readonly wafVersion: string | IResolvable;

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

Property wafVersion: The version of WAF3.0.

---