Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkwaf3"
&alicloudroscdkwaf3.InstanceProps {
    PayType: interface{},
    Region: interface{},
    AdditionalProtectionNodes: interface{},
    ApiSecurity: interface{},
    AutoPay: interface{},
    AutoRenew: interface{},
    BotAppProtection: interface{},
    BotWebProtection: interface{},
    DomainsExtension: interface{},
    ElasticQps: interface{},
    ExclusiveIpAddress: interface{},
    FraudDetection: interface{},
    IgnoreExisting: interface{},
    IntelligentLoadBalancing: interface{},
    LogService: interface{},
    LogStorage: interface{},
    Period: interface{},
    PeriodUnit: interface{},
    QpsExtension: interface{},
    TrafficBillingProtectionThreshold: interface{},
    WafVersion: interface{},
}

Properties

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

PayTypeRequired

PayType interface{}
  • Type: interface{}

Property payType: The billing method of the firewall instance.

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


RegionRequired

Region interface{}
  • Type: interface{}

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

AdditionalProtectionNodes interface{}
  • Type: interface{}

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

ApiSecurity interface{}
  • Type: interface{}

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

AutoPay interface{}
  • Type: interface{}

Property autoPay: Whether to auto pay the bill.


AutoRenewOptional

AutoRenew interface{}
  • Type: interface{}

Property autoRenew: Whether to auto renew the prepay instance.


BotAppProtectionOptional

BotAppProtection interface{}
  • Type: interface{}

Property botAppProtection: Bot management module for App protection.


BotWebProtectionOptional

BotWebProtection interface{}
  • Type: interface{}

Property botWebProtection: Bot management module for Web application protection.


DomainsExtensionOptional

DomainsExtension interface{}
  • Type: interface{}

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

ElasticQps interface{}
  • Type: interface{}

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

ExclusiveIpAddress interface{}
  • Type: interface{}

Property exclusiveIpAddress: Excluesive IP address number.


FraudDetectionOptional

FraudDetection interface{}
  • Type: interface{}

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

IgnoreExisting interface{}
  • Type: interface{}

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

IntelligentLoadBalancing interface{}
  • Type: interface{}

Property intelligentLoadBalancing: Intelligent load balancer for WAF instance.


LogServiceOptional

LogService interface{}
  • Type: interface{}

Property logService: Log service for WAF instance.


LogStorageOptional

LogStorage interface{}
  • Type: interface{}

Property logStorage: Log storage capacity.


PeriodOptional

Period interface{}
  • Type: interface{}

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

PeriodUnit interface{}
  • Type: interface{}

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.


QpsExtensionOptional

QpsExtension interface{}
  • Type: interface{}

Property qpsExtension: Extended QPS.


TrafficBillingProtectionThresholdOptional

TrafficBillingProtectionThreshold interface{}
  • Type: interface{}

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

WafVersion interface{}
  • Type: interface{}

Property wafVersion: The version of WAF3.0.