1. Packages
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. alb
  6. ServerGroup
Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus
bytepluscc logo
Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus

    A server group is a logical collection of backend servers. The ALB instance determines which server group to forward client requests to based on your forwarding rules. Then, the ALB instance distributes requests to backend servers within the server group according to your load balancing policy. Backend servers receive and process the requests.

    Example Usage

    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    resources:
      albServergroupDemo:
        type: bytepluscc:alb:ServerGroup
        name: AlbServergroupDemo
        properties:
          vpcId: vpc-13f8***
          serverGroupName: test-servergroup
          serverGroupType: instance
          protocol: HTTP
          scheduler: wrr
          crossZoneEnabled: on
          healthCheck:
            enabled: on
            port: 80
            interval: 2
            timeout: 5
            healthy_threshold: 3
            unhealthy_threshold: 3
            method: GET
            http_version: HTTP1.1
            uri: /health
            http_code: http_2xx
          stickySessionConfig:
            sticky_session_enabled: on
            sticky_session_type: insert
            cookie_timeout: 1000
          servers:
            - instance_id: i-ye3***
              type: ecs
              ip: 192.168.1.**
              port: 80
              weight: 10
          tags:
            - key: env
              value: 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,
                    vpc_id: Optional[str] = None,
                    scheduler: Optional[str] = None,
                    health_check: Optional[ServerGroupHealthCheckArgs] = None,
                    ip_address_type: Optional[str] = None,
                    project_name: Optional[str] = None,
                    protocol: Optional[str] = None,
                    cross_zone_enabled: Optional[str] = None,
                    server_group_name: Optional[str] = None,
                    server_group_type: Optional[str] = None,
                    servers: Optional[Sequence[ServerGroupServerArgs]] = None,
                    status: Optional[str] = None,
                    sticky_session_config: Optional[ServerGroupStickySessionConfigArgs] = None,
                    tags: Optional[Sequence[ServerGroupTagArgs]] = None,
                    description: 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: bytepluscc:alb: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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var serverGroupResource = new Bytepluscc.Alb.ServerGroup("serverGroupResource", new()
    {
        VpcId = "string",
        Scheduler = "string",
        HealthCheck = new Bytepluscc.Alb.Inputs.ServerGroupHealthCheckArgs
        {
            Domain = "string",
            Enabled = "string",
            HealthyThreshold = 0,
            HttpCode = "string",
            HttpVersion = "string",
            Interval = 0,
            Method = "string",
            Port = 0,
            Protocol = "string",
            Timeout = 0,
            UnhealthyThreshold = 0,
            Uri = "string",
        },
        IpAddressType = "string",
        ProjectName = "string",
        Protocol = "string",
        CrossZoneEnabled = "string",
        ServerGroupName = "string",
        ServerGroupType = "string",
        Servers = new[]
        {
            new Bytepluscc.Alb.Inputs.ServerGroupServerArgs
            {
                Description = "string",
                InstanceId = "string",
                Ip = "string",
                Port = 0,
                RemoteEnabled = "string",
                ServerId = "string",
                Type = "string",
                Weight = 0,
            },
        },
        Status = "string",
        StickySessionConfig = new Bytepluscc.Alb.Inputs.ServerGroupStickySessionConfigArgs
        {
            Cookie = "string",
            CookieTimeout = 0,
            StickySessionEnabled = "string",
            StickySessionType = "string",
        },
        Tags = new[]
        {
            new Bytepluscc.Alb.Inputs.ServerGroupTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
        Description = "string",
    });
    
    example, err := alb.NewServerGroup(ctx, "serverGroupResource", &alb.ServerGroupArgs{
    	VpcId:     pulumi.String("string"),
    	Scheduler: pulumi.String("string"),
    	HealthCheck: &alb.ServerGroupHealthCheckArgs{
    		Domain:             pulumi.String("string"),
    		Enabled:            pulumi.String("string"),
    		HealthyThreshold:   pulumi.Int(0),
    		HttpCode:           pulumi.String("string"),
    		HttpVersion:        pulumi.String("string"),
    		Interval:           pulumi.Int(0),
    		Method:             pulumi.String("string"),
    		Port:               pulumi.Int(0),
    		Protocol:           pulumi.String("string"),
    		Timeout:            pulumi.Int(0),
    		UnhealthyThreshold: pulumi.Int(0),
    		Uri:                pulumi.String("string"),
    	},
    	IpAddressType:    pulumi.String("string"),
    	ProjectName:      pulumi.String("string"),
    	Protocol:         pulumi.String("string"),
    	CrossZoneEnabled: pulumi.String("string"),
    	ServerGroupName:  pulumi.String("string"),
    	ServerGroupType:  pulumi.String("string"),
    	Servers: alb.ServerGroupServerArray{
    		&alb.ServerGroupServerArgs{
    			Description:   pulumi.String("string"),
    			InstanceId:    pulumi.String("string"),
    			Ip:            pulumi.String("string"),
    			Port:          pulumi.Int(0),
    			RemoteEnabled: pulumi.String("string"),
    			ServerId:      pulumi.String("string"),
    			Type:          pulumi.String("string"),
    			Weight:        pulumi.Int(0),
    		},
    	},
    	Status: pulumi.String("string"),
    	StickySessionConfig: &alb.ServerGroupStickySessionConfigArgs{
    		Cookie:               pulumi.String("string"),
    		CookieTimeout:        pulumi.Int(0),
    		StickySessionEnabled: pulumi.String("string"),
    		StickySessionType:    pulumi.String("string"),
    	},
    	Tags: alb.ServerGroupTagArray{
    		&alb.ServerGroupTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	Description: pulumi.String("string"),
    })
    
    var serverGroupResource = new com.byteplus.bytepluscc.alb.ServerGroup("serverGroupResource", com.byteplus.bytepluscc.alb.ServerGroupArgs.builder()
        .vpcId("string")
        .scheduler("string")
        .healthCheck(ServerGroupHealthCheckArgs.builder()
            .domain("string")
            .enabled("string")
            .healthyThreshold(0)
            .httpCode("string")
            .httpVersion("string")
            .interval(0)
            .method("string")
            .port(0)
            .protocol("string")
            .timeout(0)
            .unhealthyThreshold(0)
            .uri("string")
            .build())
        .ipAddressType("string")
        .projectName("string")
        .protocol("string")
        .crossZoneEnabled("string")
        .serverGroupName("string")
        .serverGroupType("string")
        .servers(ServerGroupServerArgs.builder()
            .description("string")
            .instanceId("string")
            .ip("string")
            .port(0)
            .remoteEnabled("string")
            .serverId("string")
            .type("string")
            .weight(0)
            .build())
        .status("string")
        .stickySessionConfig(ServerGroupStickySessionConfigArgs.builder()
            .cookie("string")
            .cookieTimeout(0)
            .stickySessionEnabled("string")
            .stickySessionType("string")
            .build())
        .tags(ServerGroupTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .description("string")
        .build());
    
    server_group_resource = bytepluscc.alb.ServerGroup("serverGroupResource",
        vpc_id="string",
        scheduler="string",
        health_check={
            "domain": "string",
            "enabled": "string",
            "healthy_threshold": 0,
            "http_code": "string",
            "http_version": "string",
            "interval": 0,
            "method": "string",
            "port": 0,
            "protocol": "string",
            "timeout": 0,
            "unhealthy_threshold": 0,
            "uri": "string",
        },
        ip_address_type="string",
        project_name="string",
        protocol="string",
        cross_zone_enabled="string",
        server_group_name="string",
        server_group_type="string",
        servers=[{
            "description": "string",
            "instance_id": "string",
            "ip": "string",
            "port": 0,
            "remote_enabled": "string",
            "server_id": "string",
            "type": "string",
            "weight": 0,
        }],
        status="string",
        sticky_session_config={
            "cookie": "string",
            "cookie_timeout": 0,
            "sticky_session_enabled": "string",
            "sticky_session_type": "string",
        },
        tags=[{
            "key": "string",
            "value": "string",
        }],
        description="string")
    
    const serverGroupResource = new bytepluscc.alb.ServerGroup("serverGroupResource", {
        vpcId: "string",
        scheduler: "string",
        healthCheck: {
            domain: "string",
            enabled: "string",
            healthyThreshold: 0,
            httpCode: "string",
            httpVersion: "string",
            interval: 0,
            method: "string",
            port: 0,
            protocol: "string",
            timeout: 0,
            unhealthyThreshold: 0,
            uri: "string",
        },
        ipAddressType: "string",
        projectName: "string",
        protocol: "string",
        crossZoneEnabled: "string",
        serverGroupName: "string",
        serverGroupType: "string",
        servers: [{
            description: "string",
            instanceId: "string",
            ip: "string",
            port: 0,
            remoteEnabled: "string",
            serverId: "string",
            type: "string",
            weight: 0,
        }],
        status: "string",
        stickySessionConfig: {
            cookie: "string",
            cookieTimeout: 0,
            stickySessionEnabled: "string",
            stickySessionType: "string",
        },
        tags: [{
            key: "string",
            value: "string",
        }],
        description: "string",
    });
    
    type: bytepluscc:alb:ServerGroup
    properties:
        crossZoneEnabled: string
        description: string
        healthCheck:
            domain: string
            enabled: string
            healthyThreshold: 0
            httpCode: string
            httpVersion: string
            interval: 0
            method: string
            port: 0
            protocol: string
            timeout: 0
            unhealthyThreshold: 0
            uri: string
        ipAddressType: string
        projectName: string
        protocol: string
        scheduler: string
        serverGroupName: string
        serverGroupType: string
        servers:
            - description: string
              instanceId: string
              ip: string
              port: 0
              remoteEnabled: string
              serverId: string
              type: string
              weight: 0
        status: string
        stickySessionConfig:
            cookie: string
            cookieTimeout: 0
            stickySessionEnabled: string
            stickySessionType: string
        tags:
            - key: string
              value: string
        vpcId: string
    

    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:

    VpcId string
    ID of the VPC to which the backend server group belongs.
    CrossZoneEnabled string
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    Description string
    Description of the backend server group.
    HealthCheck Byteplus.ServerGroupHealthCheck
    Health check configuration information for the server group.
    IpAddressType string
    IP address type of the server group. Currently, only IPv4 is supported.
    ProjectName string
    Name of the project to which the backend server group belongs.
    Protocol string
    Backend protocol: HTTP, HTTPS.
    Scheduler string
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    ServerGroupName string
    Backend server group name.
    ServerGroupType string
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    Servers List<Byteplus.ServerGroupServer>
    Status string
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    StickySessionConfig Byteplus.ServerGroupStickySessionConfig
    Session persistence parameter information.
    Tags List<Byteplus.ServerGroupTag>
    VpcId string
    ID of the VPC to which the backend server group belongs.
    CrossZoneEnabled string
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    Description string
    Description of the backend server group.
    HealthCheck ServerGroupHealthCheckArgs
    Health check configuration information for the server group.
    IpAddressType string
    IP address type of the server group. Currently, only IPv4 is supported.
    ProjectName string
    Name of the project to which the backend server group belongs.
    Protocol string
    Backend protocol: HTTP, HTTPS.
    Scheduler string
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    ServerGroupName string
    Backend server group name.
    ServerGroupType string
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    Servers []ServerGroupServerArgs
    Status string
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    StickySessionConfig ServerGroupStickySessionConfigArgs
    Session persistence parameter information.
    Tags []ServerGroupTagArgs
    vpcId String
    ID of the VPC to which the backend server group belongs.
    crossZoneEnabled String
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    description String
    Description of the backend server group.
    healthCheck ServerGroupHealthCheck
    Health check configuration information for the server group.
    ipAddressType String
    IP address type of the server group. Currently, only IPv4 is supported.
    projectName String
    Name of the project to which the backend server group belongs.
    protocol String
    Backend protocol: HTTP, HTTPS.
    scheduler String
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    serverGroupName String
    Backend server group name.
    serverGroupType String
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    servers List<ServerGroupServer>
    status String
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    stickySessionConfig ServerGroupStickySessionConfig
    Session persistence parameter information.
    tags List<ServerGroupTag>
    vpcId string
    ID of the VPC to which the backend server group belongs.
    crossZoneEnabled string
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    description string
    Description of the backend server group.
    healthCheck ServerGroupHealthCheck
    Health check configuration information for the server group.
    ipAddressType string
    IP address type of the server group. Currently, only IPv4 is supported.
    projectName string
    Name of the project to which the backend server group belongs.
    protocol string
    Backend protocol: HTTP, HTTPS.
    scheduler string
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    serverGroupName string
    Backend server group name.
    serverGroupType string
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    servers ServerGroupServer[]
    status string
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    stickySessionConfig ServerGroupStickySessionConfig
    Session persistence parameter information.
    tags ServerGroupTag[]
    vpc_id str
    ID of the VPC to which the backend server group belongs.
    cross_zone_enabled str
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    description str
    Description of the backend server group.
    health_check ServerGroupHealthCheckArgs
    Health check configuration information for the server group.
    ip_address_type str
    IP address type of the server group. Currently, only IPv4 is supported.
    project_name str
    Name of the project to which the backend server group belongs.
    protocol str
    Backend protocol: HTTP, HTTPS.
    scheduler str
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    server_group_name str
    Backend server group name.
    server_group_type str
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    servers Sequence[ServerGroupServerArgs]
    status str
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    sticky_session_config ServerGroupStickySessionConfigArgs
    Session persistence parameter information.
    tags Sequence[ServerGroupTagArgs]
    vpcId String
    ID of the VPC to which the backend server group belongs.
    crossZoneEnabled String
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    description String
    Description of the backend server group.
    healthCheck Property Map
    Health check configuration information for the server group.
    ipAddressType String
    IP address type of the server group. Currently, only IPv4 is supported.
    projectName String
    Name of the project to which the backend server group belongs.
    protocol String
    Backend protocol: HTTP, HTTPS.
    scheduler String
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    serverGroupName String
    Backend server group name.
    serverGroupType String
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    servers List<Property Map>
    status String
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    stickySessionConfig Property Map
    Session persistence parameter information.
    tags List<Property Map>

    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<Byteplus.ServerGroupListener>
    ServerCount int
    Number of backend servers in the server group.
    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
    ServerCount int
    Number of backend servers in the server group.
    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>
    serverCount Integer
    Number of backend servers in the server group.
    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[]
    serverCount number
    Number of backend servers in the server group.
    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_count int
    Number of backend servers in the server group.
    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>
    serverCount Number
    Number of backend servers in the server group.
    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,
            create_time: Optional[str] = None,
            cross_zone_enabled: Optional[str] = None,
            description: Optional[str] = None,
            health_check: Optional[ServerGroupHealthCheckArgs] = None,
            ip_address_type: Optional[str] = None,
            listeners: Optional[Sequence[ServerGroupListenerArgs]] = None,
            project_name: Optional[str] = None,
            protocol: Optional[str] = None,
            scheduler: Optional[str] = None,
            server_count: Optional[int] = None,
            server_group_id: Optional[str] = None,
            server_group_name: Optional[str] = None,
            server_group_type: Optional[str] = None,
            servers: Optional[Sequence[ServerGroupServerArgs]] = None,
            status: Optional[str] = None,
            sticky_session_config: Optional[ServerGroupStickySessionConfigArgs] = None,
            tags: Optional[Sequence[ServerGroupTagArgs]] = None,
            update_time: Optional[str] = None,
            vpc_id: 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: bytepluscc:alb: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:
    CreateTime string
    Creation time of the backend server group.
    CrossZoneEnabled string
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    Description string
    Description of the backend server group.
    HealthCheck Byteplus.ServerGroupHealthCheck
    Health check configuration information for the server group.
    IpAddressType string
    IP address type of the server group. Currently, only IPv4 is supported.
    Listeners List<Byteplus.ServerGroupListener>
    ProjectName string
    Name of the project to which the backend server group belongs.
    Protocol string
    Backend protocol: HTTP, HTTPS.
    Scheduler string
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    ServerCount int
    Number of backend servers in the server group.
    ServerGroupId string
    Backend server group ID.
    ServerGroupName string
    Backend server group name.
    ServerGroupType string
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    Servers List<Byteplus.ServerGroupServer>
    Status string
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    StickySessionConfig Byteplus.ServerGroupStickySessionConfig
    Session persistence parameter information.
    Tags List<Byteplus.ServerGroupTag>
    UpdateTime string
    Last operation time of the backend server group.
    VpcId string
    ID of the VPC to which the backend server group belongs.
    CreateTime string
    Creation time of the backend server group.
    CrossZoneEnabled string
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    Description string
    Description of the backend server group.
    HealthCheck ServerGroupHealthCheckArgs
    Health check configuration information for the server group.
    IpAddressType string
    IP address type of the server group. Currently, only IPv4 is supported.
    Listeners []ServerGroupListenerArgs
    ProjectName string
    Name of the project to which the backend server group belongs.
    Protocol string
    Backend protocol: HTTP, HTTPS.
    Scheduler string
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    ServerCount int
    Number of backend servers in the server group.
    ServerGroupId string
    Backend server group ID.
    ServerGroupName string
    Backend server group name.
    ServerGroupType string
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    Servers []ServerGroupServerArgs
    Status string
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    StickySessionConfig ServerGroupStickySessionConfigArgs
    Session persistence parameter information.
    Tags []ServerGroupTagArgs
    UpdateTime string
    Last operation time of the backend server group.
    VpcId string
    ID of the VPC to which the backend server group belongs.
    createTime String
    Creation time of the backend server group.
    crossZoneEnabled String
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    description String
    Description of the backend server group.
    healthCheck ServerGroupHealthCheck
    Health check configuration information for the server group.
    ipAddressType String
    IP address type of the server group. Currently, only IPv4 is supported.
    listeners List<ServerGroupListener>
    projectName String
    Name of the project to which the backend server group belongs.
    protocol String
    Backend protocol: HTTP, HTTPS.
    scheduler String
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    serverCount Integer
    Number of backend servers in the server group.
    serverGroupId String
    Backend server group ID.
    serverGroupName String
    Backend server group name.
    serverGroupType String
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    servers List<ServerGroupServer>
    status String
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    stickySessionConfig ServerGroupStickySessionConfig
    Session persistence parameter information.
    tags List<ServerGroupTag>
    updateTime String
    Last operation time of the backend server group.
    vpcId String
    ID of the VPC to which the backend server group belongs.
    createTime string
    Creation time of the backend server group.
    crossZoneEnabled string
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    description string
    Description of the backend server group.
    healthCheck ServerGroupHealthCheck
    Health check configuration information for the server group.
    ipAddressType string
    IP address type of the server group. Currently, only IPv4 is supported.
    listeners ServerGroupListener[]
    projectName string
    Name of the project to which the backend server group belongs.
    protocol string
    Backend protocol: HTTP, HTTPS.
    scheduler string
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    serverCount number
    Number of backend servers in the server group.
    serverGroupId string
    Backend server group ID.
    serverGroupName string
    Backend server group name.
    serverGroupType string
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    servers ServerGroupServer[]
    status string
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    stickySessionConfig ServerGroupStickySessionConfig
    Session persistence parameter information.
    tags ServerGroupTag[]
    updateTime string
    Last operation time of the backend server group.
    vpcId string
    ID of the VPC to which the backend server group belongs.
    create_time str
    Creation time of the backend server group.
    cross_zone_enabled str
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    description str
    Description of the backend server group.
    health_check ServerGroupHealthCheckArgs
    Health check configuration information for the server group.
    ip_address_type str
    IP address type of the server group. Currently, only IPv4 is supported.
    listeners Sequence[ServerGroupListenerArgs]
    project_name str
    Name of the project to which the backend server group belongs.
    protocol str
    Backend protocol: HTTP, HTTPS.
    scheduler str
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    server_count int
    Number of backend servers in the server group.
    server_group_id str
    Backend server group ID.
    server_group_name str
    Backend server group name.
    server_group_type str
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    servers Sequence[ServerGroupServerArgs]
    status str
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    sticky_session_config ServerGroupStickySessionConfigArgs
    Session persistence parameter information.
    tags Sequence[ServerGroupTagArgs]
    update_time str
    Last operation time of the backend server group.
    vpc_id str
    ID of the VPC to which the backend server group belongs.
    createTime String
    Creation time of the backend server group.
    crossZoneEnabled String
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    description String
    Description of the backend server group.
    healthCheck Property Map
    Health check configuration information for the server group.
    ipAddressType String
    IP address type of the server group. Currently, only IPv4 is supported.
    listeners List<Property Map>
    projectName String
    Name of the project to which the backend server group belongs.
    protocol String
    Backend protocol: HTTP, HTTPS.
    scheduler String
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    serverCount Number
    Number of backend servers in the server group.
    serverGroupId String
    Backend server group ID.
    serverGroupName String
    Backend server group name.
    serverGroupType String
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    servers List<Property Map>
    status String
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    stickySessionConfig Property Map
    Session persistence parameter information.
    tags List<Property Map>
    updateTime String
    Last operation time of the backend server group.
    vpcId String
    ID of the VPC to which the backend server group belongs.

    Supporting Types

    ServerGroupHealthCheck, ServerGroupHealthCheckArgs

    Domain string
    The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
    Enabled string
    Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
    HealthyThreshold int
    Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
    HttpCode string
    HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
    HttpVersion string
    HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
    Interval int
    After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
    Method string
    After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
    Port int
    Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
    Protocol string
    Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
    Timeout int
    Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
    UnhealthyThreshold int
    Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
    Uri string
    Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
    Domain string
    The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
    Enabled string
    Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
    HealthyThreshold int
    Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
    HttpCode string
    HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
    HttpVersion string
    HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
    Interval int
    After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
    Method string
    After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
    Port int
    Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
    Protocol string
    Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
    Timeout int
    Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
    UnhealthyThreshold int
    Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
    Uri string
    Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
    domain String
    The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
    enabled String
    Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
    healthyThreshold Integer
    Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
    httpCode String
    HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
    httpVersion String
    HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
    interval Integer
    After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
    method String
    After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
    port Integer
    Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
    protocol String
    Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
    timeout Integer
    Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
    unhealthyThreshold Integer
    Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
    uri String
    Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
    domain string
    The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
    enabled string
    Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
    healthyThreshold number
    Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
    httpCode string
    HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
    httpVersion string
    HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
    interval number
    After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
    method string
    After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
    port number
    Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
    protocol string
    Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
    timeout number
    Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
    unhealthyThreshold number
    Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
    uri string
    Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
    domain str
    The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
    enabled str
    Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
    healthy_threshold int
    Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
    http_code str
    HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
    http_version str
    HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
    interval int
    After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
    method str
    After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
    port int
    Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
    protocol str
    Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
    timeout int
    Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
    unhealthy_threshold int
    Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
    uri str
    Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
    domain String
    The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
    enabled String
    Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
    healthyThreshold Number
    Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
    httpCode String
    HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
    httpVersion String
    HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
    interval Number
    After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
    method String
    After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
    port Number
    Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
    protocol String
    Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
    timeout Number
    Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
    unhealthyThreshold Number
    Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
    uri String
    Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.

    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
    Description of the backend server.
    InstanceId string
    ID of the cloud server instance or network interface.
    Ip string
    Private IP address of the backend server.
    Port int
    Port number on which the backend server receives requests.
    RemoteEnabled string
    Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
    ServerId string
    Backend server ID.
    Type string
    Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
    Weight int
    Backend server weight.
    Description string
    Description of the backend server.
    InstanceId string
    ID of the cloud server instance or network interface.
    Ip string
    Private IP address of the backend server.
    Port int
    Port number on which the backend server receives requests.
    RemoteEnabled string
    Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
    ServerId string
    Backend server ID.
    Type string
    Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
    Weight int
    Backend server weight.
    description String
    Description of the backend server.
    instanceId String
    ID of the cloud server instance or network interface.
    ip String
    Private IP address of the backend server.
    port Integer
    Port number on which the backend server receives requests.
    remoteEnabled String
    Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
    serverId String
    Backend server ID.
    type String
    Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
    weight Integer
    Backend server weight.
    description string
    Description of the backend server.
    instanceId string
    ID of the cloud server instance or network interface.
    ip string
    Private IP address of the backend server.
    port number
    Port number on which the backend server receives requests.
    remoteEnabled string
    Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
    serverId string
    Backend server ID.
    type string
    Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
    weight number
    Backend server weight.
    description str
    Description of the backend server.
    instance_id str
    ID of the cloud server instance or network interface.
    ip str
    Private IP address of the backend server.
    port int
    Port number on which the backend server receives requests.
    remote_enabled str
    Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
    server_id str
    Backend server ID.
    type str
    Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
    weight int
    Backend server weight.
    description String
    Description of the backend server.
    instanceId String
    ID of the cloud server instance or network interface.
    ip String
    Private IP address of the backend server.
    port Number
    Port number on which the backend server receives requests.
    remoteEnabled String
    Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
    serverId String
    Backend server ID.
    type String
    Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
    weight Number
    Backend server weight.

    ServerGroupStickySessionConfig, ServerGroupStickySessionConfigArgs

    Cookie string
    Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
    CookieTimeout int
    Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
    StickySessionEnabled string
    Enable session persistence. on: Enable; off (default): Disable.
    StickySessionType string
    Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
    Cookie string
    Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
    CookieTimeout int
    Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
    StickySessionEnabled string
    Enable session persistence. on: Enable; off (default): Disable.
    StickySessionType string
    Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
    cookie String
    Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
    cookieTimeout Integer
    Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
    stickySessionEnabled String
    Enable session persistence. on: Enable; off (default): Disable.
    stickySessionType String
    Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
    cookie string
    Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
    cookieTimeout number
    Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
    stickySessionEnabled string
    Enable session persistence. on: Enable; off (default): Disable.
    stickySessionType string
    Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
    cookie str
    Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
    cookie_timeout int
    Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
    sticky_session_enabled str
    Enable session persistence. on: Enable; off (default): Disable.
    sticky_session_type str
    Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
    cookie String
    Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
    cookieTimeout Number
    Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
    stickySessionEnabled String
    Enable session persistence. on: Enable; off (default): Disable.
    stickySessionType String
    Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.

    ServerGroupTag, ServerGroupTagArgs

    Key string
    Tag key. Duplicate tag keys are not allowed for the same resource.
    Value string
    Tag value.
    Key string
    Tag key. Duplicate tag keys are not allowed for the same resource.
    Value string
    Tag value.
    key String
    Tag key. Duplicate tag keys are not allowed for the same resource.
    value String
    Tag value.
    key string
    Tag key. Duplicate tag keys are not allowed for the same resource.
    value string
    Tag value.
    key str
    Tag key. Duplicate tag keys are not allowed for the same resource.
    value str
    Tag value.
    key String
    Tag key. Duplicate tag keys are not allowed for the same resource.
    value String
    Tag value.

    Import

    $ pulumi import bytepluscc:alb/serverGroup:ServerGroup example "server_group_id"
    

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

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.25
    published on Thursday, May 7, 2026 by Byteplus
      Try Pulumi Cloud free. Your team will thank you.