volcenginecc.clb.NlbServerGroup

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  nLBServerGroupDemo:
    type: volcenginecc:clb:NlbServerGroup
    name: NLBServerGroupDemo
    properties:
      bypassSecurityGroupEnabled: false
      healthCheck:
        enabled: false
      vpcId: vpc-13f8k4dwdsydc3n6nu5rxxxxx
      projectName: default
      serverGroupName: NLBServerGroupDemo.Aa1xxxxx
      type: instance
      protocol: UDP
      description: test.IPV4.UDP.WLC_=
      scheduler: wlc
      ipAddressVersion: ipv4
      anyPortEnabled: false
      connectionDrainEnabled: false
      preserveClientIpEnabled: false
      sessionPersistenceEnabled: false
      proxyProtocolType: off
      servers:
        - instance_id: i-ye2fvd0qo0bw80ctxxxxx
          type: ecs
          ip: 192.168.xx.76
          port: 10
          weight: 50
        - instance_id: eni-mirt64nt1xq85smt1a3xxxxx
          type: eni
          ip: 192.168.xx.77
          port: 20
          weight: 50
      tags:
        - key: env
          value: test

Create NlbServerGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new NlbServerGroup(name: string, args: NlbServerGroupArgs, opts?: CustomResourceOptions);

@overload
def NlbServerGroup(resource_name: str,
                   args: NlbServerGroupArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def NlbServerGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   protocol: Optional[str] = None,
                   vpc_id: Optional[str] = None,
                   proxy_protocol_type: Optional[str] = None,
                   scheduler: Optional[str] = None,
                   description: Optional[str] = None,
                   health_check: Optional[NlbServerGroupHealthCheckArgs] = None,
                   ip_address_version: Optional[str] = None,
                   preserve_client_ip_enabled: Optional[bool] = None,
                   project_name: Optional[str] = None,
                   connection_drain_enabled: Optional[bool] = None,
                   any_port_enabled: Optional[bool] = None,
                   connection_drain_timeout: Optional[int] = None,
                   server_group_name: Optional[str] = None,
                   servers: Optional[Sequence[NlbServerGroupServerArgs]] = None,
                   session_persistence_enabled: Optional[bool] = None,
                   session_persistence_timeout: Optional[int] = None,
                   tags: Optional[Sequence[NlbServerGroupTagArgs]] = None,
                   timestamp_remove_enabled: Optional[bool] = None,
                   type: Optional[str] = None,
                   bypass_security_group_enabled: Optional[bool] = None)

func NewNlbServerGroup(ctx *Context, name string, args NlbServerGroupArgs, opts ...ResourceOption) (*NlbServerGroup, error)

public NlbServerGroup(string name, NlbServerGroupArgs args, CustomResourceOptions? opts = null)

public NlbServerGroup(String name, NlbServerGroupArgs args)
public NlbServerGroup(String name, NlbServerGroupArgs args, CustomResourceOptions options)

type: volcenginecc:clb:NlbServerGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args NlbServerGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args NlbServerGroupArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args NlbServerGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NlbServerGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args NlbServerGroupArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

NlbServerGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The NlbServerGroup resource accepts the following input properties:

Protocol string: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
VpcId string: ID of the private network to which the server group belongs
AnyPortEnabled bool: Enable all-port forwarding
BypassSecurityGroupEnabled bool: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
ConnectionDrainEnabled bool: Enable graceful connection termination.
ConnectionDrainTimeout int: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
Description string: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
HealthCheck Volcengine.NlbServerGroupHealthCheck: Health check parameters
IpAddressVersion string: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
PreserveClientIpEnabled bool: Enable source address persistence
ProjectName string: Project name
ProxyProtocolType string: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
Scheduler string: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
ServerGroupName string: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
Servers List<Volcengine.NlbServerGroupServer>
SessionPersistenceEnabled bool: Enable session persistence.
SessionPersistenceTimeout int: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
Tags List<Volcengine.NlbServerGroupTag>
TimestampRemoveEnabled bool: Enable removal of TCP/HTTP/HTTPS packet timestamps
Type string: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.

Protocol string: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
VpcId string: ID of the private network to which the server group belongs
AnyPortEnabled bool: Enable all-port forwarding
BypassSecurityGroupEnabled bool: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
ConnectionDrainEnabled bool: Enable graceful connection termination.
ConnectionDrainTimeout int: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
Description string: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
HealthCheck NlbServerGroupHealthCheckArgs: Health check parameters
IpAddressVersion string: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
PreserveClientIpEnabled bool: Enable source address persistence
ProjectName string: Project name
ProxyProtocolType string: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
Scheduler string: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
ServerGroupName string: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
Servers []NlbServerGroupServerArgs
SessionPersistenceEnabled bool: Enable session persistence.
SessionPersistenceTimeout int: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
Tags []NlbServerGroupTagArgs
TimestampRemoveEnabled bool: Enable removal of TCP/HTTP/HTTPS packet timestamps
Type string: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.

