すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:ALIYUN::VPC::RouterInterface

最終更新日:Jan 16, 2025

ALIYUN::VPC::RouterInterface は、ルーターインターフェイスを作成するために使用されます。

構文

{
  "Type": "ALIYUN::VPC::RouterInterface",
  "Properties": {
    "OppositeRegionId": String,
    "Description": String,
    "HealthCheckSourceIp": String,
    "RouterType": String,
    "AccessPointId": String,
    "RouterId": String,
    "Role": String,
    "OppositeInterfaceOwnerId": String,
    "OppositeAccessPointId": String,
    "OppositeInterfaceId": String,
    "HealthCheckTargetIp": String,
    "OppositeRouterId": String,
    "Spec": String,
    "OppositeRouterType": String,
    "Name": String,
    "PricingCycle": String, 
    "Period": Number, 
    "AutoPay": Boolean, 
    "InstanceChargeType": String
  }
}

プロパティ

プロパティタイプ必須編集可能説明制約
RouterIdStringはいいいえルーターインターフェイスが属するルーターのID。なし
RoleStringはいいいえルーターインターフェイスのロール。ルーターインターフェイスは、接続イニシエーターまたは接続アクセプターのいずれかになります。有効な値:
  • InitiatingSide

    RouterType パラメーターが VBR に設定されている場合、このパラメーターは InitiatingSide に設定する必要があります。

  • AcceptingSide

    OppositeRouterType パラメーターが VBR に設定されている場合、このパラメーターは AcceptingSide に設定する必要があります。

RouterTypeStringいいえいいえルーターインターフェイスが属するルーターのタイプ。有効な値:
  • VRouter: VPCルーター
  • VBR: 仮想ボーダールーター
AccessPointIdStringいいえいいえルーターインターフェイスのアクセスポイントのID。RouterType パラメーターが VBR に設定されている場合、このパラメーターは必須です。アクセスポイント ID は、ルーターインターフェイスの作成後に変更することはできません。 RouterType パラメーターが VRouter に設定されている場合、このパラメーターを設定することはできません。
SpecStringいいえいいえ

ルーターインターフェイスの仕様。

以下のリストには、使用可能な仕様と対応する帯域幅の値が含まれています:
  • Mini.2: 2 Mbit/s
  • Mini.5: 5 Mbit/s
  • Small.1: 10 Mbit/s
  • Small.2: 20 Mbit/s
  • Small.5: 50 Mbit/s
  • Middle.1: 100 Mbit/s
  • Middle.2: 200 Mbit/s
  • Middle.5: 500 Mbit/s
  • Large.1: 1,000 Mbit/s
  • Large.2: 2,000 Mbit/s
  • Large.5: 5,000 Mbit/s
  • Xlarge.1: 10,000 Mbit/s

Role パラメーターが InitiatingSide に設定されている場合、このパラメーターは必須です。

Role パラメーターが AcceptingSide に設定されている場合、デフォルトで値 Negative が使用されます。

OppositeRegionIdStringいいえいいえピアルーターインターフェイスのリージョン ID。なし
OppositeInterfaceOwnerIdStringいいえはいピアルーターインターフェイスの所有者のID。デフォルト値は現在のユーザーのIDです。
OppositeInterfaceIdStringいいえはいピアルーターインターフェイスのID。なし
OppositeRouterIdStringいいえはいピアルーターインターフェイスが属するルーターのID。なし
OppositeRouterTypeStringいいえはいピアルーターインターフェイスが属するルーターのタイプ。有効な値:
  • VRouter: VPCルーター

    RouterType パラメーターが VBR に設定されている場合、このパラメーターは VRouter に設定する必要があります。

  • VBR: 仮想ボーダールーター
OppositeAccessPointIdStringいいえいいえピアルーターインターフェイスのアクセスポイントのID。OppositeRouterType パラメーターが VBR に設定されている場合、このパラメーターは必須です。アクセスポイント ID は、ルーターインターフェイスの作成後に変更することはできません。

OppositeRouterType パラメーターが VRouter に設定されている場合、このパラメーターを設定することはできません。

説明 OppositeRouterType パラメーターが VBR に設定されている場合、OppositeRouterId パラメーターで指定された VBR は、OppositeAccessPointId パラメーターで指定されたアクセスポイント内にある必要があります。
DescriptionStringいいえはいルーターインターフェイスの説明。説明は 2 ~ 256 文字である必要があります。http:// または https:// で始めることはできません。

このパラメーターはデフォルトでは空です。

