全部产品
Search
文档中心

资源编排:ALIYUN::VPC::IpamPoolAllocation

更新时间:Aug 25, 2026

ALIYUN::VPC::IpamPoolAllocation类型用于从IPAM地址池创建自定义预留网段。

语法

{
  "Type": "ALIYUN::VPC::IpamPoolAllocation",
  "Properties": {
    "IpamPoolId": String,
    "Cidr": String,
    "CidrMask": Integer,
    "IpamPoolAllocationDescription": String,
    "IpamPoolAllocationName": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

IpamPoolId

String

是

否

IPAM 地址池 ID。

无

Cidr

String

否

否

已分配的地址段。

说明

参数 Cidr 或 CidrMask 至少输入一个。

CidrMask

Integer

否

否

通过输入掩码的方式从 IPAM 地址池创建自定义预留网段。

说明

参数 Cidr 或 CidrMask 至少输入一个。

IpamPoolAllocationDescription

String

否

是

IPAM 地址池分配的描述。

长度为 1~256 个字符,必须以英文字母或中文字符开头,不能以 'http://' 或 'https' 开头。若不填写则为空,默认值为空。

IpamPoolAllocationName

String

否

是

IPAM 地址池分配名称.

长度为 1~128 个字符,不能以 'http://' 或 'https' 开头。

返回值

Fn::GetAtt

  • IpamPoolAllocationDescription:IPAM 地址池分配的描述。

  • Cidr:已分配的地址段。

  • SourceCidr:源地址段。

  • IpamPoolId:IPAM 地址池 ID。

  • CreateTime:实例创建时间。

  • ResourceType:资源类型。

  • IpamPoolAllocationId:IPAM 地址池分配的实例 ID。

  • ResourceOwnerId:资源所属阿里云账号(主账号)的 ID。

  • IpamPoolAllocationName:IPAM 地址池分配名称。

示例

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Cidr:
    Description:
      en: The allocated address segment.
    Required: false
    Type: String
  CidrMask:
    Description:
      en: 'Create a custom reserved network segment from The IPAM address pool by
        entering a mask.

        > Enter at least one of **Cidr** or **CidrMask.'
    Required: false
    Type: Number
  IpamPoolAllocationDescription:
    Description:
      en: 'The description of the ipam pool alloctaion.

        It must be 1 to 256 characters in length and must start with an English letter
        or Chinese character, but cannot start with ''http:// ''or ''https. If it
        is not filled in, it is empty. The default value is empty.'
    Required: false
    Type: String
  IpamPoolAllocationName:
    Description:
      en: 'The name of the ipam pool allocation.

        It must be 1 to 128 characters in length and cannot start with ''http:// ''or
        ''https.'
    Required: false
    Type: String
  IpamPoolId:
    Description:
      en: The ID of the IPAM Pool.
    Required: true
    Type: String
Resources:
  ExtensionResource:
    Properties:
      Cidr:
        Ref: Cidr
      CidrMask:
        Ref: CidrMask
      IpamPoolAllocationDescription:
        Ref: IpamPoolAllocationDescription
      IpamPoolAllocationName:
        Ref: IpamPoolAllocationName
      IpamPoolId:
        Ref: IpamPoolId
    Type: ALIYUN::VPC::IpamPoolAllocation
Outputs:
  Cidr:
    Description: The allocated address segment.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Cidr
  CreateTime:
    Description: Instance creation time.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  IpamPoolAllocationDescription:
    Description: The description of the ipam pool alloctaion.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamPoolAllocationDescription
  IpamPoolAllocationId:
    Description: The instance ID of the ipam pool allocation.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamPoolAllocationId
  IpamPoolAllocationName:
    Description: The name of the ipam pool allocation.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamPoolAllocationName
  IpamPoolId:
    Description: The ID of the IPAM Pool.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamPoolId
  ResourceOwnerId:
    Description: The ID of the Alibaba Cloud account (primary account) to which the
      resource belongs.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ResourceOwnerId
  ResourceType:
    Description: The type of resource.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ResourceType
  SourceCidr:
    Description: The source address segment.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SourceCidr
                        
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Cidr": {
      "Type": "String",
      "Description": {
        "en": "The allocated address segment."
      },
      "Required": false
    },
    "IpamPoolAllocationDescription": {
      "Type": "String",
      "Description": {
        "en": "The description of the ipam pool alloctaion.\nIt must be 1 to 256 characters in length and must start with an English letter or Chinese character, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty."
      },
      "Required": false
    },
    "IpamPoolId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the IPAM Pool."
      },
      "Required": true
    },
    "CidrMask": {
      "Type": "Number",
      "Description": {
        "en": "Create a custom reserved network segment from The IPAM address pool by entering a mask.\n> Enter at least one of **Cidr** or **CidrMask."
      },
      "Required": false
    },
    "IpamPoolAllocationName": {
      "Type": "String",
      "Description": {
        "en": "The name of the ipam pool allocation.\nIt must be 1 to 128 characters in length and cannot start with 'http:// 'or 'https."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::VPC::IpamPoolAllocation",
      "Properties": {
        "Cidr": {
          "Ref": "Cidr"
        },
        "IpamPoolAllocationDescription": {
          "Ref": "IpamPoolAllocationDescription"
        },
        "IpamPoolId": {
          "Ref": "IpamPoolId"
        },
        "CidrMask": {
          "Ref": "CidrMask"
        },
        "IpamPoolAllocationName": {
          "Ref": "IpamPoolAllocationName"
        }
      }
    }
  },
  "Outputs": {
    "IpamPoolAllocationDescription": {
      "Description": "The description of the ipam pool alloctaion.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamPoolAllocationDescription"
        ]
      }
    },
    "Cidr": {
      "Description": "The allocated address segment.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Cidr"
        ]
      }
    },
    "SourceCidr": {
      "Description": "The source address segment.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SourceCidr"
        ]
      }
    },
    "IpamPoolId": {
      "Description": "The ID of the IPAM Pool.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamPoolId"
        ]
      }
    },
    "CreateTime": {
      "Description": "Instance creation time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "ResourceType": {
      "Description": "The type of resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceType"
        ]
      }
    },
    "IpamPoolAllocationId": {
      "Description": "The instance ID of the ipam pool allocation.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamPoolAllocationId"
        ]
      }
    },
    "ResourceOwnerId": {
      "Description": "The ID of the Alibaba Cloud account (primary account) to which the resource belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceOwnerId"
        ]
      }
    },
    "IpamPoolAllocationName": {
      "Description": "The name of the ipam pool allocation.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamPoolAllocationName"
        ]
      }
    }
  }
}