ALIYUN::SLB::LoadBalancer类型用于创建负载均衡实例。

语法

{
  "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,
    "ModificationProtectionReason": String,
    "ModificationProtectionStatus": String,
    "AddressIPVersion": String,
    "AutoRenewPeriod": Integer,
    "AutoRenew": Boolean,
    "InstanceChargeType": String
  }
}

属性

属性名称 类型 必须 允许更新 描述 约束
ResourceGroupId String 资源组ID。
DeletionProtection Boolean 是否开启删除保护。 取值:
  • true:开启删除保护。
  • false(默认值):不开启删除保护。
VpcId String 专有网络ID。
SlaveZoneId String 负载均衡实例的可用区ID。
Bandwidth Integer 按固定带宽计费方式的公网类型实例的带宽峰值。

取值范围:1~10000。

单位:Mbps。

默认值:1。

专有网络实例系统会统一按流量计费设置该参数。

  • 针对按固定带宽计费方式的公网类型实例,需要将当前设定值通过Listener中的Bandwidth参数进行分配后才能生效。
  • 针对按使用流量计费方式的公网类型实例的带宽峰值,请直接通过Listener上Bandwidth参数进行设定,此时该参数会被忽略。
AddressType String 负载均衡实例的地址类型。
取值:
  • internet(默认值):负载均衡具有公网IP地址,DNS域名被解析到公网IP,因此可以在公网环境访问。
  • intranet:负载均衡只有私网IP地址,DNS域名被解析到私网IP,因此只能被负载均衡所在VPC的内网环境访问。
VSwitchId String 交换机ID。
LoadBalancerName String 负载均衡实例的名称。 长度为1~80个字符。可包含英文字母、数字、短划线(-)、正斜线(/)、半角句号(.)和下划线(_)。

不指定该参数时,默认由系统分配一个实例名称。

InternetChargeType String 公网类型实例付费方式。
取值:
  • paybybandwidth:按带宽计费。
  • paybytraffic(默认值):按流量计费。
MasterZoneId String 实例的主可用区ID。
Tags List 负载均衡实例的标签。 最多支持5个标签。

更多信息,请参见Tags属性

LoadBalancerSpec String 负载均衡实例的规格。 取值:
  • slb.s1.small(默认值)
  • slb.s2.small
  • slb.s2.medium
  • slb.s3.small
  • slb.s3.medium
  • slb.s3.large
  • slb.s3.xlarge
  • slb.s3.xxlarge

每个地域支持的规格不同。关于每种规格的说明,参见性能保障型实例

AutoPay Boolean 是否自动支付预付费公网实例的账单。 取值:
  • true(默认值):自动支付预付费公网实例的账单。
  • false:不自动支付预付费公网实例的账单。
PayType String 实例的计费类型。 取值:
  • PayOnDemand:按量付费。
  • PrePay:预付费。
PricingCycle String 预付费公网实例的计费周期。 取值:
  • month:月。
  • year:年。
Duration Number 预付费公网实例的购买时长。 取值范围:
  • PricingCycle为month时:1~9。
  • PricingCycle为year时:1~3。
ModificationProtectionStatus String 修改保护状态。 取值:
  • NonProtection(默认值):不开启。
  • ConsoleProtection:允许通过控制台修改。
ModificationProtectionReason String 修改保护状态的原因。 长度为1~80个字符,以英文字母或汉字开头。可包含英文字母、汉字、数字、半角句号(.)和短划线(-)。
AddressIPVersion String IP版本。 取值:
  • ipv4
  • ipv6
    说明 取值为ipv6时,请注意支持区域和规范。
AutoRenewPeriod Integer 自动续费周期。 当AutoRenew取值为true时生效。

取值范围:

  • 当PricingCycle取值为month时:1~9。
  • 当PricingCycle取值为year时:1~3。
AutoRenew Boolean 是否为实例启用自动续订。 取值:
  • true:已启用自动续订。
  • false(默认值):未启用自动续订。
InstanceChargeType String 实例计费方式。 取值:
  • PayBySpec(默认值):按规格计费。
  • PayByCLCU:按量计费。
    说明 当PayType(实例付费模式)取值为PayOnDemand(按量付费)时,该参数生效。

Tags语法

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

Tags属性

属性名称 类型 必须 允许更新 描述 约束
Key String 标签键。 长度为1~64个字符,不能以aliyunacs:开头,不能包含http://https://
Value String 标签值。 长度为0~128个字符,不能以aliyunacs:开头,不能包含http://https://

返回值

Fn::GetAtt

  • LoadBalancerId:负载均衡实例的ID。
  • NetworkType:负载均衡实例的网络类型。
  • AddressType:负载均衡实例的地址类型。
  • IpAddress:负载均衡实例的IP地址。
  • OrderId:订单ID。
  • Bandwidth:带宽峰值。
  • PayType:实例的计费类型。
  • AddressIPVersion:负载均衡实例的IP版本。
  • SlaveZoneId:负载均衡实例的备可用区ID。
  • MasterZoneId:负载均衡实例的主可用区ID。
  • LoadBalancerName:负载均衡实例的名称。
  • ResourceGroupId:资源组ID。
  • LoadBalancerSpec:负载均衡实例的规格。
  • VpcId:负载均衡实例的所属专有网络的ID。
  • VSwitchId:负载均衡实例的所属交换机的ID。

示例

  • JSON格式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Description": "Test SLB LoadBalancer",
      "Parameters": {
        "LoadBalancerName": {
          "Type": "String",
          "Default": "mytest"
        },
        "MasterZoneId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance:ZoneId"
        },
        "LoadBalancerSpec": {
          "Type": "String",
          "Default": "slb.s1.small"
        }
      },
      "Resources": {
        "LoadBalance": {
          "Type": "ALIYUN::SLB::LoadBalancer",
          "Properties": {
            "PayType": "PayOnDemand",
            "AddressType": "internet",
            "LoadBalancerSpec": {
              "Ref": "LoadBalancerSpec"
            },
            "MasterZoneId": {
              "Ref": "MasterZoneId"
            },
            "LoadBalancerName": {
              "Ref": "LoadBalancerName"
            }
          }
        }
      },
      "Outputs": {
      }
    }
  • YAML格式

    ROSTemplateFormatVersion: '2015-09-01'
    Description: Test SLB LoadBalancer
    Parameters:
      LoadBalancerName:
        Type: String
        Default: mytest
      MasterZoneId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance:ZoneId
      LoadBalancerSpec:
        Type: String
        Default: slb.s1.small
    Resources:
      LoadBalance:
        Type: ALIYUN::SLB::LoadBalancer
        Properties:
          PayType: PayOnDemand
          AddressType: internet
          LoadBalancerSpec:
            Ref: LoadBalancerSpec
          MasterZoneId:
            Ref: MasterZoneId
          LoadBalancerName:
            Ref: LoadBalancerName
    Outputs: {}

更多示例,请参见创建负载均衡实例、创建主备服务器组和向负载均衡添加后端服务器的组合示例:JSON示例YAML示例