ALIYUN::NLB::Listener を使用してリスナーを作成する - Resource Orchestration Service

ALIYUN::NLB::Listener リソースタイプを使用して、リスナーを作成します。

構文

{
  "Type": "ALIYUN::NLB::Listener",
  "Properties": {
    "CaEnabled": ブール値,
    "ListenerPort": 整数,
    "StartPort": 整数,
    "Cps": 整数,
    "ServerGroupId": 文字列,
    "IdleTimeout": 整数,
    "LoadBalancerId": 文字列,
    "Mss": 整数,
    "ListenerProtocol": 文字列,
    "SecurityPolicyId": 文字列,
    "ListenerDescription": 文字列,
    "AlpnPolicy": 文字列,
    "CaCertificateIds": リスト,
    "EndPort": 整数,
    "ProxyProtocolEnabled": ブール値,
    "CertificateIds": リスト,
    "SecSensorEnabled": ブール値,
    "Enable": ブール値,
    "AlpnEnabled": ブール値,
    "Tags": リスト,
    "ServerGroupTuples": リスト,
    "ProxyProtocolV2Config": マップ
  }
}

プロパティ

プロパティ名	型	必須	更新可否	説明	制約条件
ListenerPort	整数	はい	いいえ	Server Load Balancer (SLB) インスタンスで使用されるフロントエンドポート。	値の範囲は 1 ～ 65535 です。
ListenerProtocol	文字列	はい	いいえ	SLB インスタンスで使用されるフロントエンドプロトコル。	有効な値： TCP UDP TCPSSL
LoadBalancerId	文字列	はい	いいえ	SLB インスタンスの ID。	なし
AlpnEnabled	ブール値	いいえ	はい	アプリケーション層プロトコルネゴシエーション（ALPN）を有効にするかどうかを指定します。	有効な値： true：有効 false：無効
AlpnPolicy	文字列	いいえ	はい	アプリケーション層プロトコルネゴシエーション（ALPN）エージェント。	なし
CaCertificateIds	リスト	いいえ	いいえ	証明機関（CA）証明書の ID。	なし
CaEnabled	ブール値	いいえ	はい	相互認証を有効にするかどうかを指定します。	有効な値： true：有効 false（デフォルト）：無効
CertificateIds	リスト	いいえ	はい	署名証明書の ID。	なし
Cps	整数	いいえ	はい	接続数/秒。	値は 3000 である必要があります。
Enable	ブール値	いいえ	いいえ	リスナーを有効にするかどうかを指定します。	有効な値： true：有効 false：無効
EndPort	整数	いいえ	いいえ	リスナーポート範囲の最終ポート。	値は 65535 である必要があります。
IdleTimeout	整数	いいえ	はい	アイドル接続のタイムアウト期間。	値の範囲は 1 ～ 60 です。単位：秒。
ListenerDescription	文字列	いいえ	はい	リスナーの説明。	説明は 2 ～ 256 文字である必要があります。英字、数字、ハイフン（-）、スラッシュ（/）、ピリオド（.）、アンダースコア（_）が使用可能です。
Mss	整数	いいえ	はい	MSS 自動ネゴシエーション	なし
ProxyProtocolEnabled	ブール値	いいえ	はい	Proxy Protocol v2 を有効にするかどうかを指定します。	有効な値： true：有効 false：無効
ProxyProtocolV2Config	マップ	いいえ	はい	VpcId、PrivateLinkEpId、PrivateLinkEpsId などのクライアント情報をバックエンドサーバーに渡すための Proxy Protocol 構成。	詳細については、「ProxyProtocolV2Config のプロパティ」をご参照ください。
SecSensorEnabled	ブール値	いいえ	はい	セカンダリモニタリングを有効にするかどうか。	有効な値： true：有効 false：無効
SecurityPolicyId	文字列	いいえ	はい	セキュリティポリシーの ID。	なし
ServerGroupId	文字列	いいえ	はい	リクエストを転送先とするサーバーグループの ID。	なし
ServerGroupTuples	リスト	いいえ	はい	転送先サーバータプル。	複数の転送先サーバーグループ ID の組み合わせです。詳細については、「ServerGroupTuples のプロパティ」をご参照ください。
StartPort	整数	いいえ	いいえ	リスナーポート範囲の最初のポート。	値は 1 である必要があります。
Tags	リスト	いいえ	はい	タグのリスト。	詳細については、「Tags のプロパティ」をご参照ください。

ServerGroupTuples の構文

"ServerGroupTuples": [{
    "ServerGroupId": 文字列,
    "Weight": 整数
}]

ServerGroupTuples のプロパティ

プロパティ名	型	必須	更新可能	説明	制約条件
ServerGroupId	文字列	いいえ	はい	リクエストを転送先とする宛先サーバーグループの ID。	なし
Weight	整数	いいえ	はい	重み。	値が大きいほど重みが高くなります。重みが高いサーバーグループにはより多くのリクエストが割り当てられます。値の範囲は 0 ～ 100 です。

ProxyProtocolV2Config の構文

"ProxyProtocolV2Config": {
    "Ppv2PrivateLinkEpIdEnabled": ブール値,
    "Ppv2PrivateLinkEpsIdEnabled": ブール値,
    "Ppv2VpcIdEnabled": ブール値
  }

ProxyProtocolV2Config のプロパティ

プロパティ名	型	必須	更新可能	説明	制約条件
Ppv2PrivateLinkEpIdEnabled	ブール値	いいえ	はい	Proxy Protocol を使用して PrivateLinkEpId をバックエンドサーバーに渡すかどうかを指定します。	有効な値： true：有効 false：シャットダウン
Ppv2PrivateLinkEpsIdEnabled	ブール値	いいえ	はい	Proxy Protocol を使用して PrivateLinkEpsId をバックエンドサーバーに渡すかどうかを指定します。	有効な値： true：有効 false：シャットダウン
Ppv2VpcIdEnabled	ブール値	いいえ	はい	Proxy Protocol を使用して VpcId をバックエンドサーバーに渡すかどうかを指定します。	有効な値： true：有効 false：シャットダウン

Tags の構文

"Tags": [
  {
    "Key": 文字列,
    "Value": 文字列
  }
]

Tags のプロパティ

プロパティ名	型	必須	更新可否	説明	制約条件
Key	文字列	はい	いいえ	タグキー。	なし
Value	文字列	いいえ	いいえ	タグ値。	なし

戻り値

Fn::GetAtt

ListenerPort：SLB インスタンスで使用されるフロントエンドポート。
ListenerId：リスナーの ID。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ServerGroupId:
    Type: String
    Description: ID of the ServerGroup
  LoadBalancerId:
    Type: String
    Description: ID of the LoadBalancer
  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
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ListenerPort
  ListenerId:
    Description: Id of created Listener
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ListenerId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ServerGroupId": {
      "Type": "String",
      "Description": "ID of the ServerGroup"
    },
    "LoadBalancerId": {
      "Type": "String",
      "Description": "ID of the LoadBalancer"
    },
    "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",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ListenerPort"
        ]
      }
    },
    "ListenerId": {
      "Description": "Id of created Listener",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ListenerId"
        ]
      }
    }
  }
}