protocol String: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
vpcId String: ID of the private network to which the server group belongs
anyPortEnabled Boolean: Enable all-port forwarding
bypassSecurityGroupEnabled Boolean: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
connectionDrainEnabled Boolean: Enable graceful connection termination.
connectionDrainTimeout Integer: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
description String: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
healthCheck NlbServerGroupHealthCheck: Health check parameters
ipAddressVersion String: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
preserveClientIpEnabled Boolean: Enable source address persistence
projectName String: Project name
proxyProtocolType String: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
scheduler String: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
serverGroupName String: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
servers List<NlbServerGroupServer>
sessionPersistenceEnabled Boolean: Enable session persistence.
sessionPersistenceTimeout Integer: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
tags List<NlbServerGroupTag>
timestampRemoveEnabled Boolean: Enable removal of TCP/HTTP/HTTPS packet timestamps
type String: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.

protocol string: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
vpcId string: ID of the private network to which the server group belongs
anyPortEnabled boolean: Enable all-port forwarding
bypassSecurityGroupEnabled boolean: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
connectionDrainEnabled boolean: Enable graceful connection termination.
connectionDrainTimeout number: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
description string: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
healthCheck NlbServerGroupHealthCheck: Health check parameters
ipAddressVersion string: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
preserveClientIpEnabled boolean: Enable source address persistence
projectName string: Project name
proxyProtocolType string: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
scheduler string: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
serverGroupName string: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
servers NlbServerGroupServer[]
sessionPersistenceEnabled boolean: Enable session persistence.
sessionPersistenceTimeout number: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
tags NlbServerGroupTag[]
timestampRemoveEnabled boolean: Enable removal of TCP/HTTP/HTTPS packet timestamps
type string: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.

protocol str: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
vpc_id str: ID of the private network to which the server group belongs
any_port_enabled bool: Enable all-port forwarding
bypass_security_group_enabled bool: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
connection_drain_enabled bool: Enable graceful connection termination.
connection_drain_timeout int: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
description str: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
health_check NlbServerGroupHealthCheckArgs: Health check parameters
ip_address_version str: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
preserve_client_ip_enabled bool: Enable source address persistence
project_name str: Project name
proxy_protocol_type str: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
scheduler str: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
server_group_name str: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
servers Sequence[NlbServerGroupServerArgs]
session_persistence_enabled bool: Enable session persistence.
session_persistence_timeout int: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
tags Sequence[NlbServerGroupTagArgs]
timestamp_remove_enabled bool: Enable removal of TCP/HTTP/HTTPS packet timestamps
type str: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.

protocol String: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
vpcId String: ID of the private network to which the server group belongs
anyPortEnabled Boolean: Enable all-port forwarding
bypassSecurityGroupEnabled Boolean: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
connectionDrainEnabled Boolean: Enable graceful connection termination.
connectionDrainTimeout Number: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
description String: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
healthCheck Property Map: Health check parameters
ipAddressVersion String: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
preserveClientIpEnabled Boolean: Enable source address persistence
projectName String: Project name
proxyProtocolType String: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
scheduler String: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
serverGroupName String: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
servers List<Property Map>
sessionPersistenceEnabled Boolean: Enable session persistence.
sessionPersistenceTimeout Number: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
tags List<Property Map>
timestampRemoveEnabled Boolean: Enable removal of TCP/HTTP/HTTPS packet timestamps
type String: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.

Outputs

All input properties are implicitly available as output properties. Additionally, the NlbServerGroup resource produces the following output properties:

AccountId string: Account ID
CreatedTime string: Backend server group creation time
Id string: The provider-assigned unique ID for this managed resource.
RelatedLoadBalancerIds List<string>: NLB instance associated with the server group.
ServerCount int: Number of backend servers in the server group.
ServerGroupId string: Server group ID
Status string: Server group status
UpdatedTime string: Last update time of the backend server group.

AccountId string: Account ID
CreatedTime string: Backend server group creation time
Id string: The provider-assigned unique ID for this managed resource.
RelatedLoadBalancerIds []string: NLB instance associated with the server group.
ServerCount int: Number of backend servers in the server group.
ServerGroupId string: Server group ID
Status string: Server group status
UpdatedTime string: Last update time of the backend server group.

