ALIYUN::VPC::Ipam - 资源编排

ALIYUN::VPC::Ipam类型用于创建一个IPAM实例。

语法

{
  "Type": "ALIYUN::VPC::Ipam",
  "Properties": {
    "OperatingRegionList": List,
    "IpamName": String,
    "IpamDescription": String,
    "ResourceGroupId": String,
    "Tags": List
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
OperatingRegionList	List	是	是	IPAM 生效地域列表。	最多支持配置100个生效地域。
IpamName	String	否	是	IPAM 的名称。	长度为 1～128 个字符，不能以`http://`或`https://`开头。
IpamDescription	String	否	是	IPAM 的描述信息。	长度为 1～256 个字符，必须以大小写字母或中文开头，但不能以`http://`和`https://`开头。描述不填则为空，默认值为空。
ResourceGroupId	String	否	是	IPAM 的资源组 ID。	无
Tags	List	否	是	标签列表信息。	最多支持20组标签，详细信息，请参考Tags属性。

Tags语法

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

Tags属性

属性名称

类型

必须

允许更新

描述

约束

Key

String

是

否

资源的标签键。

一旦传入该值，则不允许为空字符串。

最多支持 64 个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以aliyun和acs:开头，不能包含http://或者https://。

Value

String

否

资源的标签值。

一旦传入该值，可以为空字符串。

最多支持 128 个字符，不能包含http://或者https://。

返回值

Fn::GetAtt

OperatingRegionList：IPAM 生效地域列表。
DefaultResourceDiscoveryAssociationId：默认的资源发现关联关系 ID。
DefaultResourceDiscoveryId：默认资源发现实例 ID。
IpamName：IPAM 的名称。
ResourceGroupId：IPAM 的资源组 ID。
IpamId：IPAM 的实例 ID。
CreateTime：IPAM的创建时间。
IpamDescription：IPAM 的描述信息。
ResourceDiscoveryAssociationCount：资源发现数量。
PrivateDefaultScopeId：创建 IPAM 后，系统默认创建的私网 IPAM 作用范围。
PublicDefaultScopeId：创建 IPAM 后，系统默认创建的公网 IPAM 作用范围。
Tags：IPAM标签信息。

示例

YAML

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

JSON

{
  "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"
        ]
      }
    }
  }
}