リスナーを作成するための呼び出しで ALIYUN::NLB::Listener を使用する - Resource Orchestration Service

ALIYUN::NLB::Listener は、リスナーの作成に使用されます。

構文

{
  "Type": "ALIYUN::NLB::Listener",
  "Properties": {
    "CaEnabled": Boolean,
    "ListenerPort": Integer,
    "StartPort": Integer,
    "Cps": Integer,
    "ServerGroupId": String,
    "IdleTimeout": Integer,
    "LoadBalancerId": String,
    "Mss": Integer,
    "ListenerProtocol": String,
    "SecurityPolicyId": String,
    "ListenerDescription": String,
    "AlpnPolicy": String,
    "CaCertificateIds": List,
    "EndPort": Integer,
    "ProxyProtocolEnabled": Boolean,
    "CertificateIds": List,
    "SecSensorEnabled": Boolean,
    "Enable": Boolean,
    "AlpnEnabled": Boolean,
    "Tags": List,
    "ProxyProtocolV2Config": Map
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
CaEnabled	Boolean	いいえ	いいえ	相互認証を有効にするかどうかを指定します。	有効な値： true false (デフォルト)
ListenerPort	Integer	いいえ	いいえ	ネットワークロードバランサー (NLB) インスタンスによって使用されるフロントエンドポート。	有効な値：1 ～ 65535。
StartPort	Integer	いいえ	いいえ	リスニングポート範囲の開始ポート。	値を 1 に設定します。
Cps	Integer	いいえ	いいえ	1 秒あたりの新規作成接続数 (CPS)。	値を 3000 に設定します。
ServerGroupId	String	はい	いいえ	リクエストの転送先サーバーグループの ID。	なし。
IdleTimeout	Integer	いいえ	いいえ	アイドル接続のタイムアウト期間。	有効な値：1 ～ 60。単位：秒。
LoadBalancerId	String	はい	いいえ	NLB インスタンスの ID。	なし。
Mss	Integer	いいえ	いいえ	最大セグメントサイズ (MSS) のアナウンスメント。	なし。
ListenerProtocol	String	はい	いいえ	NLB インスタンスによって使用されるフロントエンドプロトコル。	有効な値： TCP UDP TCPSSL
SecurityPolicyId	String	いいえ	いいえ	セキュリティポリシーの ID。	なし。
ListenerDescription	String	いいえ	いいえ	リスナーの説明。	説明は 2 ～ 256 文字で、文字、数字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、アンダースコア (_) を使用できます。
AlpnPolicy	String	いいえ	いいえ	アプリケーション層プロトコルネゴシエーション (ALPN) ポリシー。	なし。
CaCertificateIds	List	いいえ	いいえ	認証局 (CA) 証明書の ID。	なし。
EndPort	Integer	いいえ	いいえ	リスニングポート範囲の終了ポート。	値を 65535 に設定します。
ProxyProtocolEnabled	Boolean	いいえ	いいえ	プロキシプロトコル V2 を有効にするかどうかを指定します。	有効な値： true false
CertificateIds	List	いいえ	いいえ	証明書の ID。	なし。
SecSensorEnabled	Boolean	いいえ	いいえ	き細かい監視を有効にするかどうかを指定します。	有効な値： true false
Enable	Boolean	いいえ	いいえ	リスナーを有効にするかどうかを指定します。	有効な値： true false
AlpnEnabled	Boolean	いいえ	いいえ	ALPN を有効にするかどうかを指定します。	有効な値： true false
Tags	List	いいえ	はい	タグ。	詳細については、タグのプロパティをご参照ください。
ProxyProtocolV2Config	Map	いいえ	いいえ	プロキシプロトコルを使用して VpcId、PrivateLinkEpId、および PrivateLinkEpsId をバックエンドサーバーに渡すかどうかを指定します。	詳細については、このトピックの「ProxyProtocolV2Config プロパティ」セクションをご参照ください。

ProxyProtocolV2Config 構文

"ProxyProtocolV2Config": {
    "Ppv2PrivateLinkEpIdEnabled": Boolean,
    "Ppv2PrivateLinkEpsIdEnabled": Boolean,
    "Ppv2VpcIdEnabled": Boolean
  }

ProxyProtocolV2Config プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Ppv2PrivateLinkEpIdEnabled	Boolean	いいえ	いいえ	プロキシプロトコルを使用して PrivateLinkEpId をバックエンドサーバーに渡すかどうかを指定します。	有効な値： true false
Ppv2PrivateLinkEpsIdEnabled	Boolean	いいえ	いいえ	プロキシプロトコルを使用して PrivateLinkEpsId をバックエンドサーバーに渡すかどうかを指定します。	有効な値： true false
Ppv2VpcIdEnabled	Boolean	いいえ	いいえ	プロキシプロトコルを使用して VpcId をバックエンドサーバーに渡すかどうかを指定します。	有効な値： true false

タグの構文

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

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	はい	いいえ	タグキー。	なし。
Value	String	いいえ	いいえ	タグ値。	なし。

戻り値

Fn::GetAtt

ListenerPort：NLB インスタンスによって使用されるフロントエンドポート。
ListenerId：リスナー ID。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ServerGroupId:
    Type: String
    Description: ID of the ServerGroup  # サーバーグループのID
  LoadBalancerId:
    Type: String
    Description: ID of the LoadBalancer # ロードバランサーのID
  ListenerProtocol:
    Type: String
    AllowedValues:
      - TCP
      - UDP
      - TCPSSL
Resources:
  ExtensionResource:
    Type: ALIYUN::NLB::Listener
    Properties:
      ServerGroupId:
        Ref: ServerGroupId
      LoadBalancerId:
        Ref: LoadBalancerId
      ListenerProtocol:
        Ref: ListenerProtocol
Outputs:
  ListenerPort:
    Description: ListenerPort of created Listener # 作成されたリスナーのListenerPort
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ListenerPort
  ListenerId:
    Description: Id of created Listener # 作成されたリスナーのID
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ListenerId

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ServerGroupId": {
      "Type": "String",
      "Description": "ID of the ServerGroup" // サーバーグループのID
    },
    "LoadBalancerId": {
      "Type": "String",
      "Description": "ID of the LoadBalancer" // ロードバランサーのID
    },
    "ListenerProtocol": {
      "Type": "String",
      "AllowedValues": [
        "TCP",
        "UDP",
        "TCPSSL"
      ]
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::NLB::Listener",
      "Properties": {
        "ServerGroupId": {
          "Ref": "ServerGroupId"
        },
        "LoadBalancerId": {
          "Ref": "LoadBalancerId"
        },
        "ListenerProtocol": {
          "Ref": "ListenerProtocol"
        }
      }
    }
  },
  "Outputs": {
    "ListenerPort": {
      "Description": "ListenerPort of created Listener", // 作成されたリスナーのListenerPort
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ListenerPort"
        ]
      }
    },
    "ListenerId": {
      "Description": "Id of created Listener", // 作成されたリスナーのID
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ListenerId"
        ]
      }
    }
  }
}

構文

プロパティ

ProxyProtocolV2Config 構文

ProxyProtocolV2Config プロパティ

タグの構文

タグのプロパティ

戻り値

例

YAML 形式

JSON 形式

`JSON` 形式