accountId String: Account ID
createdTime String: Backend server group creation time
id String: The provider-assigned unique ID for this managed resource.
relatedLoadBalancerIds List<String>: NLB instance associated with the server group.
serverCount Integer: Number of backend servers in the server group.
serverGroupId String: Server group ID
status String: Server group status
updatedTime String: Last update time of the backend server group.

accountId string: Account ID
createdTime string: Backend server group creation time
id string: The provider-assigned unique ID for this managed resource.
relatedLoadBalancerIds string[]: NLB instance associated with the server group.
serverCount number: Number of backend servers in the server group.
serverGroupId string: Server group ID
status string: Server group status
updatedTime string: Last update time of the backend server group.

account_id str: Account ID
created_time str: Backend server group creation time
id str: The provider-assigned unique ID for this managed resource.
related_load_balancer_ids Sequence[str]: NLB instance associated with the server group.
server_count int: Number of backend servers in the server group.
server_group_id str: Server group ID
status str: Server group status
updated_time str: Last update time of the backend server group.

accountId String: Account ID
createdTime String: Backend server group creation time
id String: The provider-assigned unique ID for this managed resource.
relatedLoadBalancerIds List<String>: NLB instance associated with the server group.
serverCount Number: Number of backend servers in the server group.
serverGroupId String: Server group ID
status String: Server group status
updatedTime String: Last update time of the backend server group.

Look up Existing NlbServerGroup Resource

Get an existing NlbServerGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: NlbServerGroupState, opts?: CustomResourceOptions): NlbServerGroup

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        any_port_enabled: Optional[bool] = None,
        bypass_security_group_enabled: Optional[bool] = None,
        connection_drain_enabled: Optional[bool] = None,
        connection_drain_timeout: Optional[int] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        health_check: Optional[NlbServerGroupHealthCheckArgs] = None,
        ip_address_version: Optional[str] = None,
        preserve_client_ip_enabled: Optional[bool] = None,
        project_name: Optional[str] = None,
        protocol: Optional[str] = None,
        proxy_protocol_type: Optional[str] = None,
        related_load_balancer_ids: Optional[Sequence[str]] = None,
        scheduler: Optional[str] = None,
        server_count: Optional[int] = None,
        server_group_id: Optional[str] = None,
        server_group_name: Optional[str] = None,
        servers: Optional[Sequence[NlbServerGroupServerArgs]] = None,
        session_persistence_enabled: Optional[bool] = None,
        session_persistence_timeout: Optional[int] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[NlbServerGroupTagArgs]] = None,
        timestamp_remove_enabled: Optional[bool] = None,
        type: Optional[str] = None,
        updated_time: Optional[str] = None,
        vpc_id: Optional[str] = None) -> NlbServerGroup

func GetNlbServerGroup(ctx *Context, name string, id IDInput, state *NlbServerGroupState, opts ...ResourceOption) (*NlbServerGroup, error)

public static NlbServerGroup Get(string name, Input<string> id, NlbServerGroupState? state, CustomResourceOptions? opts = null)

public static NlbServerGroup get(String name, Output<String> id, NlbServerGroupState state, CustomResourceOptions options)

resources:  _:    type: volcenginecc:clb:NlbServerGroup    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccountId string: Account ID
AnyPortEnabled bool: Enable all-port forwarding
BypassSecurityGroupEnabled bool: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
ConnectionDrainEnabled bool: Enable graceful connection termination.
ConnectionDrainTimeout int: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
CreatedTime string: Backend server group creation time
Description string: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
HealthCheck Volcengine.NlbServerGroupHealthCheck: Health check parameters
IpAddressVersion string: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
PreserveClientIpEnabled bool: Enable source address persistence
ProjectName string: Project name
Protocol string: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
ProxyProtocolType string: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
RelatedLoadBalancerIds List<string>: NLB instance associated with the server group.
Scheduler string: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
ServerCount int: Number of backend servers in the server group.
ServerGroupId string: Server group ID
ServerGroupName string: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
Servers List<Volcengine.NlbServerGroupServer>
SessionPersistenceEnabled bool: Enable session persistence.
SessionPersistenceTimeout int: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
Status string: Server group status
Tags List<Volcengine.NlbServerGroupTag>
TimestampRemoveEnabled bool: Enable removal of TCP/HTTP/HTTPS packet timestamps
Type string: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.
UpdatedTime string: Last update time of the backend server group.
VpcId string: ID of the private network to which the server group belongs

