ALIYUN::NLB::LoadBalancer は、ネットワークロードバランサ (NLB) インスタンスを作成するために使用されます。
構文
{
"Type": "ALIYUN::NLB::LoadBalancer",
"Properties": {
"LoadBalancerName": String,
"AddressIpVersion": String,
"ResourceGroupId": String,
"VpcId": String,
"LoadBalancerBillingConfig": Map,
"TrafficAffinityEnabled": Boolean,
"BandwidthPackageId": String,
"AddressType": String,
"ZoneMappings": List,
"CrossZoneEnabled": Boolean,
"LoadBalancerType": String,
"DeletionProtectionConfig": Map,
"ModificationProtectionConfig": Map,
"Tags": List
}
}プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
LoadBalancerName | String | いいえ | はい | NLB インスタンスの名前。 | なし |
AddressIpVersion | String | いいえ | いいえ | NLB インスタンスの IP バージョン。 | 有効な値:
|
ResourceGroupId | String | いいえ | いいえ | リソースグループの ID。 | なし |
VpcId | String | はい | いいえ | NLB インスタンスが属する仮想プライベートクラウド (VPC) の ID。 | なし |
LoadBalancerBillingConfig | Map | いいえ | いいえ | NLB インスタンスの課金構成。 | 詳細については、「LoadBalancerBillingConfig プロパティ」をご参照ください。 |
TrafficAffinityEnabled | Boolean | いいえ | はい | トラフィックアフィニティを有効にするかどうかを指定します。 | 有効な値:
|
BandwidthPackageId | String | いいえ | はい | インターネット向け NLB インスタンスの EIP 帯域幅プランの ID。 | なし |
AddressType | String | はい | はい | NLB インスタンスの IPv4 アドレスのタイプ。 | 有効な値:
|
ZoneMappings | List | はい | いいえ | ゾーンと vSwitch 間のマッピング。 | 詳細については、「ZoneMappings プロパティ」をご参照ください。 |
CrossZoneEnabled | Boolean | いいえ | はい | クロスゾーンロードバランシングを有効にするかどうかを指定します。 | 有効な値:
|
LoadBalancerType | String | いいえ | いいえ | NLB インスタンスのタイプ。 | なし |
DeletionProtectionConfig | Map | いいえ | はい | 削除保護の構成。 | 詳細については、「DeletionProtectionConfig プロパティ」をご参照ください。 |
ModificationProtectionConfig | Map | いいえ | はい | 変更保護の構成。 | 詳細については、「ModificationProtectionConfig プロパティ」をご参照ください。 |
Tags | List | いいえ | はい | タグ。 | 詳細については、「Tags プロパティ」をご参照ください。 |
LoadBalancerBillingConfig 構文
"LoadBalancerBillingConfig": {
"PayType": String
}LoadBalancerBillingConfig プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
PayType | String | いいえ | いいえ | NLB インスタンスの課金方法。 | 有効な値:
|
ZoneMappings 構文
"ZoneMappings": [
{
"ZoneId": String,
"VSwitchId": String,
"AllocationId": String,
"PrivateIPv4Address": String,
"LoadBalancerAddresses": List
}
]ZoneMappings プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
ZoneId | String | はい | いいえ | NLB インスタンスのゾーン ID。 | DescribeZones 操作を呼び出して、NLB インスタンスのゾーンをクエリできます。 |
VSwitchId | String | はい | いいえ | ゾーンの vSwitch。 | 各ゾーンでは 1 つの vSwitch のみ使用できます。 |
AllocationId | String | いいえ | いいえ | EIP ID。 | なし |
PrivateIPv4Address | String | いいえ | いいえ | IPv4 アドレス。 | なし |
LoadBalancerAddresses | List | いいえ | いいえ | NLB インスタンスのエンドポイント。 | このプロパティは、「ZoneMappings」セクションの AllocationId および EipType よりも優先されます。詳細については、「LoadBalancerAddresses プロパティ」をご参照ください。 |
EipType | String | いいえ | いいえ | EIP タイプ。 | 有効な値:
説明 Anycast EIP を NLB インスタンスに関連付けることができるリージョンについては、「最も近いアクセスポイント経由でアクセスできるようにするために、Anycast EIP を ALB インスタンスに関連付ける」をご参照ください。 |
LoadBalancerAddresses 構文
"LoadBalancerAddresses": {
"AllocationId": String,
"PrivateIPv4Address": String
}LoadBalancerAddresses プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
AllocationId | String | はい | いいえ | EIP ID。 | なし |
PrivateIPv4Address | String | いいえ | いいえ | IPv4 アドレス。 | なし |
DeletionProtectionConfig 構文
"DeletionProtectionConfig": {
"Enabled": String,
"Reason": String
}DeletionProtectionConfig プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
Enabled | String | はい | はい | 削除保護を有効にするかどうかを指定します。 | 有効な値:
|
Reason | String | いいえ | はい | 削除保護を有効または無効にする理由。 | 値の長さは 2 ~ 128 文字で、文字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。値は文字で始める必要があります。 |
ModificationProtectionConfig 構文
"ModificationProtectionConfig": {
"Reason": String,
"Status": String
}ModificationProtectionConfig プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
Reason | String | いいえ | はい | 変更保護を有効にする理由。 | 値の長さは 2 ~ 128 文字で、文字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。値は文字で始める必要があります。 説明 このプロパティは、Status が ConsoleProtection に設定されている場合にのみ有効になります。 |
Status | String | はい | はい | 設定変更保護が有効になっているかどうかを指定します。 | 有効な値:
説明 このプロパティを ConsoleProtection に設定すると、NLB コンソールでインスタンス構成を変更することはできません。ただし、API 操作を呼び出すことによって、インスタンス構成を変更することはできます。 |
Tags 構文
"Tags": {
"Key": String,
"Value": String
}Tags プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
Key | String | はい | いいえ | タグキー。 | タグキーの長さは最大 128 文字で、 呼び出しごとに最大 20 個のタグを追加できます。 |
Value | String | いいえ | いいえ | タグ値。 | タグ値の長さは最大 128 文字で、 呼び出しごとに最大 20 個のタグを追加できます。 |
戻り値
Fn::GetAtt
AddressIpVersion: NLB インスタンスの IP バージョン。
VpcId: NLB インスタンスが属する VPC の ID。
LoadBalancerId: NLB インスタンスの ID。
AddressType: NLB インスタンスで使用される IPv4 アドレスのタイプ。
DNSName: NLB インスタンスのドメイン名。
ZoneMappings: ゾーンと vSwitch 間のマッピング。
LoadBalancerType: NLB インスタンスのタイプ。
Arn: Alibaba Cloud リソースネーム (ARN)。
例
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
VpcId:
Type: String
Description: NLB インスタンスがデプロイされている仮想プライベートクラウド (VPC) の ID。
AddressType:
Type: String
Description: |-
NLB インスタンスがサービスを提供するために使用する IP アドレスのタイプ。有効な値:
Internet: NLB インスタンスはパブリック IP アドレスを使用します。NLB インスタンスのドメイン名はパブリック IP アドレスに解決されます。そのため、NLB インスタンスにはインターネット経由でアクセスできます。
Intranet: NLB インスタンスはプライベート IP アドレスを使用します。NLB インスタンスのドメイン名はプライベート IP アドレスに解決されます。そのため、NLB インスタンスは、NLB インスタンスがデプロイされている VPC 経由でアクセスできます。
AllowedValues:
- Internet
- Intranet
ZoneMappings:
Type: Json
Description: ゾーンとゾーン内の vSwitch。少なくとも 2 つのゾーンを指定する必要があります。
MinLength: 2
MaxLength: 3
Resources:
LoadBalancer:
Type: ALIYUN::NLB::LoadBalancer
Properties:
VpcId:
Ref: VpcId
AddressType:
Ref: AddressType
ZoneMappings:
Ref: ZoneMappings
Outputs:
AddressIpVersion:
Description: NLB インスタンスがサービスの提供に使用する IP アドレスのバージョン。
Value:
Fn::GetAtt:
- LoadBalancer
- AddressIpVersion
VpcId:
Description: NLB インスタンスがデプロイされている仮想プライベートクラウド (VPC) の ID。
Value:
Fn::GetAtt:
- LoadBalancer
- VpcId
LoadBalancerId:
Description: NLB インスタンスの ID。
Value:
Fn::GetAtt:
- LoadBalancer
- LoadBalancerId
AddressType:
Description: NLB インスタンスがサービスの提供に使用する IP アドレスのタイプ。
Value:
Fn::GetAtt:
- LoadBalancer
- AddressType
DNSName:
Description: NLB インスタンスのドメイン名。
Value:
Fn::GetAtt:
- LoadBalancer
- DNSName
ZoneMappings:
Description: ゾーンにマッピングされているゾーン、vSwitch、およびアドレス。
Value:
Fn::GetAtt:
- LoadBalancer
- ZoneMappings
LoadBalancerType:
Description: NLB インスタンスのタイプ。
Value:
Fn::GetAtt:
- LoadBalancer
- LoadBalancerType
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"VpcId": {
"Type": "String",
"Description": "NLB インスタンスがデプロイされている仮想プライベートクラウド (VPC) の ID。" // VPC の ID
},
"AddressType": {
"Type": "String",
"Description": "NLB インスタンスがサービスを提供するために使用する IP アドレスのタイプ。有効な値: // IP アドレスのタイプ\nInternet: NLB インスタンスはパブリック IP アドレスを使用します。NLB インスタンスのドメイン名はパブリック IP アドレスに解決されます。そのため、NLB インスタンスにはインターネット経由でアクセスできます。\nIntranet: NLB インスタンスはプライベート IP アドレスを使用します。NLB インスタンスのドメイン名はプライベート IP アドレスに解決されます。そのため、NLB インスタンスは、NLB インスタンスがデプロイされている VPC 経由でアクセスできます。",
"AllowedValues": [
"Internet",
"Intranet"
]
},
"ZoneMappings": {
"Type": "Json",
"Description": "ゾーンとゾーン内の vSwitch。少なくとも 2 つのゾーンを指定する必要があります。", // ゾーンと vSwitch
"MinLength": 2,
"MaxLength": 3
}
},
"Resources": {
"LoadBalancer": {
"Type": "ALIYUN::NLB::LoadBalancer",
"Properties": {
"VpcId": {
"Ref": "VpcId"
},
"AddressType": {
"Ref": "AddressType"
},
"ZoneMappings": {
"Ref": "ZoneMappings"
}
}
}
},
"Outputs": {
"AddressIpVersion": {
"Description": "NLB インスタンスがサービスの提供に使用する IP アドレスのバージョン。", // IP アドレスのバージョン
"Value": {
"Fn::GetAtt": [
"LoadBalancer",
"AddressIpVersion"
]
}
},
"VpcId": {
"Description": "NLB インスタンスがデプロイされている仮想プライベートクラウド (VPC) の ID。", // VPC の ID
"Value": {
"Fn::GetAtt": [
"LoadBalancer",
"VpcId"
]
}
},
"LoadBalancerId": {
"Description": "NLB インスタンスの ID。", // NLB インスタンスの ID
"Value": {
"Fn::GetAtt": [
"LoadBalancer",
"LoadBalancerId"
]
}
},
"AddressType": {
"Description": "NLB インスタンスがサービスの提供に使用する IP アドレスのタイプ。", // IP アドレスのタイプ
"Value": {
"Fn::GetAtt": [
"LoadBalancer",
"AddressType"
]
}
},
"DNSName": {
"Description": "NLB インスタンスのドメイン名。", // ドメイン名
"Value": {
"Fn::GetAtt": [
"LoadBalancer",
"DNSName"
]
}
},
"ZoneMappings": {
"Description": "ゾーンにマッピングされているゾーン、vSwitch、およびアドレス。", // ゾーン、vSwitch、アドレス
"Value": {
"Fn::GetAtt": [
"LoadBalancer",
"ZoneMappings"
]
}
},
"LoadBalancerType": {
"Description": "NLB インスタンスのタイプ。", // NLB インスタンスのタイプ
"Value": {
"Fn::GetAtt": [
"LoadBalancer",
"LoadBalancerType"
]
}
}
}
}