ALB インスタンスを作成するための ALIYUN::ALB::LoadBalancer の使用方法 - Resource Orchestration Service

ALIYUN::ALB::LoadBalancer は、Application Load Balancer（ALB）インスタンスを作成するために使用されます。

構文

{
  "Type": "ALIYUN::ALB::LoadBalancer",
  "Properties": {
    "BandwidthPackageId": String,
    "LoadBalancerName": String,
    "LoadBalancerEdition": String,
    "VpcId": String,
    "ResourceGroupId": String,
    "LoadBalancerBillingConfig": Map,
    "AddressType": String,
    "AddressAllocatedMode": String,
    "ZoneMappings": List,
    "DeletionProtectionEnabled": Boolean,
    "AddressIpVersion": String,
    "ModificationProtectionConfig": Map,
    "Tags": List,
    "AccessLogConfig": Map,
    "SecurityGroupIds": List,
    "Ipv6AddressType": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
AddressType	String	はい	いいえ	ALB インスタンスのアドレスタイプ。	有効な値: Internet: パブリック IP アドレス。 ALB インスタンスのドメイン名は、パブリック IP アドレスに解決されます。 ALB インスタンスにはインターネット経由でアクセスできます。 Intranet: プライベート IP アドレス。 ALB インスタンスのドメイン名は、プライベート IP アドレスに解決されます。 ALB インスタンスは、ALB インスタンスが存在する仮想プライベートクラウド (VPC) 経由でのみアクセスできます。
LoadBalancerBillingConfig	Map	はい	いいえ	課金方法。	詳細については、「LoadBalancerBillingConfig プロパティ」をご参照ください。
LoadBalancerEdition	String	はい	はい	ALB インスタンスのエディション。	有効な値: Basic: Basic Edition Standard: Standard Edition StandardWithWaf: Web Application Firewall (WAF) 対応 Edition
VpcId	String	はい	いいえ	VPC ID。	なし。
ZoneMappings	List	はい	いいえ	ゾーンと vSwitch 間のマッピング。	少なくとも 2 つのゾーンを指定する必要があります。詳細については、「ZoneMappings プロパティ」をご参照ください。
AccessLogConfig	Map	いいえ	はい	アクセスログの構成。	詳細については、「AccessLogConfig プロパティ」をご参照ください。
AddressAllocatedMode	String	いいえ	いいえ	ALB インスタンスに IP アドレスを割り当てるモード。	有効な値: Fixed: 静的 IP アドレスが ALB インスタンスに割り当てられます。 Dynamic (デフォルト): IP アドレスが ALB インスタンスの各ゾーンに動的に割り当てられます。
アドレス IP バージョン	文字列	いいえ	いいえ	ALB インスタンスの IP バージョン。	有効な値: IPv4 DualStack
BandwidthPackageId	String	いいえ	はい	インターネット共有帯域幅インスタンスの ID です。	このプロパティは、AddressType が Internet に設定されている場合に有効になります。
削除保護の有効化	ブール値	いいえ	はい	削除保護を有効にするかどうかを指定します。	有効な値: true false (デフォルト)
Ipv6AddressType	String	いいえ	はい	ALB インスタンスの IPv6 アドレスタイプ。	有効な値: Internet: ALB インスタンスはパブリック IPv6 アドレスを使用します。そのドメイン名はパブリック IPv6 アドレスに解決されます。 Intranet: ALB インスタンスはプライベート IPv6 アドレスを使用します。そのドメイン名はプライベート IP アドレスに解決されます。
LoadBalancerName	String	いいえ	はい	ALB インスタンスの名前。	名前は 1 ～ 80 文字で、文字、数字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、およびアンダースコア (_) を使用できます。このプロパティを指定しない場合、システムによってインスタンスに名前が割り当てられます。
ModificationProtectionConfig	マップ	いいえ	はい	設定変更保護モードの詳細。	詳細については、「ModificationProtectionConfig プロパティ」をご参照ください。
リソースグループ ID	String	いいえ	はい	リソースグループの ID です。	なし。
SecurityGroupIds	リスト	いいえ	はい	ALB インスタンスに関連付けるセキュリティグループの ID です。	デフォルトでは、セキュリティグループは使用できません。セキュリティグループを使用するには、アカウントマネージャーにお問い合わせください。
タグ	リスト	いいえ	はい	ALB インスタンスに追加するタグ。	最大 20 個のタグを追加できます。詳細については、「タグのプロパティ」をご参照ください。

AccessLogConfig の構文

"AccessLogConfig": {
  "Enable": Boolean, // 有効化
  "LogStore": String, // ログストア
  "LogProject": String // ログプロジェクト
}

AccessLogConfig プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
LogProject	String	はい	いいえ	Simple Log Service (SLS) のプロジェクト。	なし。
LogStore	String	はい	いいえ	ログストア。	なし。
Enable	ブール値	いいえ	はい	アクセスログ機能を有効にするかどうかを指定します。	有効な値: true false

LoadBalancerBillingConfig 構文

"LoadBalancerBillingConfig": {
  "PayType": String // 支払いタイプ
}

LoadBalancerBillingConfig プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
PayType	String	はい	いいえ	ALB インスタンスの課金方法。	値を PostPay に設定します。これは、従量課金制を指定します。

ZoneMappings 構文

"ZoneMappings": [
  {
    "ZoneId": String, //ゾーンID
    "VSwitchId": String, //VSwitch ID
    "AllocationId": String, //割り当てID
    "LoadBalancerAddresses": List, //ロードバランサーアドレス
    "IntranetAddress": String, //イントラネットアドレス
    "EipType": String //EIPタイプ
  }
]

ZoneMappings プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
VSwitchId	String	はい	いいえ	vSwitch ID。	各ゾーンには 1 つの vSwitch のみを含めることができます。
ZoneId	String	はい	いいえ	ゾーン ID。	なし。
AllocationId	String	いいえ	いいえ	ALB インスタンスに関連付ける、Elastic IP アドレス (EIP) の ID。	なし。
EipType	String	いいえ	いいえ	EIP タイプ。	有効な値: Common: EIP Anycast: エニキャスト EIP 説明 ALB インスタンスにエニキャスト EIP を関連付けることができるリージョンについては、「最も近いアクセスポイント経由でアクセスできるようにするために、ALB インスタンスにエニキャスト EIP を関連付ける」をご参照ください。
LoadBalancerAddresses	List	いいえ	いいえ	ALB インスタンスのアドレス。	詳細については、「LoadBalancerAddresses プロパティ」をご参照ください。
IntranetAddress	String	いいえ	いいえ	非公開 IPv4 アドレス。	なし。

LoadBalancerAddresses 構文

"ModificationProtectionConfig": {
  "AllocationId": String, // 割り当て ID
  "IntranetAddress": String, // イントラネットアドレス
  "EipType": String // EIP タイプ
}

LoadBalancerAddresses プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
AllocationId	String	はい	いいえ	ALB インスタンスに関連付ける EIP の ID です。	なし。
EipType	String	いいえ	いいえ	EIP タイプです。	有効な値: Common: EIP Anycast: エニキャスト EIP 説明 ALB インスタンスにエニキャスト EIP を関連付けることができるリージョンについては、「最も近いアクセスポイント経由でアクセスできるように ALB インスタンスにエニキャスト EIP を関連付ける」をご参照ください。
IntranetAddress	String	いいえ	いいえ	非公開 IPv4 アドレスです。	なし。

ModificationProtectionConfig の構文

"ModificationProtectionConfig": {
  "Status": String, // ステータス
  "Reason": String // 理由
}

ModificationProtectionConfig プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

Status

String

はい

設定変更保護モードの状態です。

有効な値:

NonProtection: 設定変更保護モードを無効にします。この場合、Reason を指定することはできません。
ConsoleProtection: 設定変更保護モードを有効にします。この場合、Reason を指定できます。

Reason

String

いいえ

はい

設定変更保護モードを有効にする理由です。

理由は 2 ～ 128 文字で、英字、数字、ピリオド(.)、アンダースコア(_)、ハイフン(-) を使用できます。最初の文字は英字である必要があります。

説明

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

タグの構文

"Tags": [
  {
    "Value": String, // 値
    "Key": String // キー
  }
]

タグのプロパティ

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

戻り値

Fn::GetAtt

LoadBalancerEdition: ALB インスタンスのエディション。
VpcId: VPC ID。
LoadBalancerId: ALB インスタンスの ID。
AddressType: ALB インスタンスのアドレスタイプ。
DNSName: ALB インスタンスのドメイン名。
ZoneMappings: ゾーンと vSwitch のマッピング。
Arn: Alibaba Cloud リソースネーム (ARN)。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
  ZoneMappings:
    Type: Json
    Description: ゾーンとゾーン内の vSwitch。少なくとも 2 つのゾーンを指定する必要があります。
    Default:
      - ZoneId: cn-hangzhou-h
        VSwitchId: vsw-bp1jhj254nwc7i0ge****
      - ZoneId: cn-hangzhou-i
        VSwitchId: vsw-bp1llps83qqb30znp****
Resources:
  LoadBalancer:
    Type: ALIYUN::ALB::LoadBalancer
    Properties:
      LoadBalancerName: TestLoadBalancer
      LoadBalancerEdition: Basic
      VpcId:
        Ref: VpcId
      LoadBalancerBillingConfig:
        PayType: PostPay
      ZoneMappings:
        Ref: ZoneMappings
      AddressType: Internet
Outputs:
  LoadBalancerEdition:
    Description: ALB インスタンスのエディション。
    Value:
      Fn::GetAtt:
        - LoadBalancer
        - LoadBalancerEdition
  VpcId:
    Description: ALB インスタンスがデプロイされている仮想プライベートクラウド (VPC) の ID。
    Value:
      Fn::GetAtt:
        - LoadBalancer
        - VpcId
  LoadBalancerId:
    Description: ALB インスタンスの ID。
    Value:
      Fn::GetAtt:
        - LoadBalancer
        - LoadBalancerId
  AddressType:
    Description: ALB インスタンスがサービスを提供するために使用する IP アドレスのタイプ。
    Value:
      Fn::GetAtt:
        - LoadBalancer
        - AddressType
  DNSName:
    Description: ALB インスタンスのドメイン名。
    Value:
      Fn::GetAtt:
        - LoadBalancer
        - DNSName
  ZoneMappings:
    Description: ゾーン、vSwitch、およびゾーンにマッピングされているアドレス。
    Value:
      Fn::GetAtt:
        - LoadBalancer
        - ZoneMappings

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "ZoneMappings": {
      "Type": "Json",
      "Description": "ゾーンとゾーン内の vSwitch。少なくとも 2 つのゾーンを指定する必要があります。",
      "Default": [
        {
          "ZoneId": "cn-hangzhou-h",
          "VSwitchId": "vsw-bp1jhj254nwc7i0ge****"
        },
        {
          "ZoneId": "cn-hangzhou-i",
          "VSwitchId": "vsw-bp1llps83qqb30znp****"
        }
      ]
    }
  },
  "Resources": {
    "LoadBalancer": {
      "Type": "ALIYUN::ALB::LoadBalancer",
      "Properties": {
        "LoadBalancerName": "TestLoadBalancer",
        "LoadBalancerEdition": "Basic",
        "VpcId": {
          "Ref": "VpcId"
        },
        "LoadBalancerBillingConfig": {
          "PayType": "PostPay"
        },
        "ZoneMappings": {
          "Ref": "ZoneMappings"
        },
        "AddressType": "Internet"
      }
    }
  },
  "Outputs": {
    "LoadBalancerEdition": {
      "Description": "ALB インスタンスのエディション。",
      "Value": {
        "Fn::GetAtt": [
          "LoadBalancer",
          "LoadBalancerEdition"
        ]
      }
    },
    "VpcId": {
      "Description": "ALB インスタンスがデプロイされている仮想プライベートクラウド (VPC) の ID。",
      "Value": {
        "Fn::GetAtt": [
          "LoadBalancer",
          "VpcId"
        ]
      }
    },
    "LoadBalancerId": {
      "Description": "ALB インスタンスの ID。",
      "Value": {
        "Fn::GetAtt": [
          "LoadBalancer",
          "LoadBalancerId"
        ]
      }
    },
    "AddressType": {
      "Description": "ALB インスタンスがサービスを提供するために使用する IP アドレスのタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "LoadBalancer",
          "AddressType"
        ]
      }
    },
    "DNSName": {
      "Description": "ALB インスタンスのドメイン名。",
      "Value": {
        "Fn::GetAtt": [
          "LoadBalancer",
          "DNSName"
        ]
      }
    },
    "ZoneMappings": {
      "Description": "ゾーン、vSwitch、およびゾーンにマッピングされているアドレス。",
      "Value": {
        "Fn::GetAtt": [
          "LoadBalancer",
          "ZoneMappings"
        ]
      }
    }
  }
}