ALIYUN::VPC::IpamPoolAllocation - Resource Orchestration Service

Syntax

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

Properties

Parameter	Type	Required	Update allowed	Description	Constraint
IpamPoolId	String	Yes	No	The ID of the IPAM pool.	None
Cidr	String	No	No	The allocated CIDR block.	Note You must specify at least one of `Cidr` or `CidrMask`.
CidrMask	Integer	No	No	The mask length of the CIDR block to allocate from the IPAM pool.	Note You must specify at least one of `Cidr` or `CidrMask`.
IpamPoolAllocationDescription	String	No	Yes	The description of the IPAM pool allocation.	The description must be 1 to 256 characters long. It must start with a letter or a Chinese character and cannot start with `http://` or `https://`. If unspecified, this value defaults to an empty string.
IpamPoolAllocationName	String	No	Yes	The name of the IPAM pool allocation.	The name must be 1 to 128 characters long and cannot start with `http://` or `https://`.

Return values

Fn::GetAtt

IpamPoolAllocationDescription: The description of the IPAM pool allocation.
Cidr: The allocated CIDR block.
SourceCidr: The source CIDR block.
IpamPoolId: The ID of the IPAM pool.
CreateTime: The time when the instance was created.
ResourceType: The resource type.
IpamPoolAllocationId: The ID of the IPAM pool allocation.
ResourceOwnerId: The ID of the Alibaba Cloud account (primary account) that owns the resource.
IpamPoolAllocationName: The name of the IPAM pool allocation.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Cidr:
    Description:
      en: The allocated CIDR block.
    Required: false
    Type: String
  CidrMask:
    Description:
      en: 'The mask length of the CIDR block to allocate from the IPAM pool.

        > You must specify at least one of **Cidr** or **CidrMask**.'
    Required: false
    Type: Number
  IpamPoolAllocationDescription:
    Description:
      en: 'The description of the IPAM pool allocation. It must be 1 to 256 characters
        in length and start with a letter or a Chinese character, but cannot start
        with http:// or https://. If this parameter is not specified, the value is an
        empty string.'
    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 CIDR block.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Cidr
  CreateTime:
    Description: The time when the instance was created.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  IpamPoolAllocationDescription:
    Description: The description of the IPAM pool allocation.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamPoolAllocationDescription
  IpamPoolAllocationId:
    Description: The 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) that owns the
      resource.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ResourceOwnerId
  ResourceType:
    Description: The resource type.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ResourceType
  SourceCidr:
    Description: The source CIDR block.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SourceCidr

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Cidr": {
      "Type": "String",
      "Description": {
        "en": "The allocated CIDR block."
      },
      "Required": false
    },
    "IpamPoolAllocationDescription": {
      "Type": "String",
      "Description": {
        "en": "The description of the IPAM pool allocation. It must be 1 to 256 characters in length and start with a letter or a Chinese character, but cannot start with http:// or https://. If this parameter is not specified, the value is an empty string."
      },
      "Required": false
    },
    "IpamPoolId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the IPAM pool."
      },
      "Required": true
    },
    "CidrMask": {
      "Type": "Number",
      "Description": {
        "en": "The mask length of the CIDR block to allocate from the IPAM pool.\n> You must specify at least one of **Cidr** or **CidrMask**."
      },
      "Required": false
    },
    "IpamPoolAllocationName": {
      "Type": "String",
      "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
    }
  },
  "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 allocation.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamPoolAllocationDescription"
        ]
      }
    },
    "Cidr": {
      "Description": "The allocated CIDR block.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Cidr"
        ]
      }
    },
    "SourceCidr": {
      "Description": "The source CIDR block.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SourceCidr"
        ]
      }
    },
    "IpamPoolId": {
      "Description": "The ID of the IPAM pool.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamPoolId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the instance was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "ResourceType": {
      "Description": "The resource type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceType"
        ]
      }
    },
    "IpamPoolAllocationId": {
      "Description": "The ID of the IPAM pool allocation.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamPoolAllocationId"
        ]
      }
    },
    "ResourceOwnerId": {
      "Description": "The ID of the Alibaba Cloud account (primary account) that owns the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceOwnerId"
        ]
      }
    },
    "IpamPoolAllocationName": {
      "Description": "The name of the IPAM pool allocation.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamPoolAllocationName"
        ]
      }
    }
  }
}