Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Waf3;
new InstanceProps {
    object PayType,
    object Region,
    object AdditionalProtectionNodes = null,
    object ApiSecurity = null,
    object AutoPay = null,
    object AutoRenew = null,
    object BotAppProtection = null,
    object BotWebProtection = null,
    object DomainsExtension = null,
    object ElasticQps = null,
    object ExclusiveIpAddress = null,
    object FraudDetection = null,
    object IgnoreExisting = null,
    object IntelligentLoadBalancing = null,
    object LogService = null,
    object LogStorage = null,
    object Period = null,
    object PeriodUnit = null,
    object QpsExtension = null,
    object TrafficBillingProtectionThreshold = null,
    object WafVersion = null
};

Properties

Name Type Description
PayType object Property payType: The billing method of the firewall instance.
Region object 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 object 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 object Property apiSecurity: The API security feature detects responses with specified characteristics to check whether data leaks occur.
AutoPay object Property autoPay: Whether to auto pay the bill.
AutoRenew object Property autoRenew: Whether to auto renew the prepay instance.
BotAppProtection object Property botAppProtection: Bot management module for App protection.
BotWebProtection object Property botWebProtection: Bot management module for Web application protection.
DomainsExtension object 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 object 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 object Property exclusiveIpAddress: Excluesive IP address number.
FraudDetection object Property fraudDetection: You can enable this feature only after you enable the bot management module.
IgnoreExisting object 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 object Property intelligentLoadBalancing: Intelligent load balancer for WAF instance.
LogService object Property logService: Log service for WAF instance.
LogStorage object Property logStorage: Log storage capacity.
Period object 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 object Property periodUnit: The unit of the subscription duration.
QpsExtension object Property qpsExtension: Extended QPS.
TrafficBillingProtectionThreshold object 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 object Property wafVersion: The version of WAF3.0.

PayTypeRequired

public object PayType { get; set; }
  • Type: object

Property payType: The billing method of the firewall instance.

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


RegionRequired

public object Region { get; set; }
  • Type: object

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.


AdditionalProtectionNodesOptional

public object AdditionalProtectionNodes { get; set; }
  • Type: object

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.


ApiSecurityOptional

public object ApiSecurity { get; set; }
  • Type: object

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.


AutoPayOptional

public object AutoPay { get; set; }
  • Type: object

Property autoPay: Whether to auto pay the bill.


AutoRenewOptional

public object AutoRenew { get; set; }
  • Type: object

Property autoRenew: Whether to auto renew the prepay instance.


BotAppProtectionOptional

public object BotAppProtection { get; set; }
  • Type: object

Property botAppProtection: Bot management module for App protection.


BotWebProtectionOptional

public object BotWebProtection { get; set; }
  • Type: object

Property botWebProtection: Bot management module for Web application protection.


DomainsExtensionOptional

public object DomainsExtension { get; set; }
  • Type: object

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.


ElasticQpsOptional

public object ElasticQps { get; set; }
  • Type: object

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.


ExclusiveIpAddressOptional

public object ExclusiveIpAddress { get; set; }
  • Type: object

Property exclusiveIpAddress: Excluesive IP address number.


FraudDetectionOptional

public object FraudDetection { get; set; }
  • Type: object

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.


IgnoreExistingOptional

public object IgnoreExisting { get; set; }
  • Type: object

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.


IntelligentLoadBalancingOptional

public object IntelligentLoadBalancing { get; set; }
  • Type: object

Property intelligentLoadBalancing: Intelligent load balancer for WAF instance.


LogServiceOptional

public object LogService { get; set; }
  • Type: object

Property logService: Log service for WAF instance.


LogStorageOptional

public object LogStorage { get; set; }
  • Type: object

Property logStorage: Log storage capacity.


PeriodOptional

public object Period { get; set; }
  • Type: object

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.


PeriodUnitOptional

public object PeriodUnit { get; set; }
  • Type: object

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.


QpsExtensionOptional

public object QpsExtension { get; set; }
  • Type: object

Property qpsExtension: Extended QPS.


TrafficBillingProtectionThresholdOptional

public object TrafficBillingProtectionThreshold { get; set; }
  • Type: object

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.


WafVersionOptional

public object WafVersion { get; set; }
  • Type: object

Property wafVersion: The version of WAF3.0.