ALIYUN::NLB::LoadBalancer - Resource Orchestration Service - Centro de documentación de Alibaba Cloud

Crea una instancia de Network Load Balancer (NLB).

Sintaxis

{
  "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
  }
}

Propiedades

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
LoadBalancerName	String	No	Sí	El nombre de la instancia de NLB.	Ninguna
AddressIpVersion	String	No	No	La versión de IP.	Valores válidos: Ipv4 DualStack
ResourceGroupId	String	No	No	El identificador del resource group.	Ninguna
VpcId	String	Sí	No	El identificador de la VPC.	Ninguna
LoadBalancerBillingConfig	Map	No	No	La configuración de facturación.	Para obtener más información, consulte LoadBalancerBillingConfig property.
TrafficAffinityEnabled	Boolean	No	Sí	Indica si se habilita la afinidad de tráfico.	Valores válidos: true false
BandwidthPackageId	String	No	Sí	El identificador del plan de ancho de banda EIP para instancias con acceso a Internet.	Ninguna
AddressType	String	Sí	Sí	El tipo de dirección IPv4.	Valores válidos: Internet: utiliza una dirección IP pública. El nombre de dominio se resuelve a la IP pública para acceder a Internet. Intranet: utiliza una dirección IP privada. El nombre de dominio se resuelve a la IP privada y solo es accesible dentro de la VPC donde se desplegó.
ZoneMappings	List	Sí	No	Las asignaciones entre zonas y vSwitches.	Para obtener más información, consulte ZoneMappings properties.
CrossZoneEnabled	Boolean	No	Sí	Indica si se habilita el balanceo de carga entre zonas.	Valores válidos: true false
LoadBalancerType	String	No	No	El tipo de instancia de NLB.	Ninguna
DeletionProtectionConfig	Map	No	Sí	La configuración de protección contra eliminación.	Para obtener más información, consulte DeletionProtectionConfig properties.
ModificationProtectionConfig	Map	No	Sí	La configuración de protección contra eliminación.	Para obtener más información, consulte ModificationProtectionConfig properties.
Tags	List	No	Sí	Las etiquetas.	Para obtener más información, consulte Tags properties.

Sintaxis de LoadBalancerBillingConfig

"LoadBalancerBillingConfig": {
  "PayType": String
}

Propiedad de LoadBalancerBillingConfig

Propiedad

Tipo

Obligatorio

Editable

Descripción

Restricción

PayType

String

El método de facturación.

Valores válidos:

PayAsYouGo
PostPaid
PayOnDemand
Postpaid
PostPay

Sintaxis de ZoneMappings

"ZoneMappings": [
  {
    "ZoneId": String,
    "VSwitchId": String,
    "AllocationId": String,
    "PrivateIPv4Address": String,
    "LoadBalancerAddresses": List
  }
]

Propiedades de ZoneMappings

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
ZoneId	String	Sí	No	El identificador de la zona.	Puede llamar a la operación DescribeZones para consultar las zonas de la instancia de NLB.
VSwitchId	String	Sí	No	El vSwitch de la zona.	Solo un vSwitch por zona.
AllocationId	String	No	No	El identificador de la EIP.	Ninguna
PrivateIPv4Address	String	No	No	La dirección IPv4.	Ninguna
LoadBalancerAddresses	List	No	No	Los puntos de conexión de la instancia de NLB.	Esta propiedad tiene prioridad sobre AllocationId y EipType en la sección "ZoneMappings". Para obtener más información, consulte LoadBalancerAddresses properties.
EipType	String	No	No	El tipo de EIP.	Valores válidos: Common: EIP Anycast: Anycast EIP Nota Para conocer las regiones donde puede asociar direcciones Anycast EIP con instancias de NLB, consulte Associate an Anycast EIP for nearby access across multiple regions.

Sintaxis de LoadBalancerAddresses

"LoadBalancerAddresses": {
  "AllocationId": String,
  "PrivateIPv4Address": String
}

Propiedades de LoadBalancerAddresses

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
AllocationId	String	Sí	No	El identificador de la EIP.	Ninguna
PrivateIPv4Address	String	No	No	La dirección IPv4.	Ninguna

