ALIYUN::VPC::PrefixList - Resource Orchestration Service

ALIYUN::VPC::PrefixList is used to create a prefix list.

Syntax

{
  "Type": "ALIYUN::VPC::PrefixList",
  "Properties": {
    "MaxEntries": Integer,
    "PrefixListDescription": String,
    "IpVersion": String,
    "PrefixListName": String,
    "PrefixListEntrys": List
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
MaxEntries	Integer	No	Yes	The maximum number of CIDR blocks that you can specify in the prefix list.	Default value: 50.
PrefixListDescription	String	No	Yes	The description of the prefix list.	The description must be 1 to 256 characters in length. The description cannot start with http:// or https://.
IpVersion	String	No	No	The IP version.	Default value: IPv4. Valid values: IPv4 IPv6
PrefixListName	String	No	Yes	The name of the prefix list.	The name must be 1 to 128 characters in length. The name and cannot start with `http://` or `https://`.
PrefixListEntrys	List	No	Yes	The CIDR blocks that you want to specify in the prefix list.	For more information, see PrefixListEntrys properties.

PrefixListEntrys syntax

"PrefixListEntrys": [
  {
    "Description": String,
    "Cidr": String
  }
]

PrefixListEntrys properties

Property	Type	Required	Editable	Description	Constraint
Description	String	No	Yes	The description of the CIDR block in the prefix list.	The description must be 1 to 256 characters in length. The description cannot start with `http://` or `https://`.
Cidr	String	Yes	Yes	The CIDR block in the prefix list.	None.

Return values

Fn::GetAtt

MaxEntries: the maximum number of CIDR blocks that can be specified in the prefix list.
PrefixListDescription: the description of the prefix list.
IpVersion: the IP version.
PrefixListId: the ID of the prefix list.
PrefixListName: the name of the prefix list.
CreateTime: the time when the prefix list was created.
PrefixListEntrys: the CIDR blocks that are specified in the prefix list.
ShareType: the share type of the prefix list.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionResource:
    Type: ALIYUN::VPC::PrefixList
    Properties:
      MaxEntries: 50
      IpVersion: IPv4
      PrefixListName: TestPrefixListName
      PrefixListEntrys:
        - Description: CIDR
          Cidr: 192.168.0.0/16
Outputs:
  MaxEntries:
    Description: The maximum number of entries for CIDR address blocks in the prefix list.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - MaxEntries
  PrefixListDescription:
    Description: The description of the prefix list.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PrefixListDescription
  IpVersion:
    Description: The IP version of the prefix list.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpVersion
  PrefixListId:
    Description: The ID of the query Prefix List.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PrefixListId
  PrefixListName:
    Description: The name of the prefix list.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PrefixListName
  CreateTime:
    Description: The time when the prefix list was created.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  PrefixListEntrys:
    Description: CIDR address block information of Prefix List.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PrefixListEntrys
  ShareType:
    Description: The share type of the prefix list.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ShareType

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::VPC::PrefixList",
      "Properties": {
        "MaxEntries": 50,
        "IpVersion": "IPv4",
        "PrefixListName": "TestPrefixListName",
        "PrefixListEntrys": [
          {
            "Description": "CIDR",
            "Cidr": "192.168.0.0/16"
          }
        ]
      }
    }
  },
  "Outputs": {
    "MaxEntries": {
      "Description": "The maximum number of entries for CIDR address blocks in the prefix list.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "MaxEntries"
        ]
      }
    },
    "PrefixListDescription": {
      "Description": "The description of the prefix list.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PrefixListDescription"
        ]
      }
    },
    "IpVersion": {
      "Description": "The IP version of the prefix list.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpVersion"
        ]
      }
    },
    "PrefixListId": {
      "Description": "The ID of the query Prefix List.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PrefixListId"
        ]
      }
    },
    "PrefixListName": {
      "Description": "The name of the prefix list.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PrefixListName"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the prefix list was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "PrefixListEntrys": {
      "Description": "CIDR address block information of Prefix List.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PrefixListEntrys"
        ]
      }
    },
    "ShareType": {
      "Description": "The share type of the prefix list.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ShareType"
        ]
      }
    }
  }
}