ALIYUN::VPC::PublicIpAddressPool - Resource Orchestration Service

ALIYUN::VPC::PublicIpAddressPool is used to create an IP address pool.

Syntax

{
  "Type": "ALIYUN::VPC::PublicIpAddressPool",
  "Properties": {
    "BizType": String,
    "Description": String,
    "Isp": String,
    "Name": String,
    "ResourceGroupId": String,
    "SecurityProtectionTypes": List,
    "Tags": List,
    "Zones": List
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
BizType	String	No	No	The service type of the IP address pool.	Valid values: CloudBox: cloud box type. Only cloud box users can use this value. Default (default): general service type.
Description	String	No	Yes	The description of the IP address pool.	The description can be up to 256 characters in length, and cannot start with `http://` or `https://`.
Isp	String	No	No	The line type.	Valid values when your account is included in the multi-ISP bandwidth whitelist: BGP (default): BGP (Multi-ISP). BGP_PRO: BGP (Multi-ISP) Pro. For more information about BGP (Multi-ISP) and BGP (Multi-ISP) Pro, see What is an EIP? Valid values when your account is included in the single-ISP bandwidth whitelist: ChinaTelecom: China Telecom. ChinaUnicom: China Unicom. ChinaMobile: China Mobile. ChinaTelecom_L2: China Telecom L2. ChinaUnicom_L2: China Unicom L2. ChinaMobile_L2: China Mobile L2. Valid value when your services are deployed in China East 1 Finance: BGP_FinanceCloud. This property must be specified when your services are deployed in China East 1 Finance.
Name	String	No	Yes	The name of the IP address pool.	None.
ResourceGroupId	String	No	Yes	The ID of the resource group to which the IP address pool belongs.	None.
SecurityProtectionTypes	List	No	No	The editions of Anti-DDoS.	If you leave this property empty, Anti-DDoS Origin Basic is used. If you specify AntiDDoS_Enhanced as the value of this property, Anti-DDoS Proxy is used.
Tags	List	No	No	The tags that you want to add to the IP address pool.	For more information, see Tags properties.
Zones	List	No	No	The zone of the IP address pool.	This property must be specified when BizType is set to CloudBox. You can specify only one zone.

Tags syntax

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

Tags properties

Property	Type	Required	Editable	Description	Constraint
Key	String	Yes	No	The key of the tag.	The key must be 1 to 128 characters in length, and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`.
Value	String	No	No	The value of the tag.	The value can be up to 128 characters in length, and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`.

Return values

Fn::GetAtt

PublicIpAddressPoolId: the ID of the IP address pool.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Isp:
    Type: String
    Description:
      en: |-
        The line type. Valid values:
        BGP (default): BGP (Multi-ISP) lines. All regions support BGP (Multi-ISP) EIPs.
        BGP_PRO: BGP (Multi-ISP) Pro lines. 
        Only the following regions support BGP (Multi-ISP) Pro lines: 
        China (Hong Kong), Singapore, Malaysia (Kuala Lumpur), Philippines (Manila), Indonesia (Jakarta), and Thailand (Bangkok).
        For more information about BGP (Multi-ISP) and BGP (Multi-ISP) Pro, see EIP line types.
        If you are allowed to use single-ISP bandwidth, you can also choose one of the following values:
        ChinaTelecom: China Telecom
        ChinaUnicom: China Unicom
        ChinaMobile: China Mobile
        ChinaTelecom_L2: China Telecom L2
        ChinaUnicom_L2: China Unicom L2
        ChinaMobile_L2: China Mobile L2
        If your services are deployed in China East 1 Finance, you must set this parameter to BGP_FinanceCloud.
    AllowedValues:
      - BGP
      - BGP_PRO
      - RunShellScript
      - ChinaTelecom
      - ChinaUnicom
      - ChinaMobile
      - ChinaTelecom_L2
      - ChinaUnicom_L2
      - ChinaMobile_L2
      - BGP_FinanceCloud
    Required: false
  SecurityProtectionTypes:
    AssociationPropertyMetadata:
      Parameter:
        Type: String
        AllowedValues:
          - AntiDDoS_Enhanced
        Required: false
    AssociationProperty: List[Parameter]
    Type: Json
    Description:
      en: |-
        Safety protection level.
        When configured as empty, the default is DDOS protection (basic version).
        When configured as Antiddos_enhanced, it means DDOS protection (enhanced version).
    Required: false
    MinLength: 1
    MaxLength: 100
  BizType:
    Type: String
    Description:
      en: |-
        The business type of IP address pool.Value:
        Cloudbox: Cloud Box.Cloud box users support to select this type.
        Default (default): default, indicating non -special types.
    AllowedValues:
      - CloudBox
    Required: false
  Name:
    Type: String
    Description:
      en: |-
        The name of the address pool instance.
        The length is 0-128 characters, and you cannot start with http: // or https: //.
    Required: false
Resources:
  PublicIpAddressPool:
    Type: ALIYUN::VPC::PublicIpAddressPool
    Properties:
      Isp:
        Ref: Isp
      SecurityProtectionTypes:
        Ref: SecurityProtectionTypes
      BizType:
        Ref: BizType
      Name:
        Ref: Name
Outputs:
  PublicIpAddressPoolId:
    Description: Example ID of the IP address pool.
    Value:
      Fn::GetAtt:
        - PublicIpAddressPool
        - PublicIpAddressPoolId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Isp": {
      "Type": "String",
      "Description": {
        "en": "The line type. Valid values:\nBGP (default): BGP (Multi-ISP) lines. All regions support BGP (Multi-ISP) EIPs.\nBGP_PRO: BGP (Multi-ISP) Pro lines. \nOnly the following regions support BGP (Multi-ISP) Pro lines: \nChina (Hong Kong(China)), Singapore, Malaysia (Kuala Lumpur), Philippines (Manila), Indonesia (Jakarta), and Thailand (Bangkok).\nFor more information about BGP (Multi-ISP) and BGP (Multi-ISP) Pro, see EIP line types.\nIf you are allowed to use single-ISP bandwidth, you can also choose one of the following values:\nChinaTelecom: China Telecom\nChinaUnicom: China Unicom\nChinaMobile: China Mobile\nChinaTelecom_L2: China Telecom L2\nChinaUnicom_L2: China Unicom L2\nChinaMobile_L2: China Mobile L2\nIf your services are deployed in China East 1 Finance, you must set this parameter to BGP_FinanceCloud."
      },
      "AllowedValues": [
        "BGP",
        "BGP_PRO",
        "RunShellScript",
        "ChinaTelecom",
        "ChinaUnicom",
        "ChinaMobile",
        "ChinaTelecom_L2",
        "ChinaUnicom_L2",
        "ChinaMobile_L2",
        "BGP_FinanceCloud"
      ],
      "Required": false
    },
    "SecurityProtectionTypes": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "AllowedValues": [
            "AntiDDoS_Enhanced"
          ],
          "Required": false
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "en": "Safety protection level.\nWhen configured as empty, the default is DDOS protection (basic version).\nWhen configured as Antiddos_enhanced, it means DDOS protection (enhanced version)."
      },
      "Required": false,
      "MinLength": 1,
      "MaxLength": 100
    },
    "BizType": {
      "Type": "String",
      "Description": {
        "en": "The business type of IP address pool.Value:\nCloudbox: Cloud Box.Cloud box users support to select this type.\nDefault (default): default, indicating non -special types."
      },
      "AllowedValues": [
        "CloudBox"
      ],
      "Required": false
    },
    "Name": {
      "Type": "String",
      "Description": {
        "en": "The name of the address pool instance.\nThe length is 0-128 characters, and you cannot start with http: // or https: //."
      },
      "Required": false
    }
  },
  "Resources": {
    "PublicIpAddressPool": {
      "Type": "ALIYUN::VPC::PublicIpAddressPool",
      "Properties": {
        "Isp": {
          "Ref": "Isp"
        },
        "SecurityProtectionTypes": {
          "Ref": "SecurityProtectionTypes"
        },
        "BizType": {
          "Ref": "BizType"
        },
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Outputs": {
    "PublicIpAddressPoolId": {
      "Description": "Example ID of the IP address pool.",
      "Value": {
        "Fn::GetAtt": [
          "PublicIpAddressPool",
          "PublicIpAddressPoolId"
        ]
      }
    }
  }
}