1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. clb
  6. ServerGroup
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.32
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:

    LoadBalancerId string
    CLB instance ID to which the backend server group belongs.
    AddressIpVersion string
    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.
    AnyPortEnabled string
    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.
    ServerGroupName string
    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.ServerGroupServer>
    Tags List<Volcengine.ServerGroupTag>
    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.
    LoadBalancerId string
    CLB instance ID to which the backend server group belongs.
    AddressIpVersion string
    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.
    AnyPortEnabled string
    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.
    ServerGroupName string
    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 []ServerGroupServerArgs
    Tags []ServerGroupTagArgs
    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.
    loadBalancerId String
    CLB instance ID to which the backend server group belongs.
    addressIpVersion String
    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.
    anyPortEnabled String
    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.
    serverGroupName String
    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<ServerGroupServer>
    tags List<ServerGroupTag>
    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.
    loadBalancerId string
    CLB instance ID to which the backend server group belongs.
    addressIpVersion string
    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.
    anyPortEnabled string
    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.
    serverGroupName string
    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 ServerGroupServer[]
    tags ServerGroupTag[]
    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_id str
    CLB instance ID to which the backend server group belongs.
    address_ip_version str
    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_enabled str
    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_name str
    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[ServerGroupServerArgs]
    tags Sequence[ServerGroupTagArgs]
    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.
    loadBalancerId String
    CLB instance ID to which the backend server group belongs.
    addressIpVersion String
    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.
    anyPortEnabled String
    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.
    serverGroupName String
    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>
    tags 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:

    CreateTime string
    Creation time of the backend server group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Listeners List<Volcengine.ServerGroupListener>
    ServerGroupId string
    Backend server group ID.
    UpdateTime string
    Last operation time of the backend server group.
    CreateTime string
    Creation time of the backend server group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Listeners []ServerGroupListener
    ServerGroupId string
    Backend server group ID.
    UpdateTime string
    Last operation time of the backend server group.
    createTime String
    Creation time of the backend server group.
    id String
    The provider-assigned unique ID for this managed resource.
    listeners List<ServerGroupListener>
    serverGroupId String
    Backend server group ID.
    updateTime String
    Last operation time of the backend server group.
    createTime string
    Creation time of the backend server group.
    id string
    The provider-assigned unique ID for this managed resource.
    listeners ServerGroupListener[]
    serverGroupId string
    Backend server group ID.
    updateTime 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[ServerGroupListener]
    server_group_id str
    Backend server group ID.
    update_time str
    Last operation time of the backend server group.
    createTime String
    Creation time of the backend server group.
    id String
    The provider-assigned unique ID for this managed resource.
    listeners List<Property Map>
    serverGroupId String
    Backend server group ID.
    updateTime 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) -> ServerGroup
    func 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.
    The following state arguments are supported:
    AddressIpVersion string
    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.
    AnyPortEnabled string
    Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
    CreateTime 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.ServerGroupListener>
    LoadBalancerId string
    CLB instance ID to which the backend server group belongs.
    ServerGroupId string
    Backend server group ID.
    ServerGroupName string
    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.ServerGroupServer>
    Tags List<Volcengine.ServerGroupTag>
    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.
    UpdateTime string
    Last operation time of the backend server group.
    AddressIpVersion string
    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.
    AnyPortEnabled string
    Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
    CreateTime 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 []ServerGroupListenerArgs
    LoadBalancerId string
    CLB instance ID to which the backend server group belongs.
    ServerGroupId string
    Backend server group ID.
    ServerGroupName string
    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 []ServerGroupServerArgs
    Tags []ServerGroupTagArgs
    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.
    UpdateTime string
    Last operation time of the backend server group.
    addressIpVersion String
    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.
    anyPortEnabled String
    Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
    createTime 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<ServerGroupListener>
    loadBalancerId String
    CLB instance ID to which the backend server group belongs.
    serverGroupId String
    Backend server group ID.
    serverGroupName String
    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<ServerGroupServer>
    tags List<ServerGroupTag>
    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.
    updateTime String
    Last operation time of the backend server group.
    addressIpVersion string
    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.
    anyPortEnabled string
    Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
    createTime 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 ServerGroupListener[]
    loadBalancerId string
    CLB instance ID to which the backend server group belongs.
    serverGroupId string
    Backend server group ID.
    serverGroupName string
    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 ServerGroupServer[]
    tags ServerGroupTag[]
    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.
    updateTime string
    Last operation time of the backend server group.
    address_ip_version str
    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_enabled str
    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[ServerGroupListenerArgs]
    load_balancer_id str
    CLB instance ID to which the backend server group belongs.
    server_group_id str
    Backend server group ID.
    server_group_name str
    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[ServerGroupServerArgs]
    tags Sequence[ServerGroupTagArgs]
    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.
    addressIpVersion String
    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.
    anyPortEnabled String
    Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
    createTime 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>
    loadBalancerId String
    CLB instance ID to which the backend server group belongs.
    serverGroupId String
    Backend server group ID.
    serverGroupName String
    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>
    tags 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.
    updateTime String
    Last operation time of the backend server group.

    Supporting Types

    ServerGroupListener, ServerGroupListenerArgs

    ListenerId string
    Listener ID.
    ListenerId string
    Listener ID.
    listenerId String
    Listener ID.
    listenerId string
    Listener ID.
    listener_id str
    Listener ID.
    listenerId 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.
    InstanceId 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.
    InstanceId 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.
    instanceId 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.
    instanceId 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.
    instanceId 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

    Key string
    Information about bound tag keys.
    Value string
    Bound tag value information.
    Key string
    Information about bound tag keys.
    Value string
    Bound tag value information.
    key String
    Information about bound tag keys.
    value String
    Bound tag value information.
    key string
    Information about bound tag keys.
    value string
    Bound tag value information.
    key str
    Information about bound tag keys.
    value str
    Bound tag value information.
    key String
    Information about bound tag keys.
    value String
    Bound tag value information.

    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 volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.