Sintaxis de DeletionProtectionConfig

"DeletionProtectionConfig": {
  "Enabled": String,
  "Reason": String
}

Propiedades de DeletionProtectionConfig

Propiedad

Tipo

Obligatorio

Editable

Descripción

Restricción

Enabled

String

Sí

Indica si se habilita la protección contra eliminación.

Valores válidos:

true
false (predeterminado)

Reason

String

Sí

El motivo para habilitar o deshabilitar la protección contra eliminación.

De 2 a 128 caracteres. Admite letras, dígitos, puntos (.), guiones bajos (_) y guiones (-). Debe comenzar con una letra.

Sintaxis de ModificationProtectionConfig

"ModificationProtectionConfig": {
  "Reason": String,
  "Status": String
}

Propiedades de ModificationProtectionConfig

Propiedad

Tipo

Obligatorio

Editable

Descripción

Restricción

Reason

String

Sí

El motivo por el que se habilitó la protección contra eliminación.

De 2 a 128 caracteres. Admite letras, dígitos, puntos (.), guiones bajos (_) y guiones (-). Debe comenzar con una letra.

Nota

Esta propiedad solo surte efecto si Status se establece en ConsoleProtection.

Status

String

Sí

Especifique si se habilita la protección contra eliminación.

Valores válidos:

NonProtection: la protección contra eliminación está deshabilitada. En este caso, no puede pasar el motivo para habilitar el modo de solo lectura de la configuración. Debe borrar el valor de la propiedad Reason.
ConsoleProtection: la protección contra eliminación está habilitada. En este caso, puede pasar el motivo para habilitar el modo de solo lectura de la configuración.

Nota

Si se establece en ConsoleProtection, las configuraciones de la instancia no se pueden modificar en la consola de NLB, pero sí mediante llamadas a operaciones de API.

Sintaxis de Tags

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

Propiedades de Tags

Propiedad

Tipo

Obligatorio

Editable

Descripción

Restricción

Key

String

Sí

La clave de la etiqueta.

Hasta 128 caracteres. No puede contener http:// ni https://, y no debe comenzar con acs: ni aliyun.

Máximo de 20 etiquetas por llamada.

Value

String

El valor de la etiqueta.

Hasta 128 caracteres. No puede comenzar con acs: ni aliyun, y no debe contener http:// ni https://.

Máximo de 20 etiquetas por llamada.

Valores de retorno

Fn::GetAtt

AddressIpVersion: la versión de IP de la instancia de NLB.
VpcId: el identificador de la VPC.
LoadBalancerId: el identificador de la instancia de NLB.
AddressType: el tipo de dirección IPv4.
DNSName: el nombre de dominio de NLB.
ZoneMappings: las asignaciones entre zonas y vSwitches.
LoadBalancerType: el tipo de instancia de NLB.
Arn: el Alibaba Cloud Resource Name (ARN).

Ejemplos

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VpcId:
    Type: String
    Description: The ID of the virtual private cloud (VPC) where the NLB instance is deployed.
  AddressType:
    Type: String
    Description: |-
      The type of IP address that the NLB instance uses to provide services. Valid values:
      Internet: The NLB instance uses a public IP address. The domain name of the NLB instance is resolved to the public IP address. Therefore, the NLB instance can be accessed over the Internet.
      Intranet: The NLB instance uses a private IP address. The domain name of the NLB instance is resolved to the private IP address. Therefore, the NLB instance can be accessed over the VPC where the NLB instance is deployed.
    AllowedValues:
      - Internet
      - Intranet
  ZoneMappings:
    Type: Json
    Description: The zones and the vSwitches in the zones. You must specify at least two zones.
    MinLength: 2
    MaxLength: 3
Resources:
  LoadBalancer:
    Type: ALIYUN::NLB::LoadBalancer
    Properties:
      VpcId:
        Ref: VpcId
      AddressType:
        Ref: AddressType
      ZoneMappings:
        Ref: ZoneMappings