AccountId string: Account ID
AnyPortEnabled bool: Enable all-port forwarding
BypassSecurityGroupEnabled bool: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
ConnectionDrainEnabled bool: Enable graceful connection termination.
ConnectionDrainTimeout int: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
CreatedTime string: Backend server group creation time
Description string: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
HealthCheck NlbServerGroupHealthCheckArgs: Health check parameters
IpAddressVersion string: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
PreserveClientIpEnabled bool: Enable source address persistence
ProjectName string: Project name
Protocol string: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
ProxyProtocolType string: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
RelatedLoadBalancerIds []string: NLB instance associated with the server group.
Scheduler string: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
ServerCount int: Number of backend servers in the server group.
ServerGroupId string: Server group ID
ServerGroupName string: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
Servers []NlbServerGroupServerArgs
SessionPersistenceEnabled bool: Enable session persistence.
SessionPersistenceTimeout int: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
Status string: Server group status
Tags []NlbServerGroupTagArgs
TimestampRemoveEnabled bool: Enable removal of TCP/HTTP/HTTPS packet timestamps
Type string: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.
UpdatedTime string: Last update time of the backend server group.
VpcId string: ID of the private network to which the server group belongs

accountId String: Account ID
anyPortEnabled Boolean: Enable all-port forwarding
bypassSecurityGroupEnabled Boolean: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
connectionDrainEnabled Boolean: Enable graceful connection termination.
connectionDrainTimeout Integer: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
createdTime String: Backend server group creation time
description String: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
healthCheck NlbServerGroupHealthCheck: Health check parameters
ipAddressVersion String: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
preserveClientIpEnabled Boolean: Enable source address persistence
projectName String: Project name
protocol String: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
proxyProtocolType String: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
relatedLoadBalancerIds List<String>: NLB instance associated with the server group.
scheduler String: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
serverCount Integer: Number of backend servers in the server group.
serverGroupId String: Server group ID
serverGroupName String: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
servers List<NlbServerGroupServer>
sessionPersistenceEnabled Boolean: Enable session persistence.
sessionPersistenceTimeout Integer: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
status String: Server group status
tags List<NlbServerGroupTag>
timestampRemoveEnabled Boolean: Enable removal of TCP/HTTP/HTTPS packet timestamps
type String: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.
updatedTime String: Last update time of the backend server group.
vpcId String: ID of the private network to which the server group belongs

accountId string: Account ID
anyPortEnabled boolean: Enable all-port forwarding
bypassSecurityGroupEnabled boolean: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
connectionDrainEnabled boolean: Enable graceful connection termination.
connectionDrainTimeout number: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
createdTime string: Backend server group creation time
description string: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
healthCheck NlbServerGroupHealthCheck: Health check parameters
ipAddressVersion string: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
preserveClientIpEnabled boolean: Enable source address persistence
projectName string: Project name
protocol string: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
proxyProtocolType string: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
relatedLoadBalancerIds string[]: NLB instance associated with the server group.
scheduler string: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
serverCount number: Number of backend servers in the server group.
serverGroupId string: Server group ID
serverGroupName string: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
servers NlbServerGroupServer[]
sessionPersistenceEnabled boolean: Enable session persistence.
sessionPersistenceTimeout number: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
status string: Server group status
tags NlbServerGroupTag[]
timestampRemoveEnabled boolean: Enable removal of TCP/HTTP/HTTPS packet timestamps
type string: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.
updatedTime string: Last update time of the backend server group.
vpcId string: ID of the private network to which the server group belongs

account_id str: Account ID
any_port_enabled bool: Enable all-port forwarding
bypass_security_group_enabled bool: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
connection_drain_enabled bool: Enable graceful connection termination.
connection_drain_timeout int: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
created_time str: Backend server group creation time
description str: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
health_check NlbServerGroupHealthCheckArgs: Health check parameters
ip_address_version str: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
preserve_client_ip_enabled bool: Enable source address persistence
project_name str: Project name
protocol str: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
proxy_protocol_type str: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
related_load_balancer_ids Sequence[str]: NLB instance associated with the server group.
scheduler str: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
server_count int: Number of backend servers in the server group.
server_group_id str: Server group ID
server_group_name str: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
servers Sequence[NlbServerGroupServerArgs]
session_persistence_enabled bool: Enable session persistence.
session_persistence_timeout int: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
status str: Server group status
tags Sequence[NlbServerGroupTagArgs]
timestamp_remove_enabled bool: Enable removal of TCP/HTTP/HTTPS packet timestamps
type str: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.
updated_time str: Last update time of the backend server group.
vpc_id str: ID of the private network to which the server group belongs