NameStringいいえはいルーターインターフェイスの表示名。名前は 2 ~ 128 文字である必要があります。名前は文字で始まり、http:// または https:// で始めることはできません。文字、数字、ピリオド(.)、アンダースコア(_) 、およびハイフン(-) を含めることができます。
HealthCheckSourceIpStringいいえいいえ専用線障害復旧および ECMP シナリオで使用されるヘルスチェックパケットの送信元 IP アドレス。このパラメーターは、VBR 上にピアルーターインターフェイスを持つ VRouter インターフェイスに対してのみ有効です。ローカル VRouter が配置されている VPC 内の未使用の IP アドレスである必要があります。 HealthCheckSourceIp パラメーターと HealthCheckTargetIp パラメーターは、両方を指定するか、両方を指定しないかのいずれかです。
HealthCheckTargetIpStringいいえいいえ専用線障害復旧および ECMP シナリオで使用されるヘルスチェックパケットの宛先 IP アドレス。このパラメーターは、VBR 上にピアルーターインターフェイスを持つ VRouter インターフェイスに対してのみ有効です。通常、専用線のユーザー側にある顧客構内設備 (CPE) の IP アドレスを使用できます。これは、ピアルーターインターフェイスが配置されている VBR 上のピアゲートウェイの IP アドレスです。専用線のユーザー側にある別の IP アドレスを宛先 IP アドレスとして指定することもできます。 HealthCheckSourceIp パラメーターと HealthCheckTargetIp パラメーターは、両方を指定するか、両方を指定しないかのいずれかです。
PricingCycleStringいいえいいえサブスクリプションの請求サイクル。有効な値:
  • Month
  • Year
PeriodNumberいいえいいえサブスクリプション期間。有効な値:
  • PricingCycle パラメーターが Month に設定されている場合の有効な値:1 ~ 9。
  • PricingCycle パラメーターが Year に設定されている場合の有効な値:1 ~ 3。
AutoPayBooleanいいえいいえ自動支払いを有効にするかどうかを指定します。デフォルト値:true。有効な値:
  • true
  • false
InstanceChargeTypeStringいいえいいえルーターインターフェイスの課金方法。有効な値:
  • Postpaid: 従量課金制
  • Prepaid: サブスクリプション

レスポンスパラメーター

Fn::GetAtt

RouterInterfaceId: ルーターインターフェイスの ID。

  • YAML 形式

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      OppositeInterfaceId:
        Type: String
        Description: The ID of the peer router interface. //ピアルーターインターフェイスのID。
      RouterId:
        Type: String
        Description: The router ID to create RouterInterface. //RouterInterface を作成するためのルーターID。
      OppositeRouterId:
        Type: String
        Description: The router ID of the connection peer RouterInterface. //接続ピア RouterInterface のルーターID。
    Resources:
      RouterInterface:
        Type: ALIYUN::VPC::RouterInterface
        Properties:
          OppositeInterfaceId:
            Ref: OppositeInterfaceId
          OppositeRouterId:
            Ref: OppositeRouterId
          OppositeInterfaceOwnerId:
            Ref: ALIYUN::TenantId
          OppositeRouterType: VRouter
          Description: Initiating Side //開始側
          RouterType: VRouter
          RouterId:
            Ref: RouterId
          Role: InitiatingSide
          Spec: Mini.2
          InstanceChargeType: PostPaid
    Outputs:
      RouterInterfaceId:
        Description: The ID of created RouterInterface. //作成された RouterInterface のID。
        Value:
          Fn::GetAtt:
            - RouterInterface
            - RouterInterfaceId
  • JSON 形式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "OppositeInterfaceId": {
          "Type": "String",
          "Description": "The ID of the peer router interface." //ピアルーターインターフェイスのID。
        },
        "RouterId": {
          "Type": "String",
          "Description": "The router ID to create RouterInterface." //RouterInterface を作成するためのルーターID。
        },
        "OppositeRouterId": {
          "Type": "String",
          "Description": "The router ID of the connection peer RouterInterface." //接続ピア RouterInterface のルーターID。
        }
      },
      "Resources": {
        "RouterInterface": {
          "Type": "ALIYUN::VPC::RouterInterface",
          "Properties": {
            "OppositeInterfaceId": {
              "Ref": "OppositeInterfaceId"
            },
            "OppositeRouterId": {
              "Ref": "OppositeRouterId"
            },
            "OppositeInterfaceOwnerId": {
              "Ref": "ALIYUN::TenantId"
            },
            "OppositeRouterType": "VRouter",
            "Description": "Initiating Side", //開始側
            "RouterType": "VRouter",
            "RouterId": {
              "Ref": "RouterId"
            },
            "Role": "InitiatingSide",
            "Spec": "Mini.2",
            "InstanceChargeType": "PostPaid"
          }
        }
      },
      "Outputs": {
        "RouterInterfaceId": {
          "Description": "The ID of created RouterInterface.", //作成された RouterInterface のID。
          "Value": {
            "Fn::GetAtt": [
              "RouterInterface",
              "RouterInterfaceId"
            ]
          }
        }
      }
    }