DATASOURCE::NLB::LoadBalancer - Resource Orchestration Service

The DATASOURCE::NLB::LoadBalancer type is used to query the basic information of single Network Load Balancer (NLB) instance.

Syntax

{
  "Type": "DATASOURCE::NLB::LoadBalancer",
  "Properties": {
    "LoadBalancerId": String,
    "RefreshOptions": String
  }
}

Properties

Property name

Type

Required

Update allowed

Description

Constraint

LoadBalancerId

String

Yes

The ID of the NLB instance.

None

RefreshOptions

String

Yes

The data source resources refresh mode when the stack is updated.

Valid values:

Never (default): never refresh data source resources when the stack is updated.
Always: always refresh data source resources when the stack is updated.

Return values

Fn::GetAtt

AddressIpVersion: The protocol version.
ResourceGroupId: The resource group ID.
LoadBalancerBillingConfig: The billing information of the NLB instance.
Cps: The maximum number of new connections per second supported by the NLB instance in each zone (virtual IP address).
CreateTime: The time when the NLB instance was created.
LoadBalancerId: The LoadBalancer ID.
DNSName: The domain name of the NLB instance.
ZoneMappings: The list of zones and vSwitches in the zones.
ModificationProtectionConfig: The configuration of the configuration read-only mode.
SecurityGroupIds: The ID of the security group associated with the NLB instance.
OperationLocks: The information about the locked NLB instance.
Ipv6AddressType: The IPv6 address type of the NLB instance.
CrossZoneEnabled: Indicates whether the NLB instance is accessible across zones.
LoadBalancerType: The type of the Server Load Balancer (SLB) instance. Set the value to network, which specifies NLB.
LoadBalancerName: The NLB instance name.
DeletionProtectionConfig: The configuration of the deletion protection feature.
VpcId: The virtual private cloud (VPC) ID of the NLB instance.
BandwidthPackageId: The ID of the EIP bandwidth plan.
RegionId: The region ID of the NLB instance.
AddressType: The IPv4 address type of the NLB instance.
LoadBalancerBusinessStatus: The status of workloads on the NLB instance.
LoadBalancerStatus: The NLB instance status.
Tags: The tags of the resource.

Example

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  LoadBalancerId:
    Type: String
    Description:
      en: ID of the LoadBalancer.
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::NLB::LoadBalancer
    Properties:
      LoadBalancerId:
        Ref: LoadBalancerId
Outputs:
  AddressIpVersion:
    Description: The protocol version.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AddressIpVersion
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  LoadBalancerBillingConfig:
    Description: The billing information of the NLB instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LoadBalancerBillingConfig
  Cps:
    Description: The maximum number of new connections per second supported by the NLB instance in each zone (virtual IP address).
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Cps
  CreateTime:
    Description: The time when the NLB instance was created.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  LoadBalancerId:
    Description: ID of the LoadBalancer.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LoadBalancerId
  DNSName:
    Description: The domain name of the NLB instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DNSName
  ZoneMappings:
    Description: The list of zones and vSwitches in the zones.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ZoneMappings
  ModificationProtectionConfig:
    Description: The configuration of the configuration read-only mode.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ModificationProtectionConfig
  SecurityGroupIds:
    Description: The ID of the security group associated with the NLB instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SecurityGroupIds
  OperationLocks:
    Description: The information about the locked NLB instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - OperationLocks
  Ipv6AddressType:
    Description: The IPv6 network type of the NLB instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Ipv6AddressType
  CrossZoneEnabled:
    Description: Indicates whether the NLB instance is accessible across zones.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CrossZoneEnabled
  LoadBalancerType:
    Description: The type of the Server Load Balancer (SLB) instance. Set the value to network, which specifies NLB.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LoadBalancerType
  LoadBalancerName:
    Description: The NLB instance name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LoadBalancerName
  DeletionProtectionConfig:
    Description: The configuration of the deletion protection feature.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DeletionProtectionConfig
  VpcId:
    Description: The VPC ID of the NLB instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VpcId
  BandwidthPackageId:
    Description: The ID of the EIP bandwidth plan.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BandwidthPackageId
  RegionId:
    Description: The region ID of the NLB instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RegionId
  AddressType:
    Description: The IPv4 network type of the NLB instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AddressType
  LoadBalancerBusinessStatus:
    Description: The status of workloads on the NLB instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LoadBalancerBusinessStatus
  LoadBalancerStatus:
    Description: The NLB instance status.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LoadBalancerStatus
  Tags:
    Description: The tags of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "LoadBalancerId": {
      "Type": "String",
      "Description": {
        "en": "ID of the LoadBalancer."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::NLB::LoadBalancer",
      "Properties": {
        "LoadBalancerId": {
          "Ref": "LoadBalancerId"
        }
      }
    }
  },
  "Outputs": {
    "AddressIpVersion": {
      "Description": "The protocol version.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AddressIpVersion"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "LoadBalancerBillingConfig": {
      "Description": "The billing information of the NLB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LoadBalancerBillingConfig"
        ]
      }
    },
    "Cps": {
      "Description": "The maximum number of new connections per second supported by the NLB instance in each zone (virtual IP address).",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Cps"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the NLB instance was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "LoadBalancerId": {
      "Description": "ID of the LoadBalancer.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LoadBalancerId"
        ]
      }
    },
    "DNSName": {
      "Description": "The domain name of the NLB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DNSName"
        ]
      }
    },
    "ZoneMappings": {
      "Description": "The list of zones and vSwitches in the zones.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneMappings"
        ]
      }
    },
    "ModificationProtectionConfig": {
      "Description": "The configuration of the configuration read-only mode.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ModificationProtectionConfig"
        ]
      }
    },
    "SecurityGroupIds": {
      "Description": "The ID of the security group associated with the NLB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityGroupIds"
        ]
      }
    },
    "OperationLocks": {
      "Description": "The information about the locked NLB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "OperationLocks"
        ]
      }
    },
    "Ipv6AddressType": {
      "Description": "The IPv6 network type of the NLB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Ipv6AddressType"
        ]
      }
    },
    "CrossZoneEnabled": {
      "Description": "Indicates whether the NLB instance is accessible across zones.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CrossZoneEnabled"
        ]
      }
    },
    "LoadBalancerType": {
      "Description": "The type of the Server Load Balancer (SLB) instance. Set the value to network, which specifies NLB.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LoadBalancerType"
        ]
      }
    },
    "LoadBalancerName": {
      "Description": "The NLB instance name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LoadBalancerName"
        ]
      }
    },
    "DeletionProtectionConfig": {
      "Description": "The configuration of the deletion protection feature.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DeletionProtectionConfig"
        ]
      }
    },
    "VpcId": {
      "Description": "The VPC ID of the NLB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcId"
        ]
      }
    },
    "BandwidthPackageId": {
      "Description": "The ID of the EIP bandwidth plan.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BandwidthPackageId"
        ]
      }
    },
    "RegionId": {
      "Description": "The region ID of the NLB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RegionId"
        ]
      }
    },
    "AddressType": {
      "Description": "The IPv4 network type of the NLB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AddressType"
        ]
      }
    },
    "LoadBalancerBusinessStatus": {
      "Description": "The status of workloads on the NLB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LoadBalancerBusinessStatus"
        ]
      }
    },
    "LoadBalancerStatus": {
      "Description": "The NLB instance status.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LoadBalancerStatus"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    }
  }
}