AWS::ElasticLoadBalancing::LoadBalancer - AWS CloudFormation
構文プロパティ戻り値以下の資料も参照してください。

AWS::ElasticLoadBalancing::LoadBalancer

Classic Load Balancer を指定します。

AvailabilityZones プロパティまたは Subnets プロパティを指定できますが、両方指定することはできません。

このリソースにパブリック IP アドレスが割り当てられており、同じテンプレートに定義されている VPC が関連付けられている場合は、DependsOn 属性を使用して VPC ゲートウェイのアタッチメントへの依存関係を宣言する必要があります。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

{
  "Type" : "AWS::ElasticLoadBalancing::LoadBalancer",
  "Properties" : {
      "AccessLoggingPolicy" : AccessLoggingPolicy,
      "AppCookieStickinessPolicy" : [ AppCookieStickinessPolicy, ... ],
      "AvailabilityZones" : [ String, ... ],
      "ConnectionDrainingPolicy" : ConnectionDrainingPolicy,
      "ConnectionSettings" : ConnectionSettings,
      "CrossZone" : Boolean,
      "HealthCheck" : HealthCheck,
      "Instances" : [ String, ... ],
      "LBCookieStickinessPolicy" : [ LBCookieStickinessPolicy, ... ],
      "Listeners" : [ Listeners, ... ],
      "LoadBalancerName" : String,
      "Policies" : [ Policies, ... ],
      "Scheme" : String,
      "SecurityGroups" : [ String, ... ],
      "Subnets" : [ String, ... ],
      "Tags" : [ Tag, ... ]
    }
}

プロパティ

AccessLoggingPolicy

ロードバランサーのアクセスログの保存場所と保存方法に関する情報。

必須: いいえ

タイプ: AccessLoggingPolicy

Update requires: No interruption

AppCookieStickinessPolicy

アプリケーション制御のセッション維持のポリシーに関する情報。

必須: いいえ

タイプ: AppCookieStickinessPolicy のリスト

Update requires: No interruption

AvailabilityZones

ロードバランサーのアベイラビリティゾーン。VPC のロードバランサーの場合は、代わりに Subnets を指定します。

以前にアベイラビリティゾーンを指定していなかった場合、またはすべてのアベイラビリティゾーンを削除している場合は、更新時に置換する必要があります。それ以外の場合、更新に伴う中断はありません。

必須: いいえ

タイプ: 文字列のリスト

Update requires: Some interruptions

ConnectionDrainingPolicy

有効になっている場合、ロードバランサーは、登録解除されたインスタンスや異常なインスタンスからトラフィックを移動する前に、既存のリクエストを完了させることができます。

詳細については、『Classic Load Balancer ガイド』の Connection Draining を設定するを参照してください。

必須: いいえ

タイプ: ConnectionDrainingPolicy

Update requires: No interruption

ConnectionSettings

有効になっている場合、ロードバランサーは、指定された期間、接続をアイドル状態にしたままにします (データは接続を介して送信されません)。

Elastic Load Balancing はデフォルトでは、ロードバランサーのフロントエンド接続とバックエンド接続の両方に対して 60 秒のアイドル接続タイムアウトを維持します。詳細については、『Classic Load Balancer ガイド』のアイドル接続のタイムアウトを設定するを参照してください。

必須: いいえ

タイプ: ConnectionSettings

Update requires: No interruption

CrossZone

有効になっている場合、ロードバランサーは、アベイラビリティゾーンに関係なく、リクエストトラフィックをすべてのインスタンスに均等にルーティングします。

詳細については、『Classic Load Balancer ガイド』のクロスゾーン負荷分散を設定するを参照してください。

必須: いいえ

タイプ: ブール値

Update requires: No interruption

HealthCheck

EC2 インスタンスのヘルス状態を評価するときに使用するヘルスチェック設定。

以前にヘルスチェック設定を指定していなかった場合、またはヘルスチェック設定を削除している場合は、更新時に置換する必要があります。それ以外の場合、更新に伴う中断はありません。