accountId String: Account ID
anyPortEnabled Boolean: Enable all-port forwarding
bypassSecurityGroupEnabled Boolean: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
connectionDrainEnabled Boolean: Enable graceful connection termination.
connectionDrainTimeout Number: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
createdTime String: Backend server group creation time
description String: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
healthCheck Property Map: Health check parameters
ipAddressVersion String: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
preserveClientIpEnabled Boolean: Enable source address persistence
projectName String: Project name
protocol String: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
proxyProtocolType String: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
relatedLoadBalancerIds List<String>: NLB instance associated with the server group.
scheduler String: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
serverCount Number: Number of backend servers in the server group.
serverGroupId String: Server group ID
serverGroupName String: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
servers List<Property Map>
sessionPersistenceEnabled Boolean: Enable session persistence.
sessionPersistenceTimeout Number: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
status String: Server group status
tags List<Property Map>
timestampRemoveEnabled Boolean: Enable removal of TCP/HTTP/HTTPS packet timestamps
type String: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.
updatedTime String: Last update time of the backend server group.
vpcId String: ID of the private network to which the server group belongs

Supporting Types

NlbServerGroupHealthCheck, NlbServerGroupHealthCheckArgs

Domain string: Health check domain name
Enabled bool: Enable health check
HealthyThreshold int: Health check healthy threshold. Range: 2–10 times, default: 3 times. If the backend server passes the specified number of consecutive health checks with 'normal' results, it is considered health check 'normal'
HttpCode string: HTTP status codes indicating a healthy health check.
Interval int: Health check interval, range: 1–300 seconds, default: 10 seconds.
Method string: Health check request method
Port int: Health check port. Range: 1–65535. If full port forwarding is not enabled for the server group, this parameter defaults to 0, meaning the backend server's port is used for health checks. If full port forwarding is enabled, this parameter must be specified
Timeout int: Health check response timeout. Range: 1–60 seconds, default: 3 seconds. If the backend server does not respond correctly within the specified time, it is considered health check 'abnormal'
Type string: Health check protocol type. Options: TCP (default), HTTP, UDP
UdpExpect string: UDP health check request string. Only letters and numbers are allowed, with a maximum length of 64 characters.
UdpRequest string: Expected response string for UDP health check
UnhealthyThreshold int: Health check unhealthy threshold. Range: 2–10 times, default: 3 times. If the backend server fails the specified number of consecutive health checks with 'abnormal' results, it is considered health check abnormal
Uri string: Health check path

Domain string: Health check domain name
Enabled bool: Enable health check
HealthyThreshold int: Health check healthy threshold. Range: 2–10 times, default: 3 times. If the backend server passes the specified number of consecutive health checks with 'normal' results, it is considered health check 'normal'
HttpCode string: HTTP status codes indicating a healthy health check.
Interval int: Health check interval, range: 1–300 seconds, default: 10 seconds.
Method string: Health check request method
Port int: Health check port. Range: 1–65535. If full port forwarding is not enabled for the server group, this parameter defaults to 0, meaning the backend server's port is used for health checks. If full port forwarding is enabled, this parameter must be specified
Timeout int: Health check response timeout. Range: 1–60 seconds, default: 3 seconds. If the backend server does not respond correctly within the specified time, it is considered health check 'abnormal'
Type string: Health check protocol type. Options: TCP (default), HTTP, UDP
UdpExpect string: UDP health check request string. Only letters and numbers are allowed, with a maximum length of 64 characters.
UdpRequest string: Expected response string for UDP health check
UnhealthyThreshold int: Health check unhealthy threshold. Range: 2–10 times, default: 3 times. If the backend server fails the specified number of consecutive health checks with 'abnormal' results, it is considered health check abnormal
Uri string: Health check path

domain String: Health check domain name
enabled Boolean: Enable health check
healthyThreshold Integer: Health check healthy threshold. Range: 2–10 times, default: 3 times. If the backend server passes the specified number of consecutive health checks with 'normal' results, it is considered health check 'normal'
httpCode String: HTTP status codes indicating a healthy health check.
interval Integer: Health check interval, range: 1–300 seconds, default: 10 seconds.
method String: Health check request method
port Integer: Health check port. Range: 1–65535. If full port forwarding is not enabled for the server group, this parameter defaults to 0, meaning the backend server's port is used for health checks. If full port forwarding is enabled, this parameter must be specified
timeout Integer: Health check response timeout. Range: 1–60 seconds, default: 3 seconds. If the backend server does not respond correctly within the specified time, it is considered health check 'abnormal'
type String: Health check protocol type. Options: TCP (default), HTTP, UDP
udpExpect String: UDP health check request string. Only letters and numbers are allowed, with a maximum length of 64 characters.
udpRequest String: Expected response string for UDP health check
unhealthyThreshold Integer: Health check unhealthy threshold. Range: 2–10 times, default: 3 times. If the backend server fails the specified number of consecutive health checks with 'abnormal' results, it is considered health check abnormal
uri String: Health check path

