ENI を作成するための呼び出しで ALIYUN::ECS::NetworkInterface を使用する - Resource Orchestration Service

ALIYUN::ECS::NetworkInterface は、Elastic Network Interface (ENI) を作成するために使用されます。

構文

{
  "Type": "ALIYUN::ECS::NetworkInterface",
  "Properties": {
    "Description": String,
    "SecurityGroupId": String,
    "PrimaryIpAddress": String,
    "ResourceGroupId": String,
    "VSwitchId": String,
    "NetworkInterfaceName": String,
    "Tags": List,
    "SecurityGroupIds": List,
    "PrivateIpAddresses": List,
    "SecondaryPrivateIpAddressCount": Integer,
    "Ipv6Addresses": List,
    "QueueNumber": Integer,
    "NetworkInterfaceTrafficMode": String,
    "Ipv6AddressCount": Integer,
    "Ipv6Prefixes": List,
    "Ipv4Prefixes": List,
    "Ipv4PrefixCount": Integer,
    "TxQueueSize": Integer,
    "DeleteOnRelease": Boolean,
    "Ipv6PrefixCount": Integer,
    "RxQueueSize": Integer
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ResourceGroupId	String	いいえ	はい	リソースグループ ID。	リソースグループ ID をクエリするには、ListResourceGroups 操作を呼び出すことができます。
SecurityGroupId	String	いいえ	はい	セキュリティグループ ID。	セキュリティグループと ENI は、同じ Virtual Private Cloud (VPC) に属している必要があります。説明 SecurityGroupId と SecurityGroupIds の両方を指定することはできません。
VSwitchId	String	はい	いいえ	vSwitch ID。	なし。
Description	String	いいえ	はい	ENI の説明。	説明は 2 ～ 256 文字で、`http://` または `https://` で始めることはできません。
NetworkInterfaceName	String	いいえ	はい	ENI 名。	名前は 2 ～ 128 文字でなければなりません。文字で始まり、`http://` または `https://` で始めることはできません。文字、数字、コロン（:）、アンダースコア（_）、ハイフン（-）を含めることができます。
PrimaryIpAddress	String	いいえ	いいえ	ENI のプライマリプライベート IP アドレス。	プライマリプライベート IP アドレスは、ENI を関連付ける vSwitch の CIDR ブロック内のアイドル IP アドレスである必要があります。このプロパティを空のままにすると、vSwitch CIDR ブロックからランダムにアイドル IP アドレスが割り当てられます。
SecondaryPrivateIpAddressCount	Integer	いいえ	いいえ	セカンダリプライベート IP アドレスの数。	なし。
Tags	List	いいえ	はい	タグ。	最大 20 個のタグを追加できます。詳細については、「タグのプロパティ」をご参照ください。
SecurityGroupIds	List	いいえ	はい	1 つ以上のセキュリティグループの ID。	セキュリティグループと ENI は同じ VPC に属している必要があります。説明 SecurityGroupId と SecurityGroupIds の両方を指定することはできません。
PrivateIpAddresses	List	いいえ	いいえ	ENI を関連付ける vSwitch の CIDR ブロックから ENI に割り当てる 1 つ以上のセカンダリプライベート IP アドレス。	ENI に割り当てることができるセカンダリプライベート IP アドレスの数の有効な値: ENI が Available 状態の場合、有効な値は 1 ～ 10 です。 ENI が InUse 状態の場合、有効な値はインスタンスタイプによって異なります。詳細については、「インスタンスファミリの概要」をご参照ください。
Ipv6Addresses	List	いいえ	いいえ	ENI に割り当てる 1 つ以上の IPv6 アドレス。	最大 10 個の IPv6 アドレスを指定できます。説明 ENI に IPv6 アドレスを割り当てる場合は、`Ipv6Addresses` プロパティまたは `Ipv6AddressCount` プロパティを指定する必要がありますが、両方のプロパティを指定することはできません。
QueueNumber	Integer	いいえ	いいえ	ENI でサポートされているキューの数。	有効な値: 1 ～ 2048。 ENI をインスタンスにアタッチする場合は、このプロパティの値が、インスタンスタイプで許可されている 1 ENI あたりの最大キュー数よりも小さいことを確認してください。インスタンスタイプの 1 ENI あたりの最大キュー数をクエリするには、DescribeInstanceTypes 操作を呼び出し、`MaximumQueueNumberPerEni` の戻り値を確認します。 QueueNumber プロパティはデフォルトでは空のままです。ENI をインスタンスにアタッチするときにこのプロパティを空のままにすると、インスタンスタイプで許可されている 1 ENI あたりのデフォルトのキュー数が使用されます。インスタンスタイプの 1 ENI あたりのデフォルトのキュー数をクエリするには、DescribeInstanceTypes 操作を呼び出し、`SecondaryEniQueueNumber` の戻り値を確認します。
NetworkInterfaceTrafficMode	String	いいえ	いいえ	ENI の通信モード。	有効な値: Standard: TCP 通信モードを使用します。 HighPerformance: Elastic RDMA Interface (ERI) 機能が有効な Remote Direct Memory Access (RDMA) 通信モードを使用します。説明 HighPerformance の値は、c7re RDMA 拡張インスタンスファミリのみをサポートします。 c7re インスタンスにアタッチできる RDMA モードの ENI の最大数は、インスタンスタイプに基づいて決定されます。 c7re インスタンスファミリは、北京ゾーン K で招待プレビュー中です。詳細については、「インスタンスファミリの概要」をご参照ください。
Ipv6AddressCount	Integer	いいえ	いいえ	ENI にランダムに生成する IPv6 アドレスの数。	有効な値: 1 ～ 10。説明 ENI に IPv6 アドレスを割り当てる場合は、`Ipv6Addresses` プロパティまたは `Ipv6AddressCount` プロパティを指定する必要がありますが、両方のプロパティを指定することはできません。
Ipv6Prefixes	List	いいえ	いいえ	IPv6 プレフィックス。	なし。
Ipv4Prefixes	List	いいえ	いいえ	IPv4 プレフィックス。	なし。
Ipv4PrefixCount	Integer	いいえ	いいえ	ENI に割り当てる IPv4 プレフィックスの数。	有効な値: 1 ～ 10。説明 ENI に IPv4 プレフィックスを割り当てる場合は、Ipv4Prefixes プロパティまたは Ipv4PrefixCount プロパティを指定する必要がありますが、両方のプロパティを指定することはできません。
TxQueueSize	Integer	いいえ	はい	ENI の送信 (Tx) キューの深さ。	次の項目に注意してください。 ENI の Tx キューの深さは、ENI の受信 (Rx) キューの深さと同じである必要があります。有効な値: 8192 ～ 16384 の範囲の 2 の累乗。 Tx キューの深さが大きいほど、送信スループットは高くなりますが、より多くのメモリを消費します。
DeleteOnRelease	Boolean	いいえ	はい	関連付けられているインスタンスが解放されたときに ENI を保持するかどうかを指定します。	有効な値: true false
Ipv6PrefixCount	Integer	いいえ	いいえ	ENI に割り当てる IPv6 プレフィックスの数。	有効な値: 1 ～ 10。説明 ENI に IPv6 プレフィックスを割り当てる場合は、Ipv6Prefixes プロパティまたは Ipv6PrefixCount プロパティを指定する必要がありますが、両方のプロパティを指定することはできません。
RxQueueSize	Integer	いいえ	はい	ENI の Rx キューの深さ。	次の項目に注意してください。 ENI の Rx キューの深さは、ENI の Tx キューの深さと同じである必要があります。有効な値: 8192 ～ 16384 の範囲の 2 の累乗。 Rx キューの深さが大きいほど、受信スループットは高くなりますが、より多くのメモリを消費します。

タグの構文

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

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	はい	いいえ	タグキー。	タグキーは 1 ～ 128 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。
Value	String	いいえ	いいえ	タグ値。	タグ値は最大 128 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。

戻り値

Fn::GetAtt

NetworkInterfaceId: ENI ID。
MacAddress: ENI のメディアアクセス制御 (MAC) アドレス。
PrivateIpAddress: ENI のプライベート IP アドレス。
SecondaryPrivateIpAddresses: ENI のセカンダリプライベート IP アドレス。
Arn: Alibaba Cloud Resource Name (ARN)。

例

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SecurityGroupId:
    Type: String
    AssociationProperty: ALIYUN::ECS::SecurityGroup::SecurityGroupId
    Label:
       
      en: Security Group ID
  VSwitchId:
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    Type: String
    Label:
       
      en: VSwitch ID
Resources:
  EniInstance:
    Type: ALIYUN::ECS::NetworkInterface
    Properties:
      SecurityGroupId:
        Ref: SecurityGroupId
      VSwitchId:
        Ref: VSwitchId
      NetworkInterfaceName: TestNetworkInterface
Outputs:
  PrivateIpAddress:
    Description: The primary private ip address of your Network Interface.
    Value:
      Fn::GetAtt:
        - EniInstance
        - PrivateIpAddress
  SecondaryPrivateIpAddresses:
    Description: The secondary private IP addresses of your Network Interface.
    Value:
      Fn::GetAtt:
        - EniInstance
        - SecondaryPrivateIpAddresses
  MacAddress:
    Description: The MAC address of your Network Interface.
    Value:
      Fn::GetAtt:
        - EniInstance
        - MacAddress
  NetworkInterfaceId:
    Description: ID of your Network Interface.
    Value:
      Fn::GetAtt:
        - EniInstance
        - NetworkInterfaceId

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SecurityGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::SecurityGroup::SecurityGroupId",
      "Label": {
         
        "en": "Security Group ID"
      }
    },
    "VSwitchId": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "Type": "String",
      "Label": {
         
        "en": "VSwitch ID"
      }
    }
  },
  "Resources": {
    "EniInstance": {
      "Type": "ALIYUN::ECS::NetworkInterface",
      "Properties": {
        "SecurityGroupId": {
          "Ref": "SecurityGroupId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "NetworkInterfaceName": "TestNetworkInterface"
      }
    }
  },
  "Outputs": {
    "PrivateIpAddress": {
      "Description": "ネットワークインターフェースのプライマリ プライベート IP アドレス。",
      "Value": {
        "Fn::GetAtt": [
          "EniInstance",
          "PrivateIpAddress"
        ]
      }
    },
    "SecondaryPrivateIpAddresses": {
      "Description": "ネットワークインターフェースのセカンダリ プライベート IP アドレス。",
      "Value": {
        "Fn::GetAtt": [
          "EniInstance",
          "SecondaryPrivateIpAddresses"
        ]
      }
    },
    "MacAddress": {
      "Description": "ネットワークインターフェースの MAC アドレス。",
      "Value": {
        "Fn::GetAtt": [
          "EniInstance",
          "MacAddress"
        ]
      }
    },
    "NetworkInterfaceId": {
      "Description": "ネットワークインターフェースの ID。",
      "Value": {
        "Fn::GetAtt": [
          "EniInstance",
          "NetworkInterfaceId"
        ]
      }
    }
  }
}

構文

プロパティ

タグの構文

タグのプロパティ

戻り値

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式