资源类型ALIYUN::VPC::IpamScope的语法属性与返回值参考-资源编排-阿里云

ALIYUN::VPC::IpamScope类型用于创建IPAM作用范围。

语法

{
  "Type": "ALIYUN::VPC::IpamScope",
  "Properties": {
    "IpamId": String,
    "IpamScopeName": String,
    "IpamScopeDescription": String,
    "IpamScopeType": String,
    "Tags": List
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
IpamId	String	是	否	IPAM 的实例 ID。	无
IpamScopeName	String	否	是	IPAM 作用范围的名称。	长度为 1～128 个字符，不能以`http://`或`https://`开头。
IpamScopeDescription	String	否	是	IPAM 作用范围的描述信息。	长度为 1～256 个字符，必须以英文大小写字母开头，但不能以`http://`或`https://`开头。不填则为空，默认值为空。
IpamScopeType	String	否	否	IPAM 作用范围类型	取值： private 说明当前只支持创建私网作用范围。
Tags	List	否	是	标签列表信息。	最多支持绑定20组标签，更多信息请参考Tags属性。

Tags语法

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

Tags属性

属性名称

类型

必须

允许更新

描述

约束

Key

String

是

否

资源的标签键。

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

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

Value

String

否

资源的标签值。

最多支持输入 20 个标签值。一旦传入该值，可以为空字符串。

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

返回值

Fn::GetAtt

IpamScopeId：IPAM 作用范围的实例 ID。
IpamScopeName：IPAM 作用范围的名称。.
IpamId：IPAM 的实例 ID。
CreateTime：IPAM 作用范围的创建时间。
IpamScopeDescription：IPAM 作用范围的描述信息。
IpamScopeType：IPAM 作用范围类型
Tags：IPAM 作用范围绑定的标签。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  IpamScopeName:
    Type: String
    Description:
      en: The name of the IPAM scope.
    Required: false
    Default: test_scope
  IpamId:
    Type: String
    Description:
      en: The id of the Ipam instance.
    Required: true
  IpamScopeType:
    Type: String
    Description:
      en: |-
        IPAM scope of action type:
        **private**.

        > Currently, only the role scope of the private network is supported.
    Required: false
    Default: private
Resources:
  ExtensionResource:
    Type: ALIYUN::VPC::IpamScope
    Properties:
      IpamScopeName:
        Ref: IpamScopeName
      IpamId:
        Ref: IpamId
      IpamScopeType:
        Ref: IpamScopeType
Outputs:
  IpamScopeId:
    Description: The ID of the IPAM scope.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamScopeId
  IpamScopeName:
    Description: The name of the IPAM scope.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamScopeName
  IpamId:
    Description: The id of the Ipam instance.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamId
  CreateTime:
    Description: The creation time of the IPAM scope.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  IpamScopeDescription:
    Description: The description of the IPAM's scope of action.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamScopeDescription
  IpamScopeType:
    Description: IPAM scope of action type.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamScopeType
  Tags:
    Description: The tag of the IPAM scope.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Tags

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "IpamScopeName": {
      "Type": "String",
      "Description": {
        "en": "The name of the IPAM scope."
      },
      "Required": false,
      "Default": "test_scope"
    },
    "IpamId": {
      "Type": "String",
      "Description": {
        "en": "The id of the Ipam instance."
      },
      "Required": true
    },
    "IpamScopeType": {
      "Type": "String",
      "Description": {
        "en": "IPAM scope of action type:\n**private**.\n\n> Currently, only the role scope of the private network is supported."
      },
      "Required": false,
      "Default": "private"
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::VPC::IpamScope",
      "Properties": {
        "IpamScopeName": {
          "Ref": "IpamScopeName"
        },
        "IpamId": {
          "Ref": "IpamId"
        },
        "IpamScopeType": {
          "Ref": "IpamScopeType"
        }
      }
    }
  },
  "Outputs": {
    "IpamScopeId": {
      "Description": "The ID of the IPAM scope.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamScopeId"
        ]
      }
    },
    "IpamScopeName": {
      "Description": "The name of the IPAM scope.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamScopeName"
        ]
      }
    },
    "IpamId": {
      "Description": "The id of the Ipam instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the IPAM scope.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "IpamScopeDescription": {
      "Description": "The description of the IPAM's scope of action.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamScopeDescription"
        ]
      }
    },
    "IpamScopeType": {
      "Description": "IPAM scope of action type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamScopeType"
        ]
      }
    },
    "Tags": {
      "Description": "The tag of the IPAM scope.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Tags"
        ]
      }
    }
  }
}