ALIYUN::VPC::Ipam is used to create an IP Address Manager (IPAM).
Syntax
{
"Type": "ALIYUN::VPC::Ipam",
"Properties": {
"OperatingRegionList": List,
"IpamName": String,
"IpamDescription": String,
"ResourceGroupId": String,
"Tags": List
}
}Properties
Property | Type | Required | Editable | Description | Constraint |
Property | Type | Required | Editable | Description | Constraint |
OperatingRegionList | List | Yes | Yes | The effective regions of the IPAM. | You can specify up to 100 effective regions. |
IpamName | String | No | Yes | The IPAM name. | The name must be 1 to 128 characters in length. It cannot start with |
IpamDescription | String | No | Yes | The description of the IPAM. | The description must be 1 to 256 characters in length. It must start with a letter and cannot start with |
ResourceGroupId | String | No | Yes | The ID of the resource group to which the IPAM belongs. | None. |
Tags | List | No | Yes | The information about the tags. | You can add up to 20 tags. For more information, see Tags properties. |
Tags syntax
"Tags": [
{
"Value": String,
"Key": String
}
]Tags properties
Property | Type | Required | Editable | Description | Constraint |
Property | Type | Required | Editable | Description | Constraint |
Key | String | Yes | No | The tag key of the IPAM. | The tag key cannot be an empty string. The tag key can be up to 64 characters in length, and contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter and cannot start with |
Value | String | No | No | The tag value of the IPAM. | The tag value can be an empty string. The tag value can be up to 128 characters in length, and cannot contain |
Return values
Fn::GetAtt
OperatingRegionList: the effective regions of the IPAM.
DefaultResourceDiscoveryAssociationId: the ID of the the association between the IPAM and the default resource discovery.
DefaultResourceDiscoveryId: the ID of the default resource discovery.
IpamName: the IPAM name.
ResourceGroupId: the ID of the resource group to which the IPAM belongs.
IpamId: the IPAM ID.
CreateTime: the time when the IPAM was created.
IpamDescription: the description of the IPAM.
ResourceDiscoveryAssociationCount: the number of resource discoveries.
PrivateDefaultScopeId: the private IPAM scope that is created by default after the IPAM is created.
PublicDefaultScopeId: the public IPAM scope that is created by default after the IPAM is created.
Tags: the information about the tags of the IPAM.
Examples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
OperatingRegionList:
AssociationPropertyMetadata:
Parameter:
Type: String
Description:
en: |-
The effective region of IPAM.
> Support to select one or more regions.
Required: false
AssociationProperty: List[Parameter]
Type: Json
Description:
en: List of IPAM effective regions.
Required: true
MinLength: 1
MaxLength: 100
Default:
- cn-hangzhou
- cn-beijing
ResourceGroupId:
AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
Type: String
Description:
en: The ID of the resource group.
Required: false
IpamName:
Type: String
Description:
en: The name of the IPAM.
Required: false
Default: test_ipam
Resources:
ExtensionResource:
Type: ALIYUN::VPC::Ipam
Properties:
OperatingRegionList:
Ref: OperatingRegionList
ResourceGroupId:
Ref: ResourceGroupId
IpamName:
Ref: IpamName
Outputs:
OperatingRegionList:
Description: List of IPAM effective regions.
Value:
Fn::GetAtt:
- ExtensionResource
- OperatingRegionList
DefaultResourceDiscoveryAssociationId:
Description: After an IPAM is created, the association between the resource discovery created by the system by default and the IPAM.
Value:
Fn::GetAtt:
- ExtensionResource
- DefaultResourceDiscoveryAssociationId
DefaultResourceDiscoveryId:
Description: After IPAM is created, the system creates resource discovery by default.
Value:
Fn::GetAtt:
- ExtensionResource
- DefaultResourceDiscoveryId
IpamName:
Description: The name of the IPAM.
Value:
Fn::GetAtt:
- ExtensionResource
- IpamName
ResourceGroupId:
Description: The ID of the resource group.
Value:
Fn::GetAtt:
- ExtensionResource
- ResourceGroupId
IpamId:
Description: The first ID of the resource.
Value:
Fn::GetAtt:
- ExtensionResource
- IpamId
CreateTime:
Description: The creation time of the IPAM.
Value:
Fn::GetAtt:
- ExtensionResource
- CreateTime
IpamDescription:
Description: The description of IPAM.
Value:
Fn::GetAtt:
- ExtensionResource
- IpamDescription
ResourceDiscoveryAssociationCount:
Description: The number of resource discovery objects associated with IPAM.
Value:
Fn::GetAtt:
- ExtensionResource
- ResourceDiscoveryAssociationCount
PrivateDefaultScopeId:
Description: After an IPAM is created, the scope of the private network IPAM created by the system by default.
Value:
Fn::GetAtt:
- ExtensionResource
- PrivateDefaultScopeId
PublicDefaultScopeId:
Description: After an IPAM is created, the public network IPAM is created by default.
Value:
Fn::GetAtt:
- ExtensionResource
- PublicDefaultScopeId
Tags:
Description: The tag of the IPAM.
Value:
Fn::GetAtt:
- ExtensionResource
- Tags
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"OperatingRegionList": {
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Description": {
"en": "The effective region of IPAM.\n> Support to select one or more regions."
},
"Required": false
}
},
"AssociationProperty": "List[Parameter]",
"Type": "Json",
"Description": {
"en": "List of IPAM effective regions."
},
"Required": true,
"MinLength": 1,
"MaxLength": 100,
"Default": [
"cn-hangzhou",
"cn-beijing"
]
},
"ResourceGroupId": {
"AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
"Type": "String",
"Description": {
"en": "The ID of the resource group."
},
"Required": false
},
"IpamName": {
"Type": "String",
"Description": {
"en": "The name of the IPAM."
},
"Required": false,
"Default": "test_ipam"
}
},
"Resources": {
"ExtensionResource": {
"Type": "ALIYUN::VPC::Ipam",
"Properties": {
"OperatingRegionList": {
"Ref": "OperatingRegionList"
},
"ResourceGroupId": {
"Ref": "ResourceGroupId"
},
"IpamName": {
"Ref": "IpamName"
}
}
}
},
"Outputs": {
"OperatingRegionList": {
"Description": "List of IPAM effective regions.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"OperatingRegionList"
]
}
},
"DefaultResourceDiscoveryAssociationId": {
"Description": "After an IPAM is created, the association between the resource discovery created by the system by default and the IPAM.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"DefaultResourceDiscoveryAssociationId"
]
}
},
"DefaultResourceDiscoveryId": {
"Description": "After IPAM is created, the system creates resource discovery by default.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"DefaultResourceDiscoveryId"
]
}
},
"IpamName": {
"Description": "The name of the IPAM.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"IpamName"
]
}
},
"ResourceGroupId": {
"Description": "The ID of the resource group.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"ResourceGroupId"
]
}
},
"IpamId": {
"Description": "The first ID of the resource.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"IpamId"
]
}
},
"CreateTime": {
"Description": "The creation time of the IPAM.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"CreateTime"
]
}
},
"IpamDescription": {
"Description": "The description of IPAM.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"IpamDescription"
]
}
},
"ResourceDiscoveryAssociationCount": {
"Description": "The number of resource discovery objects associated with IPAM.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"ResourceDiscoveryAssociationCount"
]
}
},
"PrivateDefaultScopeId": {
"Description": "After an IPAM is created, the scope of the private network IPAM created by the system by default.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"PrivateDefaultScopeId"
]
}
},
"PublicDefaultScopeId": {
"Description": "After an IPAM is created, the public network IPAM is created by default.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"PublicDefaultScopeId"
]
}
},
"Tags": {
"Description": "The tag of the IPAM.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"Tags"
]
}
}
}
}
