All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::DDoSPro::ProInstance

Last Updated:Apr 10, 2025

ALIYUN::DDoSPro::ProInstance is used to create an Anti-DDoS Proxy (Chinese Mainland) instance.

Syntax

{
  "Type": "ALIYUN::DDoSPro::ProInstance",
  "Properties": {
    "NormalQps": Integer,
    "Period": Integer,
    "PortCount": Integer,
    "Edition": String,
    "BurstBandwidthMode": String,
    "ServiceBandwidth": Integer,
    "ServicePartner": String,
    "BaseBandwidth": Integer,
    "FunctionVersion": String,
    "Bandwidth": Integer,
    "AddressType": String,
    "PeriodUnit": String,
    "DomainCount": Integer,
      "Tags": List
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

NormalQps

Integer

No

No

The clean queries per second (QPS) provided by the instance.

Valid values: an integral multiple of 100 that ranges from 3000 to 100000.

Period

Integer

No

No

The subscription duration.

  • Valid values when PeriodUnit is set to Month or month: 1, 2, 3, 4, 5, 6, 12, and 24.

  • Valid values when PeriodUnit is set to Year or year: 1 and 2.

PortCount

Integer

No

No

The number of ports to be protected.

The valid values of PortCount vary based on the value of ProductPlan:

  • Valid values when ProductPlan is set to 0: an integral multiple of 5 that ranges from 5 to 400.  

  • Valid values when ProductPlan is set to 1: an integral multiple of 5 that ranges from 5 to 400.  

  • Valid value when ProductPlan is set to 2: null. In this case, you do not need to specify PortCount.  

  • Valid values when ProductPlan is set to 3: an integral multiple of 5 that ranges from 5 to 400.  

Edition

String

No

No

The type of the mitigation plan.

Set the value to coop. A value of coop specifies the Profession mitigation plan.

BurstBandwidthMode

String

No

No

The metering method of the 95th percentile burstable clean bandwidth.

Valid values:

  • 0: disables the burstable clean bandwidth feature.

  • 1: enables the burstable clean bandwidth feature and uses the daily 95th percentile metering method.

  • 2: enables the burstable clean bandwidth feature and uses the monthly 95th percentile metering method.

ServiceBandwidth

Integer

No

No

The clean bandwidth.

Unit: Mbit/s.

Valid values: an integral multiple of 50 that ranges from 100 to 5000.

ServicePartner

String

No

No

The type of the protection line.

Set the value to coop-line-001. A value of coop-line-001 specifies the default protection line.

BaseBandwidth

Integer

No

No

The basic protection bandwidth.

Unit: Gbit/s.

Valid values: 30, 60, 100, 300, 400, 500, and 600.

FunctionVersion

String

No

No

The type of the function plan.

Valid values:

  • 0: Standard.

  • 1: Enhanced.

Bandwidth

Integer

No

Yes

The burstable protection bandwidth.

Unit: Gbit/s.

The burstable protection bandwidth must be greater than or equal to the basic protection bandwidth. The valid values of Bandwidth vary based on the value of BaseBandwidth:

  • Valid values when BaseBandwidth is set to 30: 30, 40, 50, 60, 70, 80, 100, 150, 200, and 300.

  • Valid values when BaseBandwidth is set to 60: 60, 70, 80, 100, 150, 200, 300, 400, 500, and 600.

  • Valid values when BaseBandwidth is set to 100: 100, 150, 200, 300, 400, 500, and 600.

  • Valid values when BaseBandwidth is set to 300: 300, 400, 500, and 600.

  • Valid values when BaseBandwidth is set to 400: 400, 500, and 600.

  • Valid values when BaseBandwidth is set to 500: 500 and 600.

  • Valid value when BaseBandwidth is set to 600: 600.

AddressType

String

No

No

The IP version of the IP address.

Valid values:

  • Ipv4

  • Ipv6

PeriodUnit

String

No

No

The unit of the subscription duration.

Default value: Month.

Valid values:

  • Month or month

  • Year or year

DomainCount

Integer

No

No

The number of domain names to be protected.

The valid values of DomainCount vary based on the value of ProductPlan:

  • Valid values when ProductPlan is set to 0: an integral multiple of 10 that ranges from 10 to 200.  

  • Valid values when ProductPlan is set to 1: an integral multiple of 10 that ranges from 10 to 200.  

  • Valid value when ProductPlan is set to 2: null. In this case, you do not need to specify PortCount.  

  • Valid values when ProductPlan is set to 3: an integral multiple of 10 that ranges from 10 to 200.

Tags

List

No

Yes

The tags.

For more information, see Tags properties.

Tags syntax

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]

Tags properties

Property

Type

Required

Editable

Description

Constraint

Key

String

Yes

No

The key of the tag.

None.

Value

String

No

No

The value of the tag.

None.

Return values

Fn::GetAtt

  • InstanceId: the ID of the created instance.

  • Arn: the Alibaba Cloud Resource Name (ARN).

Examples

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AddressType:
    AllowedValues:
    - Ipv4
    - Ipv6
    Description:
      en: "The IP version of the IP address. Valid values: Ipv4\u3001Ipv6"
    Required: false
    Type: String
  Bandwidth:
    Description:
      en: 'The burstable protection bandwidth. Unit: Gbit/s.

        The burstable protection bandwidth must be greater than or equal to the basic
        protection bandwidth. The value of Bandwidth varies based on the value of
        BaseBandwidth.'
    Required: false
    Type: Number
  BaseBandwidth:
    AllowedValues:
    - 30
    - 60
    - 100
    - 300
    - 400
    - 500
    - 600
    Description:
      en: 'The basic protection bandwidth. Unit: Gbit/s.

        Valid values: 30, 60, 100, 300, 400, 500, and 600.'
    Required: false
    Type: Number
  BurstBandwidthMode:
    AllowedValues:
    - '0'
    - '1'
    - '2'
    Description:
      en: 'The metering method of the 95th percentile burstable clean bandwidth. Valid
        values:

        0: disables the burstable clean bandwidth feature.

        1: enables the burstable clean bandwidth feature and uses the daily 95th percentile
        metering method.

        2: enables the burstable clean bandwidth feature and uses the monthly 95th
        percentile metering method.'
    Required: false
    Type: String
  DomainCount:
    Description:
      en: 'The number of domain names that you want to protect.

        Valid values: 50 to 2000. The value must be a multiple of 10.'
    MaxValue: 2000
    MinValue: 50
    Required: false
    Type: Number
  Edition:
    Description:
      en: The mitigation plan of the instance. Set the value to coop, which indicates
        the Profession mitigation plan.
    Required: false
    Type: String
  FunctionVersion:
    AllowedValues:
    - '0'
    - '1'
    Description:
      en: 'The function plan of the instance. Valid values:

        0: the Standard function plan

        1: the Enhanced function plan.'
    Required: false
    Type: String
  NormalQps:
    Description:
      en: 'The clean queries per second (QPS) provided by the instance.

        Valid values: 3000 to 100000. The value must be a multiple of 100.'
    MaxValue: 100000
    MinValue: 3000
    Required: false
    Type: Number
  Period:
    AllowedValues:
    - 1
    - 2
    - 3
    - 4
    - 5
    - 6
    - 12
    - 24
    AssociationProperty: PayPeriod
    Description:
      en: 'The subscription period of the firewallIf PeriodUnit is Month, the valid
        range is 1, 2, 3, 4, 5, 6, 12, 24

        If PeriodUnit is Year, the valid range is 1, 2'
    Required: false
    Type: Number
  PeriodUnit:
    AllowedValues:
    - Month
    - Year
    - month
    - year
    AssociationProperty: PayPeriodUnit
    Description:
      en: 'The unit of the subscription duration. Valid values:

        Month

        Year

        Default value: Month.'
    Required: false
    Type: String
  PortCount:
    Description:
      en: 'The number of ports that you want to protect.

        Valid values: 50 to 400. The value must be a multiple of 5.'
    MaxValue: 400
    MinValue: 50
    Required: false
    Type: Number
  ServiceBandwidth:
    Description:
      en: 'The clean bandwidth provided by the instance. Unit: Mbit/s.

        Valid values: 100 to 5000. The value must be a multiple of 50.'
    MaxValue: 5000
    MinValue: 100
    Required: false
    Type: Number
  ServicePartner:
    Description:
      en: The type of the protection line. Set the value to coop-line-001, which indicates
        the default protection line.
    Required: false
    Type: String
Resources:
  ProInstance:
    Properties:
      AddressType:
        Ref: AddressType
      Bandwidth:
        Ref: Bandwidth
      BaseBandwidth:
        Ref: BaseBandwidth
      BurstBandwidthMode:
        Ref: BurstBandwidthMode
      DomainCount:
        Ref: DomainCount
      Edition:
        Ref: Edition
      FunctionVersion:
        Ref: FunctionVersion
      NormalQps:
        Ref: NormalQps
      Period:
        Ref: Period
      PeriodUnit:
        Ref: PeriodUnit
      PortCount:
        Ref: PortCount
      ServiceBandwidth:
        Ref: ServiceBandwidth
      ServicePartner:
        Ref: ServicePartner
    Type: ALIYUN::DDoSPro::ProInstance
Outputs:
  InstanceId:
    Description: The ID of the instance.
    Value:
      Fn::GetAtt:
      - ProInstance
      - InstanceId
                        
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "NormalQps": {
      "Type": "Number",
      "Description": {
        "en": "The clean queries per second (QPS) provided by the instance.\nValid values: 3000 to 100000. The value must be a multiple of 100."
      },
      "Required": false,
      "MinValue": 3000,
      "MaxValue": 100000
    },
    "Period": {
      "AssociationProperty": "PayPeriod",
      "Type": "Number",
      "Description": {
        "en": "The subscription period of the firewallIf PeriodUnit is Month, the valid range is 1, 2, 3, 4, 5, 6, 12, 24\nIf PeriodUnit is Year, the valid range is 1, 2"
      },
      "AllowedValues": [
        1,
        2,
        3,
        4,
        5,
        6,
        12,
        24
      ],
      "Required": false
    },
    "PortCount": {
      "Type": "Number",
      "Description": {
        "en": "The number of ports that you want to protect.\nValid values: 50 to 400. The value must be a multiple of 5."
      },
      "Required": false,
      "MinValue": 50,
      "MaxValue": 400
    },
    "Edition": {
      "Type": "String",
      "Description": {
        "en": "The mitigation plan of the instance. Set the value to coop, which indicates the Profession mitigation plan."
      },
      "Required": false
    },
    "BurstBandwidthMode": {
      "Type": "String",
      "Description": {
        "en": "The metering method of the 95th percentile burstable clean bandwidth. Valid values:\n0: disables the burstable clean bandwidth feature.\n1: enables the burstable clean bandwidth feature and uses the daily 95th percentile metering method.\n2: enables the burstable clean bandwidth feature and uses the monthly 95th percentile metering method."
      },
      "AllowedValues": [
        "0",
        "1",
        "2"
      ],
      "Required": false
    },
    "ServiceBandwidth": {
      "Type": "Number",
      "Description": {
        "en": "The clean bandwidth provided by the instance. Unit: Mbit/s.\nValid values: 100 to 5000. The value must be a multiple of 50."
      },
      "Required": false,
      "MinValue": 100,
      "MaxValue": 5000
    },
    "ServicePartner": {
      "Type": "String",
      "Description": {
        "en": "The type of the protection line. Set the value to coop-line-001, which indicates the default protection line."
      },
      "Required": false
    },
    "BaseBandwidth": {
      "Type": "Number",
      "Description": {
        "en": "The basic protection bandwidth. Unit: Gbit/s.\nValid values: 30, 60, 100, 300, 400, 500, and 600."
      },
      "AllowedValues": [
        30,
        60,
        100,
        300,
        400,
        500,
        600
      ],
      "Required": false
    },
    "FunctionVersion": {
      "Type": "String",
      "Description": {
        "en": "The function plan of the instance. Valid values:\n0: the Standard function plan\n1: the Enhanced function plan."
      },
      "AllowedValues": [
        "0",
        "1"
      ],
      "Required": false
    },
    "Bandwidth": {
      "Type": "Number",
      "Description": {
        "en": "The burstable protection bandwidth. Unit: Gbit/s.\nThe burstable protection bandwidth must be greater than or equal to the basic protection bandwidth. The value of Bandwidth varies based on the value of BaseBandwidth."
      },
      "Required": false
    },
    "AddressType": {
      "Type": "String",
      "Description": {
        "en": "The IP version of the IP address. Valid values: Ipv4 and Ipv6."
      },
      "AllowedValues": [
        "Ipv4",
        "Ipv6"
      ],
      "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",
        "month",
        "year"
      ],
      "Required": false
    },
    "DomainCount": {
      "Type": "Number",
      "Description": {
        "en": "The number of domain names that you want to protect.\nValid values: 50 to 2000. The value must be a multiple of 10."
      },
      "Required": false,
      "MinValue": 50,
      "MaxValue": 2000
    }
  },
  "Resources": {
    "ProInstance": {
      "Type": "ALIYUN::DDoSPro::ProInstance",
      "Properties": {
        "NormalQps": {
          "Ref": "NormalQps"
        },
        "Period": {
          "Ref": "Period"
        },
        "PortCount": {
          "Ref": "PortCount"
        },
        "Edition": {
          "Ref": "Edition"
        },
        "BurstBandwidthMode": {
          "Ref": "BurstBandwidthMode"
        },
        "ServiceBandwidth": {
          "Ref": "ServiceBandwidth"
        },
        "ServicePartner": {
          "Ref": "ServicePartner"
        },
        "BaseBandwidth": {
          "Ref": "BaseBandwidth"
        },
        "FunctionVersion": {
          "Ref": "FunctionVersion"
        },
        "Bandwidth": {
          "Ref": "Bandwidth"
        },
        "AddressType": {
          "Ref": "AddressType"
        },
        "PeriodUnit": {
          "Ref": "PeriodUnit"
        },
        "DomainCount": {
          "Ref": "DomainCount"
        }
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Description": "The ID of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ProInstance",
          "InstanceId"
        ]
      }
    }
  }
}