ALIYUN::VPC::IpamPool - Resource Orchestration Service - Alibaba Cloud Documentation Center

The ALIYUN::VPC::IpamPool resource creates an IPAM pool.

Syntax

{
  "Type": "ALIYUN::VPC::IpamPool",
  "Properties": {
    "IpamScopeId": String,
    "AllocationDefaultCidrMask": Integer,
    "AllocationMinCidrMask": Integer,
    "AutoImport": Boolean,
    "AllocationMaxCidrMask": Integer,
    "Ipv6Isp": String,
    "IpamPoolName": String,
    "IpVersion": String,
    "IpamPoolDescription": String,
    "PoolRegionId": String,
    "ResourceGroupId": String,
    "SourceIpamPoolId": String,
    "Tags": List
  }
}

Properties

Property Name	Type	Required	Update allowed	Description	Constraint
IpamScopeId	String	Yes	No	The ID of the IPAM scope.	None
AllocationDefaultCidrMask	Integer	No	Yes	The default CIDR mask for allocation.	None
AllocationMaxCidrMask	Integer	No	Yes	The maximum CIDR mask for allocation.	None
AllocationMinCidrMask	Integer	No	Yes	The minimum CIDR mask for allocation.	None
AutoImport	Boolean	No	Yes	Whether to auto import the IP address management pool.	None
Ipv6Isp	String	No	No	The IPv6 ISP of the IPAM pool.	None
IpamPoolDescription	String	No	Yes	The description of the IPAM pool.	None
IpamPoolName	String	No	Yes	The name of the IPAM pool.	None
IpVersion	String	No	No	The IP version of the IPAM pool.	Valid values: IPv4 IPv6
PoolRegionId	String	No	No	The region where the IPAM pool takes effect.	None
ResourceGroupId	String	No	Yes	The resource group ID of the IPAM pool.	None
SourceIpamPoolId	String	No	No	The ID of the source IPAM pool.	None
Tags	List	No	Yes	The custom tags attached to the IPAM pool.	For more information, see Tags properties.

Tags syntax

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

Tags properties

Property Name	Type	Required	Update allowed	Description	Constraint
Key	String	Yes	Yes	The tag key.	None
Value	String	Yes	Yes	The tag value.	None

Return values

Fn::GetAtt

IpamPoolId: The ID of the IPAM pool.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  IpamPoolName:
    Type: String
    Description:
      en: The name of the IPAM pool.
    Required: false
  IpVersion:
    Type: String
    Description:
      en: 'The IP version of the IPAM pool. Valid values: IPv4, IPv6.'
    Required: false
  AllocationDefaultCidrMask:
    Type: Number
    Description:
      en: The default CIDR mask for allocation.
    Required: false
    MinValue: 0
    MaxValue: 128
  IpamScopeId:
    Type: String
    Description:
      en: The ID of the IPAM scope. This parameter is required.
    Required: true
Resources:
  IpamPool:
    Type: ALIYUN::VPC::IpamPool
    Properties:
      IpamPoolName:
        Ref: IpamPoolName
      IpVersion:
        Ref: IpVersion
      AllocationDefaultCidrMask:
        Ref: AllocationDefaultCidrMask
      IpamScopeId:
        Ref: IpamScopeId
Outputs:
  IpamPoolId:
    Description: The ID of the IPAM pool.
    Value:
      Fn::GetAtt:
        - IpamPool
        - IpamPoolId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "IpamPoolName": {
      "Type": "String",
      "Description": {
        "en": "The name of the IPAM pool."
      },
      "Required": false
    },
    "IpVersion": {
      "Type": "String",
      "Description": {
        "en": "The IP version of the IPAM pool. Valid values: IPv4, IPv6."
      },
      "Required": false
    },
    "AllocationDefaultCidrMask": {
      "Type": "Number",
      "Description": {
        "en": "The default CIDR mask for allocation."
      },
      "Required": false,
      "MinValue": 0,
      "MaxValue": 128
    },
    "IpamScopeId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the IPAM scope. This parameter is required."
      },
      "Required": true
    }
  },
  "Resources": {
    "IpamPool": {
      "Type": "ALIYUN::VPC::IpamPool",
      "Properties": {
        "IpamPoolName": {
          "Ref": "IpamPoolName"
        },
        "IpVersion": {
          "Ref": "IpVersion"
        },
        "AllocationDefaultCidrMask": {
          "Ref": "AllocationDefaultCidrMask"
        },
        "IpamScopeId": {
          "Ref": "IpamScopeId"
        }
      }
    }
  },
  "Outputs": {
    "IpamPoolId": {
      "Description": "The ID of the IPAM pool.",
      "Value": {
        "Fn::GetAtt": [
          "IpamPool",
          "IpamPoolId"
        ]
      }
    }
  }
}