語法

{
  "Type": "ALIYUN::WAF3::Instance",
  "Properties": {
    "IgnoreExisting": Boolean,
    "IntelligentLoadBalancing": Boolean,
    "AutoRenew": Boolean,
    "Period": Integer,
    "BotWebProtection": Boolean,
    "ApiSecurity": Boolean,
    "AutoPay": Boolean,
    "TrafficBillingProtectionThreshold": Integer,
    "PayType": String,
    "LogStorage": Integer,
    "ElasticQps": Integer,
    "DomainsExtension": Integer,
    "WafVersion": String,
    "ExclusiveIPAddress": Integer,
    "AdditionalProtectionNodes": Integer,
    "Region": String,
    "QpsExtension": Integer,
    "FraudDetection": Boolean,
    "BotAppProtection": Boolean,
    "LogService": Boolean,
    "PeriodUnit": String
  }
}

屬性

返回值

Fn::GetAtt

InstanceId：WAF3實(shí)例ID。

示例

• YAML格式

  ROSTemplateFormatVersion: '2015-09-01'
  Parameters:
    AdditionalProtectionNodes:
      Default: 0
      Description:
        en: '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. '
      MaxValue: 500
      MinValue: 0
      Required: false
      Type: Number
    ApiSecurity:
      Description:
        en: 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.
      Required: false
      Type: Boolean
    AutoPay:
      Default: false
      Description:
        en: Whether to auto pay the bill.
      Required: false
      Type: Boolean
    AutoRenew:
      Description:
        en: Whether to auto renew the prepay instance.
      Required: false
      Type: Boolean
    BotAppProtection:
      Default: true
      Description:
        en: Bot management module for App protection.
      Required: false
      Type: Boolean
    BotWebProtection:
      Default: true
      Description:
        en: Bot management module for Web application protection.
      Required: false
      Type: Boolean
    DomainsExtension:
      Default: 0
      Description:
        en: 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.
      MaxValue: 5000
      MinValue: 0
      Required: false
      Type: Number
    ElasticQps:
      Default: 0
      Description:
        en: 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.
      MaxValue: 60000
      MinValue: 0
      Required: false
      Type: Number
    ExclusiveIPAddress:
      Default: 0
      Description:
        en: Excluesive IP address number.
      MaxValue: 100
      MinValue: 0
      Required: false
      Type: Number
    FraudDetection:
      Default: true
      Description:
        en: '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. '
      Required: false
      Type: Boolean
    IgnoreExisting:
      Default: false
      Description:
        en: '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.'
      Required: false
      Type: Boolean
    IntelligentLoadBalancing:
      Description:
        en: Intelligent load balancer for WAF instance.
      Required: false
      Type: Boolean
    LogService:
      Description:
        en: Log service for WAF instance.
      Required: false
      Type: Boolean
    LogStorage:
      Description:
        en: Log storage capacity.
      MaxValue: 150
      MinValue: 3
      Required: false
      Type: Number
    PayType:
      AllowedValues:
      - PayAsYouGo
      - Subscription
      Description:
        en: 'The billing method of the firewall instance. Valid values:
  
          PayAsYouGo: pay-as-you-go
  
          Subscription: subscription'
      Required: true
      Type: String
    Period:
      AllowedValues:
      - 1
      - 2
      - 3
      - 6
      AssociationProperty: PayPeriod
      Description:
        en: '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'
      Required: false
      Type: Number
    PeriodUnit:
      AllowedValues:
      - Month
      - Year
      AssociationProperty: PayPeriodUnit
      Description:
        en: 'The unit of the subscription duration. Valid values:
  
          Month
  
          Year
  
          Default value: Month.'
      Required: false
      Type: String
    QpsExtension:
      Default: 0
      Description:
        en: Extended QPS.
      MaxValue: 30000
      MinValue: 0
      Required: false
      Type: Number
    Region:
      AllowedValues:
      - OutsideChineseMainland
      - ChineseMainland
      Description:
        en: "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), Germany (Frankfurt),\
          \ Indonesia (Jakarta), UAE (Dubai), and Japan (Tokyo).\n 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."
      Required: true
      Type: String
    TrafficBillingProtectionThreshold:
      Description:
        en: 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.
      MaxValue: 100000
      MinValue: 1000
      Required: false
      Type: Number
    WafVersion:
      AllowedValues:
      - Basic
      - Pro
      - Enterprise
      - Ultimate
      Description:
        en: 'The version of WAF3.0.
  
          '
      Required: false
      Type: String
  Resources:
    Instance:
      Properties:
        AdditionalProtectionNodes:
          Ref: AdditionalProtectionNodes
        ApiSecurity:
          Ref: ApiSecurity
        AutoPay:
          Ref: AutoPay
        AutoRenew:
          Ref: AutoRenew
        BotAppProtection:
          Ref: BotAppProtection
        BotWebProtection:
          Ref: BotWebProtection
        DomainsExtension:
          Ref: DomainsExtension
        ElasticQps:
          Ref: ElasticQps
        ExclusiveIPAddress:
          Ref: ExclusiveIPAddress
        FraudDetection:
          Ref: FraudDetection
        IgnoreExisting:
          Ref: IgnoreExisting
        IntelligentLoadBalancing:
          Ref: IntelligentLoadBalancing
        LogService:
          Ref: LogService
        LogStorage:
          Ref: LogStorage
        PayType:
          Ref: PayType
        Period:
          Ref: Period
        PeriodUnit:
          Ref: PeriodUnit
        QpsExtension:
          Ref: QpsExtension
        Region:
          Ref: Region
        TrafficBillingProtectionThreshold:
          Ref: TrafficBillingProtectionThreshold
        WafVersion:
          Ref: WafVersion
      Type: ALIYUN::WAF3::Instance
  Outputs:
    InstanceId:
      Description: Instance Id.
      Value:
        Fn::GetAtt:
        - Instance
        - InstanceId
                          

