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

Resource Orchestration Service:DATASOURCE::SLB::LoadBalancers

最終更新日:Jan 16, 2025

DATASOURCE::SLB::LoadBalancersは、作成されたClassic Load Balancer(CLB)インスタンスを照会するために使用されます。

構文

{
  "Type": "DATASOURCE::SLB::LoadBalancers",
  "Properties": {
    "Status": String,
    "AddressIpVersion": String,
    "ResourceGroupId": String,
    "Address": String,
    "VSwitchId": String,
    "LoadBalancerId": String,
    "SlaveZoneId": String,
    "InternetChargeType": String,
    "LoadBalancerName": String,
    "VpcId": String,
    "NetworkType": String,
    "PaymentType": String,
    "AddressType": String,
    "MasterZoneId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ

種類

必須

編集可能

説明

制約

Status

String

いいえ

はい

CLBインスタンスの状態。

有効な値:

  • inactive: CLBインスタンスは停止しています。この状態のCLBインスタンスのリスナーはトラフィックを転送しません。

  • active: CLBインスタンスは実行中です。デフォルトでは、新しいCLBインスタンスはアクティブ状態です。

  • locked: CLBインスタンスはロックされています。CLBインスタンスが期限切れになると、インスタンスは7日間ロックされます。ロックされたCLBインスタンスでは操作を実行できません。ロックされたCLBインスタンスはトラフィックを転送しなくなりますが、IPアドレスとその他の設定は保持されます。

AddressIpVersion

String

いいえ

はい

IPバージョン。

有効な値:

  • ipv4

  • ipv6

ResourceGroupId

String

いいえ

はい

リソースグループのID。

なし。

Address

String

いいえ

はい

CLBインスタンスがサービスを提供するために使用するIPアドレス。

なし。

VSwitchId

String

いいえ

はい

CLBインスタンスが属するvSwitchのID。

なし。

LoadBalancerId

String

いいえ

はい

CLBインスタンスのID。

最大10個のIDを指定できます。複数のIDはコンマ(,)で区切ります。

SlaveZoneId

String

いいえ

はい

CLBインスタンスが属するセカンダリーゾーンのID。

なし。

InternetChargeType

String

いいえ

はい

インターネットデータ転送の計測方法。

有効な値:

  • paybybandwidth: 帯域幅課金

  • paybytraffic: データ転送量課金

説明
  • PayTypeの値がPrePayに設定されている場合、帯域幅課金のみがサポートされます。

  • InstanceChargeTypeの値がPayByCLCUに設定されている場合、データ転送量課金のみがサポートされます。

LoadBalancerName

String

いいえ

はい

CLBインスタンスの名前。

名前は1~80文字で、数字、ピリオド(.)、アンダースコア(_)、ハイフン(-)を含めることができます。名前は文字で始める必要があります。最大10個の名前を指定できます。複数の名前はコンマ(,)で区切ります。

VpcId

String

いいえ

はい

CLBインスタンスが属する仮想プライベートクラウド(VPC)のID。

なし。

NetworkType

String

いいえ

はい

内部向けCLBインスタンスのネットワークタイプ。

有効な値:

  • Vpc: VPC

  • classic: クラシックネットワーク

PaymentType

String

いいえ

はい

CLBインスタンスの課金方法。

なし。

AddressType

String

いいえ

はい

CLBインスタンスのネットワークタイプ。

有効な値:

  • internet: インターネット向けCLBインスタンスが作成されると、システムはインスタンスにパブリックIPアドレスを割り当てます。CLBインスタンスはインターネット経由でリクエストを転送できます。

  • intranet: 内部向けCLBインスタンスが作成されると、システムはインスタンスにプライベートIPアドレスを割り当てます。CLBインスタンスは内部ネットワーク経由でリクエストを転送できます。

MasterZoneId

String

いいえ

はい

CLBインスタンスが属するプライマリーゾーンのID。

なし。

RefreshOptions

String

いいえ

はい

スタックの更新時のデータソースリソースの更新ポリシー。

有効な値:

  • Never(デフォルト): スタックの更新時にデータソースリソースを更新しません。

  • Always: スタックの更新時にデータソースリソースを更新します。

戻り値

Fn::GetAtt

  • LoadBalancerIds: CLBインスタンスのID。

  • LoadBalancers: CLBインスタンスの詳細。

プロパティ

種類

説明

制約

LoadBalancerIds

List

CLBインスタンスのID。

なし。

LoadBalancers

List

CLBインスタンスの詳細。

なし。

ModificationProtectionStatus

String

CLBインスタンスで構成読み取り専用モードが有効になっているかどうかを示します。

有効な値:

  • NonProtection: CLBインスタンスで構成読み取り専用モードが無効になっています。 ModificationProtectionStatusをNonProtectionに設定すると、ModificationProtectionReasonの値はクリアされます。

  • ConsoleProtection: CLBインスタンスで構成読み取り専用モードが有効になっています。

AddressIpVersion

String

IPバージョン。

有効な値:

  • ipv4

  • ipv6

InternetChargeType

String

インターネット向けCLBインスタンスの計測方法。

有効な値:

  • 3: 帯域幅課金

  • 4: データ転送量課金

説明
  • PayTypeの値がPrePayに設定されている場合、帯域幅課金のみがサポートされます。

  • InstanceChargeTypeの値がPayByCLCUに設定されている場合、データ転送量課金のみがサポートされます。

Status

String

CLBインスタンスの状態。

有効な値:

  • inactive: CLBインスタンスは停止しています。この状態のCLBインスタンスのリスナーはトラフィックを転送しません。

  • active: CLBインスタンスは実行中です。デフォルトでは、新しいCLBインスタンスはアクティブ状態です。

  • locked: CLBインスタンスはロックされています。 CLBインスタンスが期限切れになると、インスタンスは 7 日間ロックされます。ロックされたCLBインスタンスでは操作を実行できません。ロックされたCLBインスタンスはトラフィックを転送しなくなりますが、IPアドレスとその他の設定は保持されます。

AddressType

String

CLBインスタンスのネットワークタイプ。

有効な値:

  • internet: インターネット向けCLBインスタンスが作成されると、システムはインスタンスにパブリックIPアドレスを割り当てます。 CLBインスタンスはインターネット経由でリクエストを転送できます。

  • intranet: 内部向けCLBインスタンスが作成されると、システムはインスタンスにプライベートIPアドレスを割り当てます。 CLBインスタンスは内部ネットワーク経由でリクエストを転送できます。

RegionIdAlias

String

CLBインスタンスが存在するリージョンの名前。

なし。

Tags

List

タグ。

なし。

RegionId

String

CLBインスタンスが存在するリージョンのID。

なし。

ResourceGroupId

String

リソースグループのID。

なし。

CreateTimeStamp

String

CLBインスタンスが作成された日時を示すタイムスタンプ。

なし。

VSwitchId

String

内部向けCLBインスタンスが属するvSwitchのID。

なし。

Address

String

CLBインスタンスがサービスを提供するために使用するIPアドレス。

なし。

MasterZoneId

String

CLBインスタンスが属するプライマリーゾーンのID。

なし。

LoadBalancerName

String

CLBインスタンスの名前。

なし。

VpcId

String

内部向けCLBインスタンスが属するVPCのID。

なし。

LoadBalancerSpec

String

CLBインスタンスの仕様。

なし。

DeleteProtection

String

CLBインスタンスで削除保護が有効になっているかどうかを示します。

有効な値:

  • on: CLBインスタンスで削除保護が有効になっています。

  • off: CLBインスタンスで削除保護が無効になっています。

ModificationProtectionReason

String

マネージドインスタンス。

構成読み取り専用モードが有効になっている理由。値は1~80文字です。文字で始まり、数字、ピリオド(.)、アンダースコア(_)、ハイフン(-)を含めることができます。

説明

このプロパティは、ModificationProtectionStatusがConsoleProtectionに設定されている場合にのみ有効になります。

SlaveZoneId

String

CLBインスタンスが属するセカンダリーゾーンのID。

なし。

PaymentType

String

CLBインスタンスの課金方法。

なし。

Bandwidth

Integer

リスナーの最大帯域幅。

単位:Mbit/s。

有効な値:

  • -1: データ転送量課金のインターネット向けCLBインスタンスの場合、最大帯域幅を-1に設定できます。これは、リスナーの帯域幅が無制限であることを示します。

  • 1~5120: 帯域幅課金のインターネット向けCLBインスタンスの場合、リスナーごとに最大帯域幅を指定できます。すべてのリスナーの最大帯域幅の合計は、CLBインスタンスの最大帯域幅を超えることはできません。

LoadBalancerId

String

CLBインスタンスのID。

なし。

NetworkType

String

内部向けCLBインスタンスのネットワークタイプ。

有効な値:

  • Vpc: VPC

  • classic: クラシックネットワーク

CreateTime

String

CLBインスタンスが作成された日時。

時間はYYYY-MM-DDThh:mm:ssZ形式です。

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "LoadBalancerId": {
      "Type": "String",
      "Description": "負荷分散インスタンスのID。" // ID of the load balancing instance.
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::SLB::LoadBalancers",
      "Properties": {
        "LoadBalancerId": {
          "Ref": "LoadBalancerId"
        }
      }
    }
  },
  "Outputs": {
    "LoadBalancerIds": {
      "Description": "ロードバランサーIDのリスト。", // The list of load balancer IDs.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LoadBalancerIds"
        ]
      }
    },
    "LoadBalancers": {
      "Description": "ロードバランサーのリスト。", // The list of load balancers.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LoadBalancers"
        ]
      }
    }
  }
}
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  LoadBalancerId:
    Type: String
    Description: 負荷分散インスタンスのID。 # ID of the load balancing instance.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::SLB::LoadBalancers
    Properties:
      LoadBalancerId:
        Ref: LoadBalancerId
Outputs:
  LoadBalancerIds:
    Description: ロードバランサーIDのリスト。 # The list of load balancer IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LoadBalancerIds
  LoadBalancers:
    Description: ロードバランサーのリスト。 # The list of load balancers.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LoadBalancers