ALIYUN::SLB::LoadBalancer is used to create an SLB instance.

Syntax

{
  "Type": "ALIYUN::SLB::LoadBalancer",
  "Properties": {
    "DeletionProtection": Boolean,
    "AddressType": String,
    "Tags": List,
    "InternetChargeType": String,
    "Bandwidth": Integer,
    "SlaveZoneId": String,
    "ResourceGroupId": String,
    "AutoPay": Boolean,
    "VpcId": String,
    "PricingCycle": String,
    "LoadBalancerName": String,
    "Duration": Number,
    "VSwitchId": String,
    "LoadBalancerSpec": String,
    "MasterZoneId": String,
    "PayType": String
  }
}

Properties

Name Type Required Editable Description Validity
ResourceGroupId String No No The ID of the resource group. None
DeletionProtection Boolean No No Specifies whether to enable deletion protection to protect the SLB instance from being mistakenly deleted. Valid values: true and false.
VpcId String No No The ID of the VPC to which the SLB instance belongs. None
SlaveZoneId String No No The ID of the secondary zone to which the SLB instance belongs. None
Bandwidth Integer No No The peak bandwidth of SLB instances that are connected to the Internet and billed by fixed bandwidth.

For SLB instances that are connected to the Internet and billed by fixed bandwidth, this parameter is valid only when the Bandwidth parameter of the SLB listener is specified. For SLB instances that are connected to the Internet and billed by traffic, this parameter is ignored. To set the peak bandwidth of these SLB instances, specify the Bandwidth parameter of the SLB listener.

Unit: Mbit/s. Valid values: 1 to 1000.

Default value: 1.

VPC-connected instances are billed by traffic.
AddressType String No No The address type of the SLB instance.

Valid values: internet and intranet.

Default value: internet.
VSwitchId String No No The ID of the VSwitch in the specified VPC. None
LoadBalancerName String No No The name of the SLB instance. You can set the name to any string. The name must be 1 to 80 characters in length and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), and underscores (_). If this parameter is not specified, the system assigns a value to it.
InternetChargeType String No No The billing method of SLB instances that are connected to the Internet.

Valid values: paybybandwidth and paybytraffic.

Default value: paybytraffic.
MasterZoneId String No No The ID of the primary zone to which the SLB instance belongs. None
Tags List No No The list of tags to be attached to the SLB instance. The tags are listed in JSON format. Each tag includes a TagKey and a TagValue. A maximum of five tags can be attached to an SLB instance.
LoadBalancerSpec String No No The type of the SLB instance.

Valid values:

  • slb.s1.small
  • slb.s2.small
  • slb.s2.medium
  • slb.s3.small
  • slb.s3.medium
  • slb.s3.large

The available types vary by region. For more information about instance types, see Guaranteed-performance instances.

AutoPay Boolean No No Specifies whether to automatically pay for subscription SLB instances that are connected to the Internet. Valid values: true and false. Default value: false.
Note This parameter is valid only on the China site (aliyun.com).
PayType String No No The billing method of the SLB instance. Valid values:
  • PayOnDemand
  • PrePay
PricingCycle String No No The billing cycle of subscription SLB instances that are connected to the Internet. Valid values: month and year.
Note This parameter is valid only on the China site (aliyun.com).
Duration Number No No The duration of subscription SLB instances that are connected to the Internet. Valid values:
  • Valid values when the PricingCycle parameter is set to month: 1 to 9.
  • Valid values when the PricingCycle parameter is set to year: 1 to 3.
Note This parameter is valid only on the China site (aliyun.com).

Tags syntax

"Tags": [
  {
    "Value": String ,
    "Key": String 
  }
]

Tags properties

Name Type Required Editable Description Validity
Key String Yes No None None
Value String No No None None

Response parameters

Fn::GetAtt

  • LoadBalancerId: the unique ID of the SLB instance.
  • NetworkType: the network type of the SLB instance, which can be vpc or classic.
  • AddressType: the address type of the SLB instance, which can be intranet or internet.
  • IpAddress: the IP address of the SLB instance.
  • OrderId: the order ID of the SLB instance.

Examples

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "CreateLoadBalance": {
      "Type": "ALIYUN::SLB::LoadBalancer",
      "Properties": {
        "LoadBalancerName": "createdByHeat",
        "AddressType": "internet",
        "InternetChargeType": "paybybandwidth",
      }
    }
  },
  "Outputs": {
    "LoadBalanceDetails": {
      "Value": {
        "Fn::GetAtt": ["CreateLoadBalance", "LoadBalancerId"]}
    }
  }
}