domain string: Health check domain name
enabled boolean: Enable health check
healthyThreshold number: Health check healthy threshold. Range: 2–10 times, default: 3 times. If the backend server passes the specified number of consecutive health checks with 'normal' results, it is considered health check 'normal'
httpCode string: HTTP status codes indicating a healthy health check.
interval number: Health check interval, range: 1–300 seconds, default: 10 seconds.
method string: Health check request method
port number: Health check port. Range: 1–65535. If full port forwarding is not enabled for the server group, this parameter defaults to 0, meaning the backend server's port is used for health checks. If full port forwarding is enabled, this parameter must be specified
timeout number: Health check response timeout. Range: 1–60 seconds, default: 3 seconds. If the backend server does not respond correctly within the specified time, it is considered health check 'abnormal'
type string: Health check protocol type. Options: TCP (default), HTTP, UDP
udpExpect string: UDP health check request string. Only letters and numbers are allowed, with a maximum length of 64 characters.
udpRequest string: Expected response string for UDP health check
unhealthyThreshold number: Health check unhealthy threshold. Range: 2–10 times, default: 3 times. If the backend server fails the specified number of consecutive health checks with 'abnormal' results, it is considered health check abnormal
uri string: Health check path

domain str: Health check domain name
enabled bool: Enable health check
healthy_threshold int: Health check healthy threshold. Range: 2–10 times, default: 3 times. If the backend server passes the specified number of consecutive health checks with 'normal' results, it is considered health check 'normal'
http_code str: HTTP status codes indicating a healthy health check.
interval int: Health check interval, range: 1–300 seconds, default: 10 seconds.
method str: Health check request method
port int: Health check port. Range: 1–65535. If full port forwarding is not enabled for the server group, this parameter defaults to 0, meaning the backend server's port is used for health checks. If full port forwarding is enabled, this parameter must be specified
timeout int: Health check response timeout. Range: 1–60 seconds, default: 3 seconds. If the backend server does not respond correctly within the specified time, it is considered health check 'abnormal'
type str: Health check protocol type. Options: TCP (default), HTTP, UDP
udp_expect str: UDP health check request string. Only letters and numbers are allowed, with a maximum length of 64 characters.
udp_request str: Expected response string for UDP health check
unhealthy_threshold int: Health check unhealthy threshold. Range: 2–10 times, default: 3 times. If the backend server fails the specified number of consecutive health checks with 'abnormal' results, it is considered health check abnormal
uri str: Health check path

domain String: Health check domain name
enabled Boolean: Enable health check
healthyThreshold Number: Health check healthy threshold. Range: 2–10 times, default: 3 times. If the backend server passes the specified number of consecutive health checks with 'normal' results, it is considered health check 'normal'
httpCode String: HTTP status codes indicating a healthy health check.
interval Number: Health check interval, range: 1–300 seconds, default: 10 seconds.
method String: Health check request method
port Number: Health check port. Range: 1–65535. If full port forwarding is not enabled for the server group, this parameter defaults to 0, meaning the backend server's port is used for health checks. If full port forwarding is enabled, this parameter must be specified
timeout Number: Health check response timeout. Range: 1–60 seconds, default: 3 seconds. If the backend server does not respond correctly within the specified time, it is considered health check 'abnormal'
type String: Health check protocol type. Options: TCP (default), HTTP, UDP
udpExpect String: UDP health check request string. Only letters and numbers are allowed, with a maximum length of 64 characters.
udpRequest String: Expected response string for UDP health check
unhealthyThreshold Number: Health check unhealthy threshold. Range: 2–10 times, default: 3 times. If the backend server fails the specified number of consecutive health checks with 'abnormal' results, it is considered health check abnormal
uri String: Health check path

NlbServerGroupServer, NlbServerGroupServerArgs

