ALIYUN::VPC::IpamScope リソースタイプ - ROS

ALIYUN::VPC::IpamScope は、IP アドレスマネージャー（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 に設定します。説明プライベート IPAM スコープのみを作成できます。
Tags	List	いいえ	はい	タグに関する情報。	最大 20 個のタグを追加できます。詳細については、「タグのプロパティ」をご参照ください。

タグの構文

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

タグのプロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

Key

String

はい

いいえ

IPAM スコープのタグキー。

タグキーを空の文字列にすることはできません。

タグキーは最大 64 文字の長さにすることができます。文字で始まり、数字、ピリオド（.）、アンダースコア（_）、ハイフン（-）を含めることができます。aliyun または acs: で始めることはできず、http:// または https:// を含めることはできません。

Value

String

いいえ

IPAM スコープのタグ値。

最大 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:
      ja: IPAM スコープの名前。
    Required: false
    Default: test_scope
  IpamId:
    Type: String
    Description:
      ja: Ipam インスタンスの ID。
    Required: true
  IpamScopeType:
    Type: String
    Description:
      ja: |-
        IPAM スコープの操作タイプ:
        **private**.

        > 現在、プライベートネットワークのロールスコープのみがサポートされています。
    Required: false
    Default: private
Resources:
  ExtensionResource:
    Type: ALIYUN::VPC::IpamScope
    Properties:
      IpamScopeName:
        Ref: IpamScopeName
      IpamId:
        Ref: IpamId
      IpamScopeType:
        Ref: IpamScopeType
Outputs:
  IpamScopeId:
    Description: IPAM スコープの ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamScopeId
  IpamScopeName:
    Description: IPAM スコープの名前。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamScopeName
  IpamId:
    Description: Ipam インスタンスの ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamId
  CreateTime:
    Description: IPAM スコープの作成時間。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  IpamScopeDescription:
    Description: IPAM の操作スコープの説明。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamScopeDescription
  IpamScopeType:
    Description: IPAM スコープの操作タイプ。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamScopeType
  Tags:
    Description: IPAM スコープのタグ。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Tags

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "IpamScopeName": {
      "Type": "String",
      "Description": {
        "ja": "IPAM スコープの名前。"
      },
      "Required": false,
      "Default": "test_scope"
    },
    "IpamId": {
      "Type": "String",
      "Description": {
        "ja": "Ipam インスタンスの ID。"
      },
      "Required": true
    },
    "IpamScopeType": {
      "Type": "String",
      "Description": {
        "ja": "IPAM スコープの操作タイプ:\n**private**。\n\n> 現在、プライベートネットワークのロールスコープのみがサポートされています。"
      },
      "Required": false,
      "Default": "private"
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::VPC::IpamScope",
      "Properties": {
        "IpamScopeName": {
          "Ref": "IpamScopeName"
        },
        "IpamId": {
          "Ref": "IpamId"
        },
        "IpamScopeType": {
          "Ref": "IpamScopeType"
        }
      }
    }
  },
  "Outputs": {
    "IpamScopeId": {
      "Description": "IPAM スコープの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamScopeId"
        ]
      }
    },
    "IpamScopeName": {
      "Description": "IPAM スコープの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamScopeName"
        ]
      }
    },
    "IpamId": {
      "Description": "Ipam インスタンスの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamId"
        ]
      }
    },
    "CreateTime": {
      "Description": "IPAM スコープの作成時間。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "IpamScopeDescription": {
      "Description": "IPAM の操作スコープの説明。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamScopeDescription"
        ]
      }
    },
    "IpamScopeType": {
      "Description": "IPAM スコープの操作タイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamScopeType"
        ]
      }
    },
    "Tags": {
      "Description": "IPAM スコープのタグ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Tags"
        ]
      }
    }
  }
}