ALIYUN::VPC::IpamScope - Resource Orchestration Service

ALIYUN::VPC::IpamScope is used to create an IP Address Manager (IPAM) scope.

Syntax

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

Properties

Property	Type	Required	Editable	Description	Constraint
IpamId	String	Yes	No	The IPAM ID.	None.
IpamScopeName	String	No	Yes	The name of the IPAM scope.	The name must be 1 to 128 characters in length. It cannot start with `http://` or `https://`.
IpamScopeDescription	String	No	Yes	The description of the IPAM scope.	The description must be 1 to 256 characters in length. It must start with a letter and cannot start with `http://` or `https://`. By default, this property is empty.
IpamScopeType	String	No	No	The type of the IPAM scope.	Set the value to private. Note You can create only private IPAM scopes.
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

Key

String

Yes

The tag key of the IPAM scope.

The tag key cannot be an empty string.

The tag key can be up to 64 characters in length. It must start with a letter and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with aliyun or acs: and cannot contain http:// or https://.

Value

String

The tag value of the IPAM scope.

You can specify up to 20 tag values. The tag value can be an empty string.

The tag value can be up to 128 characters in length and cannot contain http:// or https://.

Return values

Fn::GetAtt

IpamScopeId: the ID of the IPAM scope.
IpamScopeName: the name of the IPAM scope.
IpamId: the IPAM ID.
CreateTime: the creation time of the IPAM scope.
IpamScopeDescription: the description of the IPAM scope.
IpamScopeType: the type of the IPAM scope.
Tags: the tags that are added to the IPAM scope.

Examples

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