必須: いいえ

タイプ: HealthCheck

Update requires: Some interruptions

Instances

ロードバランサーのインスタンスの ID。

必須: いいえ

タイプ: 文字列のリスト

Update requires: No interruption

LBCookieStickinessPolicy

期間ベースのセッション維持のポリシーに関する情報。

必須: いいえ

タイプ: LBCookieStickinessPolicy のリスト

Update requires: No interruption

Listeners

ロードバランサーのリスナー。ポートごとに最大 1 つのリスナーを指定できます。

リスナーのプロパティを更新すると、AWS CloudFormation は既存のリスナーを削除し、指定されたプロパティを使用して新しいリスナーを作成します。新しいリスナーが作成されている間、クライアントはロードバランサーに接続できません。

必須: はい

タイプ: Listeners のリスト

Update requires: No interruption

LoadBalancerName

ロードバランサーの名前。この名前は、リージョンのロードバランサーのセット内で一意である必要があります。

名前を指定しなかった場合は、AWS CloudFormation によってロードバランサーの一意の物理 ID が生成されます。詳細については、Name タイプを参照してください。名前を指定した場合、このリソースの置換が必要な更新は実行できませんが、他の更新は実行できます。リソースを置き換えるには、新しい名前を指定します。

必須: いいえ

タイプ: 文字列

Update requires: Replacement

Policies

Classic Load Balancer に対して定義されたポリシー。バックエンドサーバーポリシーのみを指定します。

必須: いいえ

タイプ: Policies のリスト

Update requires: No interruption

Scheme

ロードバランサーのタイプ。VPC 内のロードバランサーにのみ有効です。

Scheme が internet-facing である場合、ロードバランサーのパブリック DNS 名はパブリック IP アドレスに解決されます。

Scheme が internal である場合、ロードバランサーのパブリック DNS 名はプライベート IP アドレスに解決されます。

必須: いいえ

タイプ: 文字列

Update requires: Replacement

SecurityGroups

ロードバランサーのセキュリティグループ。VPC 内のロードバランサーにのみ有効です。

必須: いいえ

タイプ: 文字列のリスト

Update requires: No interruption

Subnets

ロードバランサーのサブネットの ID。アベイラビリティゾーンごとに最大 1 つのサブネットを指定できます。

以前にサブネットを指定しなかった場合、またはすべてのサブネットを削除している場合は、更新時に置換する必要があります。それ以外の場合、更新に伴う中断はありません。現在のアベイラビリティゾーン内の別のサブネットに更新するには、最初に別のアベイラビリティゾーン内のサブネットに更新してから、元のアベイラビリティゾーン内の新しいサブネットに更新する必要があります。

必須: いいえ

タイプ: 文字列のリスト

Update requires: Some interruptions

Tags

ロードバランサーに関連付けられているタグ。

必須: いいえ

タイプ: Tag のリスト

Update requires: No interruption

戻り値

参照番号

このリソースの論理 ID を組み込みの Ref 関数に渡すと、Ref は次を返します: ロードバランサーの名前を返します。

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt 組み込み関数は、このタイプの指定された属性の値を返します。以下には、利用可能な属性とサンプル戻り値のリストが示されます。

Fn::GetAtt 組み込み関数の使用方法の詳細については、「Fn::GetAtt」を参照してください。

CanonicalHostedZoneName

ロードバランサーに関連付けられる Route 53 ホストゾーンの名前。内部向けロードバランサーはこの値を使用しません。代わりに DNSName を使用します。

CanonicalHostedZoneNameID

ロードバランサーに関連付けられる Route 53 ホストゾーン名の ID。

DNSName

ロードバランサーの DNS 名。

SourceSecurityGroup.GroupName

ロードバランサーのバックエンドインスタンスのインバウンドルールの一部として使用できるセキュリティグループの名前。

SourceSecurityGroup.OwnerAlias

ソースセキュリティグループの所有者。

以下の資料も参照してください。