published on Thursday, Apr 23, 2026 by Volcengine
published on Thursday, Apr 23, 2026 by Volcengine
A backend server group is a collection of backend servers.
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
cLBServerGroupDemo:
type: volcenginecc:clb:ServerGroup
name: CLBServerGroupDemo
properties:
loadBalancerId: clb-mioj49on0zcw5smt1b8rxxxx
serverGroupName: CLBServerGroupDemo
type: instance
description: CLBServerGroupDemo description
addressIpVersion: ipv4
anyPortEnabled: off
tags:
- key: env
value: test
servers:
- instance_id: i-ye498lwge85i3z3kxxxx
type: ecs
weight: 50
ip: 192.168.*.13
any_port_enabled: off
port: 8080
description: test
- instance_id: i-ye48ymyy9s5i3z4pxxxx
type: ecs
weight: 22
ip: 192.168.*.52
any_port_enabled: off
port: 91
description: test
Create ServerGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ServerGroup(name: string, args: ServerGroupArgs, opts?: CustomResourceOptions);@overload
def ServerGroup(resource_name: str,
args: ServerGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ServerGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
load_balancer_id: Optional[str] = None,
address_ip_version: Optional[str] = None,
any_port_enabled: Optional[str] = None,
description: Optional[str] = None,
server_group_name: Optional[str] = None,
servers: Optional[Sequence[ServerGroupServerArgs]] = None,
tags: Optional[Sequence[ServerGroupTagArgs]] = None,
type: Optional[str] = None)func NewServerGroup(ctx *Context, name string, args ServerGroupArgs, opts ...ResourceOption) (*ServerGroup, error)public ServerGroup(string name, ServerGroupArgs args, CustomResourceOptions? opts = null)
public ServerGroup(String name, ServerGroupArgs args)
public ServerGroup(String name, ServerGroupArgs args, CustomResourceOptions options)
type: volcenginecc:clb:ServerGroup
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 ServerGroupArgs
- 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 ServerGroupArgs
- 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 ServerGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServerGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ServerGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ServerGroup 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 ServerGroup resource accepts the following input properties:
- Load
Balancer stringId - CLB instance ID to which the backend server group belongs.
- Address
Ip stringVersion - IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
- Any
Port stringEnabled - Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
- Description string
- Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- Server
Group stringName - Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
- Servers
List<Volcengine.
Server Group Server> -
List<Volcengine.
Server Group Tag> - Type string
- Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
- Load
Balancer stringId - CLB instance ID to which the backend server group belongs.
- Address
Ip stringVersion - IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
- Any
Port stringEnabled - Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
- Description string
- Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- Server
Group stringName - Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
- Servers
[]Server
Group Server Args -
[]Server
Group Tag Args - Type string
- Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
- load
Balancer StringId - CLB instance ID to which the backend server group belongs.
- address
Ip StringVersion - IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
- any
Port StringEnabled - Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
- description String
- Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- server
Group StringName - Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
- servers
List<Server
Group Server> -
List<Server
Group Tag> - type String
- Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
- load
Balancer stringId - CLB instance ID to which the backend server group belongs.
- address
Ip stringVersion - IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
- any
Port stringEnabled - Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
- description string
- Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- server
Group stringName - Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
- servers
Server
Group Server[] -
Server
Group Tag[] - type string
- Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
- load_
balancer_ strid - CLB instance ID to which the backend server group belongs.
- address_
ip_ strversion - IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
- any_
port_ strenabled - Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
- description str
- Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- server_
group_ strname - Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
- servers
Sequence[Server
Group Server Args] -
Sequence[Server
Group Tag Args] - type str
- Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
- load
Balancer StringId - CLB instance ID to which the backend server group belongs.
- address
Ip StringVersion - IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
- any
Port StringEnabled - Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
- description String
- Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- server
Group StringName - Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
- servers List<Property Map>
- List<Property Map>
- type String
- Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
Outputs
All input properties are implicitly available as output properties. Additionally, the ServerGroup resource produces the following output properties:
- Create
Time string - Creation time of the backend server group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Listeners
List<Volcengine.
Server Group Listener> - Server
Group stringId - Backend server group ID.
- Update
Time string - Last operation time of the backend server group.
- Create
Time string - Creation time of the backend server group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Listeners
[]Server
Group Listener - Server
Group stringId - Backend server group ID.
- Update
Time string - Last operation time of the backend server group.
- create
Time String - Creation time of the backend server group.
- id String
- The provider-assigned unique ID for this managed resource.
- listeners
List<Server
Group Listener> - server
Group StringId - Backend server group ID.
- update
Time String - Last operation time of the backend server group.
- create
Time string - Creation time of the backend server group.
- id string
- The provider-assigned unique ID for this managed resource.
- listeners
Server
Group Listener[] - server
Group stringId - Backend server group ID.
- update
Time string - Last operation time of the backend server group.
- create_
time str - Creation time of the backend server group.
- id str
- The provider-assigned unique ID for this managed resource.
- listeners
Sequence[Server
Group Listener] - server_
group_ strid - Backend server group ID.
- update_
time str - Last operation time of the backend server group.
- create
Time String - Creation time of the backend server group.
- id String
- The provider-assigned unique ID for this managed resource.
- listeners List<Property Map>
- server
Group StringId - Backend server group ID.
- update
Time String - Last operation time of the backend server group.
Look up Existing ServerGroup Resource
Get an existing ServerGroup 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?: ServerGroupState, opts?: CustomResourceOptions): ServerGroup@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
address_ip_version: Optional[str] = None,
any_port_enabled: Optional[str] = None,
create_time: Optional[str] = None,
description: Optional[str] = None,
listeners: Optional[Sequence[ServerGroupListenerArgs]] = None,
load_balancer_id: Optional[str] = None,
server_group_id: Optional[str] = None,
server_group_name: Optional[str] = None,
servers: Optional[Sequence[ServerGroupServerArgs]] = None,
tags: Optional[Sequence[ServerGroupTagArgs]] = None,
type: Optional[str] = None,
update_time: Optional[str] = None) -> ServerGroupfunc GetServerGroup(ctx *Context, name string, id IDInput, state *ServerGroupState, opts ...ResourceOption) (*ServerGroup, error)public static ServerGroup Get(string name, Input<string> id, ServerGroupState? state, CustomResourceOptions? opts = null)public static ServerGroup get(String name, Output<String> id, ServerGroupState state, CustomResourceOptions options)resources: _: type: volcenginecc:clb:ServerGroup 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.
- Address
Ip stringVersion - IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
- Any
Port stringEnabled - Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
- Create
Time string - Creation time of the backend server group.
- Description string
- Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- Listeners
List<Volcengine.
Server Group Listener> - Load
Balancer stringId - CLB instance ID to which the backend server group belongs.
- Server
Group stringId - Backend server group ID.
- Server
Group stringName - Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
- Servers
List<Volcengine.
Server Group Server> -
List<Volcengine.
Server Group Tag> - Type string
- Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
- Update
Time string - Last operation time of the backend server group.
- Address
Ip stringVersion - IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
- Any
Port stringEnabled - Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
- Create
Time string - Creation time of the backend server group.
- Description string
- Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- Listeners
[]Server
Group Listener Args - Load
Balancer stringId - CLB instance ID to which the backend server group belongs.
- Server
Group stringId - Backend server group ID.
- Server
Group stringName - Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
- Servers
[]Server
Group Server Args -
[]Server
Group Tag Args - Type string
- Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
- Update
Time string - Last operation time of the backend server group.
- address
Ip StringVersion - IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
- any
Port StringEnabled - Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
- create
Time String - Creation time of the backend server group.
- description String
- Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- listeners
List<Server
Group Listener> - load
Balancer StringId - CLB instance ID to which the backend server group belongs.
- server
Group StringId - Backend server group ID.
- server
Group StringName - Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
- servers
List<Server
Group Server> -
List<Server
Group Tag> - type String
- Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
- update
Time String - Last operation time of the backend server group.
- address
Ip stringVersion - IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
- any
Port stringEnabled - Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
- create
Time string - Creation time of the backend server group.
- description string
- Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- listeners
Server
Group Listener[] - load
Balancer stringId - CLB instance ID to which the backend server group belongs.
- server
Group stringId - Backend server group ID.
- server
Group stringName - Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
- servers
Server
Group Server[] -
Server
Group Tag[] - type string
- Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
- update
Time string - Last operation time of the backend server group.
- address_
ip_ strversion - IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
- any_
port_ strenabled - Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
- create_
time str - Creation time of the backend server group.
- description str
- Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- listeners
Sequence[Server
Group Listener Args] - load_
balancer_ strid - CLB instance ID to which the backend server group belongs.
- server_
group_ strid - Backend server group ID.
- server_
group_ strname - Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
- servers
Sequence[Server
Group Server Args] -
Sequence[Server
Group Tag Args] - type str
- Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
- update_
time str - Last operation time of the backend server group.
- address
Ip StringVersion - IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
- any
Port StringEnabled - Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
- create
Time String - Creation time of the backend server group.
- description String
- Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- listeners List<Property Map>
- load
Balancer StringId - CLB instance ID to which the backend server group belongs.
- server
Group StringId - Backend server group ID.
- server
Group StringName - Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
- servers List<Property Map>
- List<Property Map>
- type String
- Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
- update
Time String - Last operation time of the backend server group.
Supporting Types
ServerGroupListener, ServerGroupListenerArgs
- Listener
Id string - Listener ID.
- Listener
Id string - Listener ID.
- listener
Id String - Listener ID.
- listener
Id string - Listener ID.
- listener_
id str - Listener ID.
- listener
Id String - Listener ID.
ServerGroupServer, ServerGroupServerArgs
- Description string
- Backend server description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- Instance
Id string - Backend server. Value options: When Type is ecs, provide the cloud server instance ID. When Type is eni, provide the ID of the auxiliary network card attached to the cloud server. When Type is ip, provide the IP address as the backend server.
- Ip string
- Private IP address of the backend server. Use '&' to separate multiple backend server IP addresses.
- Port int
- Port number on which the backend server receives requests. Value range: 1–65535. If the AnyPortEnabled parameter is 'off' and you need to add backend servers at the same time, this parameter must be provided. If AnyPortEnabled is 'on', this parameter defaults to 0.
- Type string
- Backend server instance type. When the Type parameter is instance, value options are: ecs: cloud server instance. eni: auxiliary network card. When the Type parameter is ip, this parameter value is ip.
- Weight int
- Backend server weight, range: 0–100. If not specified, defaults to 0. 0 means requests will not be forwarded to this backend server.
- Description string
- Backend server description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- Instance
Id string - Backend server. Value options: When Type is ecs, provide the cloud server instance ID. When Type is eni, provide the ID of the auxiliary network card attached to the cloud server. When Type is ip, provide the IP address as the backend server.
- Ip string
- Private IP address of the backend server. Use '&' to separate multiple backend server IP addresses.
- Port int
- Port number on which the backend server receives requests. Value range: 1–65535. If the AnyPortEnabled parameter is 'off' and you need to add backend servers at the same time, this parameter must be provided. If AnyPortEnabled is 'on', this parameter defaults to 0.
- Type string
- Backend server instance type. When the Type parameter is instance, value options are: ecs: cloud server instance. eni: auxiliary network card. When the Type parameter is ip, this parameter value is ip.
- Weight int
- Backend server weight, range: 0–100. If not specified, defaults to 0. 0 means requests will not be forwarded to this backend server.
- description String
- Backend server description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- instance
Id String - Backend server. Value options: When Type is ecs, provide the cloud server instance ID. When Type is eni, provide the ID of the auxiliary network card attached to the cloud server. When Type is ip, provide the IP address as the backend server.
- ip String
- Private IP address of the backend server. Use '&' to separate multiple backend server IP addresses.
- port Integer
- Port number on which the backend server receives requests. Value range: 1–65535. If the AnyPortEnabled parameter is 'off' and you need to add backend servers at the same time, this parameter must be provided. If AnyPortEnabled is 'on', this parameter defaults to 0.
- type String
- Backend server instance type. When the Type parameter is instance, value options are: ecs: cloud server instance. eni: auxiliary network card. When the Type parameter is ip, this parameter value is ip.
- weight Integer
- Backend server weight, range: 0–100. If not specified, defaults to 0. 0 means requests will not be forwarded to this backend server.
- description string
- Backend server description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- instance
Id string - Backend server. Value options: When Type is ecs, provide the cloud server instance ID. When Type is eni, provide the ID of the auxiliary network card attached to the cloud server. When Type is ip, provide the IP address as the backend server.
- ip string
- Private IP address of the backend server. Use '&' to separate multiple backend server IP addresses.
- port number
- Port number on which the backend server receives requests. Value range: 1–65535. If the AnyPortEnabled parameter is 'off' and you need to add backend servers at the same time, this parameter must be provided. If AnyPortEnabled is 'on', this parameter defaults to 0.
- type string
- Backend server instance type. When the Type parameter is instance, value options are: ecs: cloud server instance. eni: auxiliary network card. When the Type parameter is ip, this parameter value is ip.
- weight number
- Backend server weight, range: 0–100. If not specified, defaults to 0. 0 means requests will not be forwarded to this backend server.
- description str
- Backend server description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- instance_
id str - Backend server. Value options: When Type is ecs, provide the cloud server instance ID. When Type is eni, provide the ID of the auxiliary network card attached to the cloud server. When Type is ip, provide the IP address as the backend server.
- ip str
- Private IP address of the backend server. Use '&' to separate multiple backend server IP addresses.
- port int
- Port number on which the backend server receives requests. Value range: 1–65535. If the AnyPortEnabled parameter is 'off' and you need to add backend servers at the same time, this parameter must be provided. If AnyPortEnabled is 'on', this parameter defaults to 0.
- type str
- Backend server instance type. When the Type parameter is instance, value options are: ecs: cloud server instance. eni: auxiliary network card. When the Type parameter is ip, this parameter value is ip.
- weight int
- Backend server weight, range: 0–100. If not specified, defaults to 0. 0 means requests will not be forwarded to this backend server.
- description String
- Backend server description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
- instance
Id String - Backend server. Value options: When Type is ecs, provide the cloud server instance ID. When Type is eni, provide the ID of the auxiliary network card attached to the cloud server. When Type is ip, provide the IP address as the backend server.
- ip String
- Private IP address of the backend server. Use '&' to separate multiple backend server IP addresses.
- port Number
- Port number on which the backend server receives requests. Value range: 1–65535. If the AnyPortEnabled parameter is 'off' and you need to add backend servers at the same time, this parameter must be provided. If AnyPortEnabled is 'on', this parameter defaults to 0.
- type String
- Backend server instance type. When the Type parameter is instance, value options are: ecs: cloud server instance. eni: auxiliary network card. When the Type parameter is ip, this parameter value is ip.
- weight Number
- Backend server weight, range: 0–100. If not specified, defaults to 0. 0 means requests will not be forwarded to this backend server.
ServerGroupTag, ServerGroupTagArgs
Import
$ pulumi import volcenginecc:clb/serverGroup:ServerGroup 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
volcengineccTerraform Provider.
published on Thursday, Apr 23, 2026 by Volcengine
