ALIYUN::DDoSPro::PremiumInstance - Resource Orchestration Service

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

Syntax

{
  "Type": "ALIYUN::DDoSPro::PremiumInstance",
  "Properties": {
    "NormalQps": Integer,
    "NormalBandwidth": Integer,
    "FunctionVersion": String,
    "ProductPlan": String,
    "Period": Integer,
    "PortCount": Integer,
    "BurstBandwidthMode": 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 500 to 100000.
NormalBandwidth	Integer	No	No	The clean bandwidth.	Unit: Mbit/s. The valid values of NormalBandwidth vary based on the value of ProductPlan: Valid values when ProductPlan is set to 0: 100, 150, 200, 250, and 300. Valid values when ProductPlan is set to 1: 100, 150, 200, 250, and 300. Valid values when ProductPlan is set to 2: 10, 20, 30, 40, 50, 60, 70, 80, 90, and 100.
FunctionVersion	String	No	No	The type of the function plan.	Valid values: 0: Standard. 1: Enhanced.
ProductPlan	String	No	No	The mitigation plan of the instance.	Valid values: 0: Insurance mitigation plan. 1: Unlimited mitigation plan. 2: Chinese Mainland Acceleration (CMA) mitigation plan.
Period	Integer	No	No	The billing cycle.	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: a multiple of 5 that ranges from 5 to 400. Valid values when ProductPlan is set to 1: a 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.
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.
PeriodUnit	String	No	No	The unit of the billing cycle.	Valid values: Month or month Year or year Default value: Month.
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: a multiple of 10 that ranges from 10 to 200. Valid values when ProductPlan is set to 1: a 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 DomainCount.
Tags	List	No	Yes	The tags.	You can add up to 20 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

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  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.

        The value of DomainCount varies based on the value of ProductPlan.

        If you set ProductPlan to 0, you can set DomainCount to a value that ranges
        from 10 to 200. The value must be a multiple of 10.

        If you set ProductPlan to 1, you can set DomainCount to a value that ranges
        from 10 to 200. The value must be a multiple of 10.

        If you set ProductPlan to 2, you do not need to specify this parameter.'
    MaxValue: 200
    MinValue: 10
    Required: false
    Type: Number
  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
  NormalBandwidth:
    Description:
      en: 'The clean bandwidth provided by the instance. Unit: Mbit/s.

        The value of NormalBandwidth varies based on the value of ProductPlan.

        If you set ProductPlan to 0, you can set NormalBandwidth to 100, 150, 200,
        250, or 300.

        If you set ProductPlan to 1, you can set NormalBandwidth to 100, 150, 200,
        250, or 300.

        If you set ProductPlan to 2, you can set NormalBandwidth to 10, 20, 30, 40,
        50, 60, 70, 80, 90, or 100.'
    MaxValue: 300
    MinValue: 10
    Required: false
    Type: Number
  NormalQps:
    Description:
      en: 'The clean QPS provided by the instance.

        The value of NormalQps varies based on the value of ProductPlan.

        If you set ProductPlan to 0, you can set NormalQps to a value that ranges
        from 500 to 100000. The value must be a multiple of 100.

        If you set ProductPlan to 1, you can set NormalQps to a value that ranges
        from 1000 to 100000. The value must be a multiple of 100.

        If you set ProductPlan to 2, you do not need to specify this parameter.'
    MaxValue: 100000
    MinValue: 500
    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.

        The value of PortCount varies based on the value of ProductPlan.

        If you set ProductPlan to 0, you can set PortCount to a value that ranges
        from 5 to 400. The value must be a multiple of 5.

        If you set ProductPlan to 1, you can set PortCount to a value that ranges
        from 5 to 400. The value must be a multiple of 5.

        If you set ProductPlan to 2, you do not need to specify this parameter.'
    MaxValue: 400
    MinValue: 5
    Required: false
    Type: Number
  ProductPlan:
    AllowedValues:
    - '0'
    - '1'
    - '2'
    Description:
      en: 'The mitigation plan of the instance. Valid values:

        0: the Insurance mitigation plan

        1: the Unlimited mitigation plan

        2: the Chinese Mainland Acceleration (CMA) mitigation plan'
    Required: false
    Type: String
Resources:
  PremiumInstance:
    Properties:
      BurstBandwidthMode:
        Ref: BurstBandwidthMode
      DomainCount:
        Ref: DomainCount
      FunctionVersion:
        Ref: FunctionVersion
      NormalBandwidth:
        Ref: NormalBandwidth
      NormalQps:
        Ref: NormalQps
      Period:
        Ref: Period
      PeriodUnit:
        Ref: PeriodUnit
      PortCount:
        Ref: PortCount
      ProductPlan:
        Ref: ProductPlan
    Type: ALIYUN::DDoSPro::PremiumInstance
Outputs:
  InstanceId:
    Description: The ID of the instance.
    Value:
      Fn::GetAtt:
      - PremiumInstance
      - InstanceId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "NormalQps": {
      "Type": "Number",
      "Description": {
        "en": "The clean QPS provided by the instance.\nThe value of NormalQps varies based on the value of ProductPlan.\nIf you set ProductPlan to 0, you can set NormalQps to a value that ranges from 500 to 100000. The value must be a multiple of 100.\nIf you set ProductPlan to 1, you can set NormalQps to a value that ranges from 1000 to 100000. The value must be a multiple of 100.\nIf you set ProductPlan to 2, you do not need to specify this parameter.\nIf you set ProductPlan to 3, you can set NormalQps to a value that ranges from 500 to 100000. The value must be a multiple of 100."
      },
      "Required": false,
      "MinValue": 500,
      "MaxValue": 100000
    },
    "NormalBandwidth": {
      "Type": "Number",
      "Description": {
        "en": "The clean bandwidth provided by the instance. Unit: Mbit/s.\nThe value of NormalBandwidth varies based on the value of ProductPlan.\nIf you set ProductPlan to 0, you can set NormalBandwidth to 100, 150, 200, 250, or 300.\nIf you set ProductPlan to 1, you can set NormalBandwidth to 100, 150, 200, 250, or 300.\nIf you set ProductPlan to 2, you can set NormalBandwidth to 10, 20, 30, 40, 50, 60, 70, 80, 90, or 100.\nIf you set ProductPlan to 3, you can set NormalBandwidth to 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 150, or 200."
      },
      "Required": false,
      "MinValue": 10,
      "MaxValue": 300
    },
    "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
    },
    "ProductPlan": {
      "Type": "String",
      "Description": {
        "en": "The mitigation plan of the instance. Valid values:\n0: the Insurance mitigation plan\n1: the Unlimited mitigation plan\n2: the Chinese Mainland Acceleration (CMA) mitigation plan\n3: the Secure Chinese Mainland Acceleration (Sec-CMA) mitigation plan"
      },
      "AllowedValues": [
        "0",
        "1",
        "2"
      ],
      "Required": false
    },
    "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.\nThe value of PortCount varies based on the value of ProductPlan.\nIf you set ProductPlan to 0, you can set PortCount to a value that ranges from 5 to 400. The value must be a multiple of 5.\nIf you set ProductPlan to 1, you can set PortCount to a value that ranges from 5 to 400. The value must be a multiple of 5.\nIf you set ProductPlan to 2, you do not need to specify this parameter.\nIf you set ProductPlan to 3, you can set PortCount to a value that ranges from 5 to 400. The value must be a multiple of 5."
      },
      "Required": false,
      "MinValue": 5,
      "MaxValue": 400
    },
    "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
    },
    "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.\nThe value of DomainCount varies based on the value of ProductPlan.\nIf you set ProductPlan to 0, you can set DomainCount to a value that ranges from 10 to 200. The value must be a multiple of 10.\nIf you set ProductPlan to 1, you can set DomainCount to a value that ranges from 10 to 200. The value must be a multiple of 10.\nIf you set ProductPlan to 2, you do not need to specify this parameter.\nIf you set ProductPlan to 3, you can set DomainCount to a value that ranges from 10 to 200. The value must be a multiple of 10."
      },
      "Required": false,
      "MinValue": 10,
      "MaxValue": 200
    }
  },
  "Resources": {
    "PremiumInstance": {
      "Type": "ALIYUN::DDoSPro::PremiumInstance",
      "Properties": {
        "NormalQps": {
          "Ref": "NormalQps"
        },
        "NormalBandwidth": {
          "Ref": "NormalBandwidth"
        },
        "FunctionVersion": {
          "Ref": "FunctionVersion"
        },
        "ProductPlan": {
          "Ref": "ProductPlan"
        },
        "Period": {
          "Ref": "Period"
        },
        "PortCount": {
          "Ref": "PortCount"
        },
        "BurstBandwidthMode": {
          "Ref": "BurstBandwidthMode"
        },
        "PeriodUnit": {
          "Ref": "PeriodUnit"
        },
        "DomainCount": {
          "Ref": "DomainCount"
        }
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Description": "The ID of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "PremiumInstance",
          "InstanceId"
        ]
      }
    }
  }
}