Description string: Description of the backend server, default is an empty string.
InstanceId string: Server instance ID or IP address. If the server type is 'ecs', enter the cloud server instance ID. You can call the DescribeInstances API to obtain the cloud server instance ID. If the server type is 'eni', enter the network interface card ID bound to the cloud server instance. You can call the DescribeNetworkInterfaces API to obtain the network interface card ID. If the server type is 'ip', enter the backend server's IP address.
Ip string: Private IP address of the backend server. You can call the DescribeInstances API to obtain the private IP address of an 'ecs' type backend server. You can call the DescribeNetworkInterfaces API to obtain the private IP address of an 'eni' type backend server.
Port int: Port number on which the backend server receives requests, range: 1–65535. If AnyPortEnabled is 'false' (all-port forwarding is disabled), this parameter is required. If AnyPortEnabled is 'true' (all-port forwarding is enabled), the default value is 0.
ServerId string: Backend server ID
Type string: Backend server type. Available values: ecs: cloud server instance (primary network interface). eni: auxiliary network interface. ip: IP address.
Weight int: Backend server weight, range: 0–100. Weight of 0 means requests will not be forwarded to this server. If not specified, the default is 0.
ZoneId string: Specify the availability zone of the NLB instance associated with the backend server. This parameter is required when Servers.N.Type is ip. If the NLB instance enables cross-zone forwarding, the backend server can receive traffic from all availability zones of the NLB instance. If cross-zone forwarding is disabled, the backend server only receives traffic from the specified availability zone

Description string: Description of the backend server, default is an empty string.
InstanceId string: Server instance ID or IP address. If the server type is 'ecs', enter the cloud server instance ID. You can call the DescribeInstances API to obtain the cloud server instance ID. If the server type is 'eni', enter the network interface card ID bound to the cloud server instance. You can call the DescribeNetworkInterfaces API to obtain the network interface card ID. If the server type is 'ip', enter the backend server's IP address.
Ip string: Private IP address of the backend server. You can call the DescribeInstances API to obtain the private IP address of an 'ecs' type backend server. You can call the DescribeNetworkInterfaces API to obtain the private IP address of an 'eni' type backend server.
Port int: Port number on which the backend server receives requests, range: 1–65535. If AnyPortEnabled is 'false' (all-port forwarding is disabled), this parameter is required. If AnyPortEnabled is 'true' (all-port forwarding is enabled), the default value is 0.
ServerId string: Backend server ID
Type string: Backend server type. Available values: ecs: cloud server instance (primary network interface). eni: auxiliary network interface. ip: IP address.
Weight int: Backend server weight, range: 0–100. Weight of 0 means requests will not be forwarded to this server. If not specified, the default is 0.
ZoneId string: Specify the availability zone of the NLB instance associated with the backend server. This parameter is required when Servers.N.Type is ip. If the NLB instance enables cross-zone forwarding, the backend server can receive traffic from all availability zones of the NLB instance. If cross-zone forwarding is disabled, the backend server only receives traffic from the specified availability zone

description String: Description of the backend server, default is an empty string.
instanceId String: Server instance ID or IP address. If the server type is 'ecs', enter the cloud server instance ID. You can call the DescribeInstances API to obtain the cloud server instance ID. If the server type is 'eni', enter the network interface card ID bound to the cloud server instance. You can call the DescribeNetworkInterfaces API to obtain the network interface card ID. If the server type is 'ip', enter the backend server's IP address.
ip String: Private IP address of the backend server. You can call the DescribeInstances API to obtain the private IP address of an 'ecs' type backend server. You can call the DescribeNetworkInterfaces API to obtain the private IP address of an 'eni' type backend server.
port Integer: Port number on which the backend server receives requests, range: 1–65535. If AnyPortEnabled is 'false' (all-port forwarding is disabled), this parameter is required. If AnyPortEnabled is 'true' (all-port forwarding is enabled), the default value is 0.
serverId String: Backend server ID
type String: Backend server type. Available values: ecs: cloud server instance (primary network interface). eni: auxiliary network interface. ip: IP address.
weight Integer: Backend server weight, range: 0–100. Weight of 0 means requests will not be forwarded to this server. If not specified, the default is 0.
zoneId String: Specify the availability zone of the NLB instance associated with the backend server. This parameter is required when Servers.N.Type is ip. If the NLB instance enables cross-zone forwarding, the backend server can receive traffic from all availability zones of the NLB instance. If cross-zone forwarding is disabled, the backend server only receives traffic from the specified availability zone

description string: Description of the backend server, default is an empty string.
instanceId string: Server instance ID or IP address. If the server type is 'ecs', enter the cloud server instance ID. You can call the DescribeInstances API to obtain the cloud server instance ID. If the server type is 'eni', enter the network interface card ID bound to the cloud server instance. You can call the DescribeNetworkInterfaces API to obtain the network interface card ID. If the server type is 'ip', enter the backend server's IP address.
ip string: Private IP address of the backend server. You can call the DescribeInstances API to obtain the private IP address of an 'ecs' type backend server. You can call the DescribeNetworkInterfaces API to obtain the private IP address of an 'eni' type backend server.
port number: Port number on which the backend server receives requests, range: 1–65535. If AnyPortEnabled is 'false' (all-port forwarding is disabled), this parameter is required. If AnyPortEnabled is 'true' (all-port forwarding is enabled), the default value is 0.
serverId string: Backend server ID
type string: Backend server type. Available values: ecs: cloud server instance (primary network interface). eni: auxiliary network interface. ip: IP address.
weight number: Backend server weight, range: 0–100. Weight of 0 means requests will not be forwarded to this server. If not specified, the default is 0.
zoneId string: Specify the availability zone of the NLB instance associated with the backend server. This parameter is required when Servers.N.Type is ip. If the NLB instance enables cross-zone forwarding, the backend server can receive traffic from all availability zones of the NLB instance. If cross-zone forwarding is disabled, the backend server only receives traffic from the specified availability zone