• JSON格式

  {
    "ROSTemplateFormatVersion": "2015-09-01",
    "Parameters": {
      "IgnoreExisting": {
        "Type": "Boolean",
        "Description": {
          "en": "Whether to ignore existing WAF3 instance\nFalse: ROS will perform a uniqueness check.If the WAF3 instance exists, an error will be reported when creating it.\nTrue: ROS will not check the uniqueness.If the WAF3 instance exists, the creation process will be ignored.\nIf the WAF3 instance is not created by ROS, it will be ignored during update and delete stage."
        },
        "Required": false,
        "Default": false
      },
      "AutoRenew": {
        "Type": "Boolean",
        "Description": {
          "en": "Whether to auto renew the prepay instance."
        },
        "Required": false
      },
      "IntelligentLoadBalancing": {
        "Type": "Boolean",
        "Description": {
          "en": "Intelligent load balancer for WAF instance."
        },
        "Required": false
      },
      "Period": {
        "AssociationProperty": "PayPeriod",
        "Type": "Number",
        "Description": {
          "en": "The subscription period of the firewallIf PeriodUnit is month, the valid range is 1, 3, 6\nIf periodUnit is year, the valid range is 1, 2, 3"
        },
        "AllowedValues": [
          1,
          2,
          3,
          6
        ],
        "Required": false
      },
      "BotWebProtection": {
        "Type": "Boolean",
        "Description": {
          "en": "Bot management module for Web application protection."
        },
        "Required": false,
        "Default": true
      },
      "TrafficBillingProtectionThreshold": {
        "Type": "Number",
        "Description": {
          "en": "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."
        },
        "Required": false,
        "MinValue": 1000,
        "MaxValue": 100000
      },
      "ApiSecurity": {
        "Type": "Boolean",
        "Description": {
          "en": "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."
        },
        "Required": false
      },
      "PayType": {
        "Type": "String",
        "Description": {
          "en": "The billing method of the firewall instance. Valid values:\nPayAsYouGo: pay-as-you-go\nSubscription: subscription"
        },
        "AllowedValues": [
          "PayAsYouGo",
          "Subscription"
        ],
        "Required": true
      },
      "AutoPay": {
        "Type": "Boolean",
        "Description": {
          "en": "Whether to auto pay the bill."
        },
        "Required": false,
        "Default": false
      },
      "LogStorage": {
        "Type": "Number",
        "Description": {
          "en": "Log storage capacity."
        },
        "Required": false,
        "MinValue": 3,
        "MaxValue": 150
      },
      "ElasticQps": {
        "Type": "Number",
        "Description": {
          "en": "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."
        },
        "Required": false,
        "MinValue": 0,
        "MaxValue": 60000,
        "Default": 0
      },
      "DomainsExtension": {
        "Type": "Number",
        "Description": {
          "en": "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."
        },
        "Required": false,
        "MinValue": 0,
        "MaxValue": 5000,
        "Default": 0
      },
      "WafVersion": {
        "Type": "String",
        "Description": {
          "en": "The version of WAF3.0.\n"
        },
        "AllowedValues": [
          "Basic",
          "Pro",
          "Enterprise",
          "Ultimate"
        ],
        "Required": false
      },
      "AdditionalProtectionNodes": {
        "Type": "Number",
        "Description": {
          "en": "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. "
        },
        "Required": false,
        "MinValue": 0,
        "MaxValue": 500,
        "Default": 0
      },
      "ExclusiveIPAddress": {
        "Type": "Number",
        "Description": {
          "en": "Excluesive IP address number."
        },
        "Required": false,
        "MinValue": 0,
        "MaxValue": 100,
        "Default": 0
      },
      "Region": {
        "Type": "String",
        "Description": {
          "en": "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), Germany (Frankfurt), Indonesia (Jakarta), UAE (Dubai), and Japan (Tokyo).\n 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."
        },
        "AllowedValues": [
          "OutsideChineseMainland",
          "ChineseMainland"
        ],
        "Required": true
      },
      "QpsExtension": {
        "Type": "Number",
        "Description": {
          "en": "Extended QPS."
        },
        "Required": false,
        "MinValue": 0,
        "MaxValue": 30000,
        "Default": 0
      },
      "FraudDetection": {
        "Type": "Boolean",
        "Description": {
          "en": "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. "
        },
        "Required": false,
        "Default": true
      },
      "BotAppProtection": {
        "Type": "Boolean",
        "Description": {
          "en": "Bot management module for App protection."
        },
        "Required": false,
        "Default": true
      },
      "LogService": {
        "Type": "Boolean",
        "Description": {
          "en": "Log service for WAF instance."
        },
        "Required": false
      },
      "PeriodUnit": {
        "AssociationProperty": "PayPeriodUnit",
        "Type": "String",
        "Description": {
          "en": "The unit of the subscription duration. Valid values:\nMonth\nYear\nDefault value: Month."
        },
        "AllowedValues": [
          "Month",
          "Year"
        ],
        "Required": false
      }
    },
    "Resources": {
      "Instance": {
        "Type": "ALIYUN::WAF3::Instance",
        "Properties": {
          "IgnoreExisting": {
            "Ref": "IgnoreExisting"
          },
          "AutoRenew": {
            "Ref": "AutoRenew"
          },
          "IntelligentLoadBalancing": {
            "Ref": "IntelligentLoadBalancing"
          },
          "Period": {
            "Ref": "Period"
          },
          "BotWebProtection": {
            "Ref": "BotWebProtection"
          },
          "TrafficBillingProtectionThreshold": {
            "Ref": "TrafficBillingProtectionThreshold"
          },
          "ApiSecurity": {
            "Ref": "ApiSecurity"
          },
          "PayType": {
            "Ref": "PayType"
          },
          "AutoPay": {
            "Ref": "AutoPay"
          },
          "LogStorage": {
            "Ref": "LogStorage"
          },
          "ElasticQps": {
            "Ref": "ElasticQps"
          },
          "DomainsExtension": {
            "Ref": "DomainsExtension"
          },
          "WafVersion": {
            "Ref": "WafVersion"
          },
          "AdditionalProtectionNodes": {
            "Ref": "AdditionalProtectionNodes"
          },
          "ExclusiveIPAddress": {
            "Ref": "ExclusiveIPAddress"
          },
          "Region": {
            "Ref": "Region"
          },
          "QpsExtension": {
            "Ref": "QpsExtension"
          },
          "FraudDetection": {
            "Ref": "FraudDetection"
          },
          "BotAppProtection": {
            "Ref": "BotAppProtection"
          },
          "LogService": {
            "Ref": "LogService"
          },
          "PeriodUnit": {
            "Ref": "PeriodUnit"
          }
        }
      }
    },
    "Outputs": {
      "InstanceId": {
        "Description": "Instance Id.",
        "Value": {
          "Fn::GetAtt": [
            "Instance",
            "InstanceId"
          ]
        }
      }
    }
  }