Outputs:
  AddressIpVersion:
    Description: The version of IP address that the NLB instance uses to provide services.
    Value:
      Fn::GetAtt:
        - LoadBalancer
        - AddressIpVersion
  VpcId:
    Description: The ID of the virtual private cloud (VPC) where the NLB instance is deployed.
    Value:
      Fn::GetAtt:
        - LoadBalancer
        - VpcId
  LoadBalancerId:
    Description: The ID of the NLB instance.
    Value:
      Fn::GetAtt:
        - LoadBalancer
        - LoadBalancerId
  AddressType:
    Description: The type of IP address that the NLB instance uses to provide services.
    Value:
      Fn::GetAtt:
        - LoadBalancer
        - AddressType
  DNSName:
    Description: The domain name of the NLB instance.
    Value:
      Fn::GetAtt:
        - LoadBalancer
        - DNSName
  ZoneMappings:
    Description: The zones, vSwitches and addresses which are mapped to the zones.
    Value:
      Fn::GetAtt:
        - LoadBalancer
        - ZoneMappings
  LoadBalancerType:
    Description: The type of the NLB instance.
    Value:
      Fn::GetAtt:
        - LoadBalancer
        - LoadBalancerType

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "Description": "The ID of the virtual private cloud (VPC) where the NLB instance is deployed."
    },
    "AddressType": {
      "Type": "String",
      "Description": "The type of IP address that the NLB instance uses to provide services. Valid values:\nInternet: The NLB instance uses a public IP address. The domain name of the NLB instance is resolved to the public IP address. Therefore, the NLB instance can be accessed over the Internet.\nIntranet: The NLB instance uses a private IP address. The domain name of the NLB instance is resolved to the private IP address. Therefore, the NLB instance can be accessed over the VPC where the NLB instance is deployed.",
      "AllowedValues": [
        "Internet",
        "Intranet"
      ]
    },
    "ZoneMappings": {
      "Type": "Json",
      "Description": "The zones and the vSwitches in the zones. You must specify at least two zones.",
      "MinLength": 2,
      "MaxLength": 3
    }
  },
  "Resources": {
    "LoadBalancer": {
      "Type": "ALIYUN::NLB::LoadBalancer",
      "Properties": {
        "VpcId": {
          "Ref": "VpcId"
        },
        "AddressType": {
          "Ref": "AddressType"
        },
        "ZoneMappings": {
          "Ref": "ZoneMappings"
        }
      }
    }
  },
  "Outputs": {
    "AddressIpVersion": {
      "Description": "The version of IP address that the NLB instance uses to provide services.",
      "Value": {
        "Fn::GetAtt": [
          "LoadBalancer",
          "AddressIpVersion"
        ]
      }
    },
    "VpcId": {
      "Description": "The ID of the virtual private cloud (VPC) where the NLB instance is deployed.",
      "Value": {
        "Fn::GetAtt": [
          "LoadBalancer",
          "VpcId"
        ]
      }
    },
    "LoadBalancerId": {
      "Description": "The ID of the NLB instance.",
      "Value": {
        "Fn::GetAtt": [
          "LoadBalancer",
          "LoadBalancerId"
        ]
      }
    },
    "AddressType": {
      "Description": "The type of IP address that the NLB instance uses to provide services.",
      "Value": {
        "Fn::GetAtt": [
          "LoadBalancer",
          "AddressType"
        ]
      }
    },
    "DNSName": {
      "Description": "The domain name of the NLB instance.",
      "Value": {
        "Fn::GetAtt": [
          "LoadBalancer",
          "DNSName"
        ]
      }
    },
    "ZoneMappings": {
      "Description": "The zones, vSwitches and addresses which are mapped to the zones.",
      "Value": {
        "Fn::GetAtt": [
          "LoadBalancer",
          "ZoneMappings"
        ]
      }
    },
    "LoadBalancerType": {
      "Description": "The type of the NLB instance.",
      "Value": {
        "Fn::GetAtt": [
          "LoadBalancer",
          "LoadBalancerType"
        ]
      }
    }
  }
}