description str: Description of the backend server, default is an empty string.
instance_id str: Server instance ID or IP address. If the server type is 'ecs', enter the cloud server instance ID. You can call the DescribeInstances API to obtain the cloud server instance ID. If the server type is 'eni', enter the network interface card ID bound to the cloud server instance. You can call the DescribeNetworkInterfaces API to obtain the network interface card ID. If the server type is 'ip', enter the backend server's IP address.
ip str: Private IP address of the backend server. You can call the DescribeInstances API to obtain the private IP address of an 'ecs' type backend server. You can call the DescribeNetworkInterfaces API to obtain the private IP address of an 'eni' type backend server.
port int: Port number on which the backend server receives requests, range: 1–65535. If AnyPortEnabled is 'false' (all-port forwarding is disabled), this parameter is required. If AnyPortEnabled is 'true' (all-port forwarding is enabled), the default value is 0.
server_id str: Backend server ID
type str: Backend server type. Available values: ecs: cloud server instance (primary network interface). eni: auxiliary network interface. ip: IP address.
weight int: Backend server weight, range: 0–100. Weight of 0 means requests will not be forwarded to this server. If not specified, the default is 0.
zone_id str: Specify the availability zone of the NLB instance associated with the backend server. This parameter is required when Servers.N.Type is ip. If the NLB instance enables cross-zone forwarding, the backend server can receive traffic from all availability zones of the NLB instance. If cross-zone forwarding is disabled, the backend server only receives traffic from the specified availability zone

description String: Description of the backend server, default is an empty string.
instanceId String: Server instance ID or IP address. If the server type is 'ecs', enter the cloud server instance ID. You can call the DescribeInstances API to obtain the cloud server instance ID. If the server type is 'eni', enter the network interface card ID bound to the cloud server instance. You can call the DescribeNetworkInterfaces API to obtain the network interface card ID. If the server type is 'ip', enter the backend server's IP address.
ip String: Private IP address of the backend server. You can call the DescribeInstances API to obtain the private IP address of an 'ecs' type backend server. You can call the DescribeNetworkInterfaces API to obtain the private IP address of an 'eni' type backend server.
port Number: Port number on which the backend server receives requests, range: 1–65535. If AnyPortEnabled is 'false' (all-port forwarding is disabled), this parameter is required. If AnyPortEnabled is 'true' (all-port forwarding is enabled), the default value is 0.
serverId String: Backend server ID
type String: Backend server type. Available values: ecs: cloud server instance (primary network interface). eni: auxiliary network interface. ip: IP address.
weight Number: Backend server weight, range: 0–100. Weight of 0 means requests will not be forwarded to this server. If not specified, the default is 0.
zoneId String: Specify the availability zone of the NLB instance associated with the backend server. This parameter is required when Servers.N.Type is ip. If the NLB instance enables cross-zone forwarding, the backend server can receive traffic from all availability zones of the NLB instance. If cross-zone forwarding is disabled, the backend server only receives traffic from the specified availability zone

NlbServerGroupTag, NlbServerGroupTagArgs

Key string: Tag key
Value string: Tag value

Key string: Tag key
Value string: Tag value

key String: Tag key
value String: Tag value

key string: Tag key
value string: Tag value

key str: Tag key
value str: Tag value

key String: Tag key
value String: Tag value

Import

$ pulumi import volcenginecc:clb/nlbServerGroup:NlbServerGroup example "server_group_id"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.clb.NlbServerGroup

On this page

On this page

Example Usage

Create NlbServerGroup Resource

Constructor syntax

Parameters

NlbServerGroup Resource Properties

Inputs

Outputs

Look up Existing NlbServerGroup Resource

Supporting Types

NlbServerGroupHealthCheck, NlbServerGroupHealthCheckArgs

NlbServerGroupServer, NlbServerGroupServerArgs

NlbServerGroupTag, NlbServerGroupTagArgs

Import

Package Details

On this page

On this page