1. Packages
  2. Volcengine
  3. API Docs
  4. alb
  5. ServerGroup
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.alb.ServerGroup

volcengine logo
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Provides a resource to manage alb server group

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@volcengine/pulumi";

const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const fooServerGroup = new volcengine.alb.ServerGroup("fooServerGroup", {
    vpcId: fooVpc.id,
    serverGroupName: "acc-test-server-group",
    description: "acc-test",
    serverGroupType: "instance",
    scheduler: "wlc",
    protocol: "HTTP",
    ipAddressType: "IPv4",
    projectName: "default",
    healthCheck: {
        enabled: "on",
        interval: 3,
        timeout: 3,
        method: "GET",
        domain: "www.test.com",
        uri: "/health",
        httpCode: "http_2xx,http_3xx",
        protocol: "HTTP",
        port: 80,
        httpVersion: "HTTP1.1",
    },
    stickySessionConfig: {
        stickySessionEnabled: "on",
        stickySessionType: "insert",
        cookieTimeout: 1100,
    },
    tags: [{
        key: "key1",
        value: "value2",
    }],
});

    import pulumi
import pulumi_volcengine as volcengine

foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_server_group = volcengine.alb.ServerGroup("fooServerGroup",
    vpc_id=foo_vpc.id,
    server_group_name="acc-test-server-group",
    description="acc-test",
    server_group_type="instance",
    scheduler="wlc",
    protocol="HTTP",
    ip_address_type="IPv4",
    project_name="default",
    health_check=volcengine.alb.ServerGroupHealthCheckArgs(
        enabled="on",
        interval=3,
        timeout=3,
        method="GET",
        domain="www.test.com",
        uri="/health",
        http_code="http_2xx,http_3xx",
        protocol="HTTP",
        port=80,
        http_version="HTTP1.1",
    ),
    sticky_session_config=volcengine.alb.ServerGroupStickySessionConfigArgs(
        sticky_session_enabled="on",
        sticky_session_type="insert",
        cookie_timeout=1100,
    ),
    tags=[volcengine.alb.ServerGroupTagArgs(
        key="key1",
        value="value2",
    )])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/alb"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		_, err = alb.NewServerGroup(ctx, "fooServerGroup", &alb.ServerGroupArgs{
			VpcId:           fooVpc.ID(),
			ServerGroupName: pulumi.String("acc-test-server-group"),
			Description:     pulumi.String("acc-test"),
			ServerGroupType: pulumi.String("instance"),
			Scheduler:       pulumi.String("wlc"),
			Protocol:        pulumi.String("HTTP"),
			IpAddressType:   pulumi.String("IPv4"),
			ProjectName:     pulumi.String("default"),
			HealthCheck: &alb.ServerGroupHealthCheckArgs{
				Enabled:     pulumi.String("on"),
				Interval:    pulumi.Int(3),
				Timeout:     pulumi.Int(3),
				Method:      pulumi.String("GET"),
				Domain:      pulumi.String("www.test.com"),
				Uri:         pulumi.String("/health"),
				HttpCode:    pulumi.String("http_2xx,http_3xx"),
				Protocol:    pulumi.String("HTTP"),
				Port:        pulumi.Int(80),
				HttpVersion: pulumi.String("HTTP1.1"),
			},
			StickySessionConfig: &alb.ServerGroupStickySessionConfigArgs{
				StickySessionEnabled: pulumi.String("on"),
				StickySessionType:    pulumi.String("insert"),
				CookieTimeout:        pulumi.Int(1100),
			},
			Tags: alb.ServerGroupTagArray{
				&alb.ServerGroupTagArgs{
					Key:   pulumi.String("key1"),
					Value: pulumi.String("value2"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooServerGroup = new Volcengine.Alb.ServerGroup("fooServerGroup", new()
    {
        VpcId = fooVpc.Id,
        ServerGroupName = "acc-test-server-group",
        Description = "acc-test",
        ServerGroupType = "instance",
        Scheduler = "wlc",
        Protocol = "HTTP",
        IpAddressType = "IPv4",
        ProjectName = "default",
        HealthCheck = new Volcengine.Alb.Inputs.ServerGroupHealthCheckArgs
        {
            Enabled = "on",
            Interval = 3,
            Timeout = 3,
            Method = "GET",
            Domain = "www.test.com",
            Uri = "/health",
            HttpCode = "http_2xx,http_3xx",
            Protocol = "HTTP",
            Port = 80,
            HttpVersion = "HTTP1.1",
        },
        StickySessionConfig = new Volcengine.Alb.Inputs.ServerGroupStickySessionConfigArgs
        {
            StickySessionEnabled = "on",
            StickySessionType = "insert",
            CookieTimeout = 1100,
        },
        Tags = new[]
        {
            new Volcengine.Alb.Inputs.ServerGroupTagArgs
            {
                Key = "key1",
                Value = "value2",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.alb.ServerGroup;
import com.pulumi.volcengine.alb.ServerGroupArgs;
import com.pulumi.volcengine.alb.inputs.ServerGroupHealthCheckArgs;
import com.pulumi.volcengine.alb.inputs.ServerGroupStickySessionConfigArgs;
import com.pulumi.volcengine.alb.inputs.ServerGroupTagArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooServerGroup = new ServerGroup("fooServerGroup", ServerGroupArgs.builder()        
            .vpcId(fooVpc.id())
            .serverGroupName("acc-test-server-group")
            .description("acc-test")
            .serverGroupType("instance")
            .scheduler("wlc")
            .protocol("HTTP")
            .ipAddressType("IPv4")
            .projectName("default")
            .healthCheck(ServerGroupHealthCheckArgs.builder()
                .enabled("on")
                .interval(3)
                .timeout(3)
                .method("GET")
                .domain("www.test.com")
                .uri("/health")
                .httpCode("http_2xx,http_3xx")
                .protocol("HTTP")
                .port(80)
                .httpVersion("HTTP1.1")
                .build())
            .stickySessionConfig(ServerGroupStickySessionConfigArgs.builder()
                .stickySessionEnabled("on")
                .stickySessionType("insert")
                .cookieTimeout(1100)
                .build())
            .tags(ServerGroupTagArgs.builder()
                .key("key1")
                .value("value2")
                .build())
            .build());

    }
}

    resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooServerGroup:
    type: volcengine:alb:ServerGroup
    properties:
      vpcId: ${fooVpc.id}
      serverGroupName: acc-test-server-group
      description: acc-test
      serverGroupType: instance
      scheduler: wlc
      protocol: HTTP
      ipAddressType: IPv4
      projectName: default
      healthCheck:
        enabled: on
        interval: 3
        timeout: 3
        method: GET
        domain: www.test.com
        uri: /health
        httpCode: http_2xx,http_3xx
        protocol: HTTP
        port: 80
        httpVersion: HTTP1.1
      stickySessionConfig:
        stickySessionEnabled: on
        stickySessionType: insert
        cookieTimeout: 1100
      tags:
        - key: key1
          value: value2

    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,
                cross_zone_enabled: Optional[str] = None,
                description: Optional[str] = None,
                health_check: Optional[ServerGroupHealthCheckArgs] = None,
                ip_address_type: Optional[str] = None,
                project_name: Optional[str] = None,
                protocol: Optional[str] = None,
                scheduler: Optional[str] = None,
                server_group_name: Optional[str] = None,
                server_group_type: Optional[str] = None,
                sticky_session_config: Optional[ServerGroupStickySessionConfigArgs] = None,
                tags: Optional[Sequence[ServerGroupTagArgs]] = 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: volcengine: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 Volcengine.Alb.ServerGroup("serverGroupResource", new()
{
    VpcId = "string",
    CrossZoneEnabled = "string",
    Description = "string",
    HealthCheck = new Volcengine.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",
    Scheduler = "string",
    ServerGroupName = "string",
    ServerGroupType = "string",
    StickySessionConfig = new Volcengine.Alb.Inputs.ServerGroupStickySessionConfigArgs
    {
        Cookie = "string",
        CookieTimeout = 0,
        StickySessionEnabled = "string",
        StickySessionType = "string",
    },
    Tags = new[]
    {
        new Volcengine.Alb.Inputs.ServerGroupTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
});

    example, err := alb.NewServerGroup(ctx, "serverGroupResource", &alb.ServerGroupArgs{
	VpcId:            pulumi.String("string"),
	CrossZoneEnabled: pulumi.String("string"),
	Description:      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"),
	Scheduler:       pulumi.String("string"),
	ServerGroupName: pulumi.String("string"),
	ServerGroupType: 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"),
		},
	},
})

    var serverGroupResource = new com.pulumi.volcengine.alb.ServerGroup("serverGroupResource", com.pulumi.volcengine.alb.ServerGroupArgs.builder()
    .vpcId("string")
    .crossZoneEnabled("string")
    .description("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")
    .scheduler("string")
    .serverGroupName("string")
    .serverGroupType("string")
    .stickySessionConfig(ServerGroupStickySessionConfigArgs.builder()
        .cookie("string")
        .cookieTimeout(0)
        .stickySessionEnabled("string")
        .stickySessionType("string")
        .build())
    .tags(ServerGroupTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

    server_group_resource = volcengine.alb.ServerGroup("serverGroupResource",
    vpc_id="string",
    cross_zone_enabled="string",
    description="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",
    scheduler="string",
    server_group_name="string",
    server_group_type="string",
    sticky_session_config={
        "cookie": "string",
        "cookie_timeout": 0,
        "sticky_session_enabled": "string",
        "sticky_session_type": "string",
    },
    tags=[{
        "key": "string",
        "value": "string",
    }])

    const serverGroupResource = new volcengine.alb.ServerGroup("serverGroupResource", {
    vpcId: "string",
    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",
    stickySessionConfig: {
        cookie: "string",
        cookieTimeout: 0,
        stickySessionEnabled: "string",
        stickySessionType: "string",
    },
    tags: [{
        key: "string",
        value: "string",
    }],
});

    type: volcengine: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
    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
    The vpc id of the Alb server group.
    CrossZoneEnabled string
    Whether to enable cross-zone load balancing for the server group. Valid values: on, off.
    Description string
    The description of the Alb server group.
    HealthCheck ServerGroupHealthCheck
    The health check config of the Alb server group. The enable status of health check function defaults to on.
    IpAddressType string
    The ip address type of the server group.
    ProjectName string
    The project name of the Alb server group.
    Protocol string
    The backend protocol of the Alb server group. Valid values: HTTP, HTTPS, gRPC. Default is HTTP.
    Scheduler string
    The scheduling algorithm of the Alb server group. Valid values: wrr, wlc, sh.
    ServerGroupName string
    The name of the Alb server group.
    ServerGroupType string
    The type of the Alb server group. Valid values: instance, ip. Default is instance.
    StickySessionConfig ServerGroupStickySessionConfig
    The sticky session config of the Alb server group. The enable status of sticky session function defaults to off.
    Tags List<ServerGroupTag>
    Tags.
    VpcId string
    The vpc id of the Alb server group.
    CrossZoneEnabled string
    Whether to enable cross-zone load balancing for the server group. Valid values: on, off.
    Description string
    The description of the Alb server group.
    HealthCheck ServerGroupHealthCheckArgs
    The health check config of the Alb server group. The enable status of health check function defaults to on.
    IpAddressType string
    The ip address type of the server group.
    ProjectName string
    The project name of the Alb server group.
    Protocol string
    The backend protocol of the Alb server group. Valid values: HTTP, HTTPS, gRPC. Default is HTTP.
    Scheduler string
    The scheduling algorithm of the Alb server group. Valid values: wrr, wlc, sh.
    ServerGroupName string
    The name of the Alb server group.
    ServerGroupType string
    The type of the Alb server group. Valid values: instance, ip. Default is instance.
    StickySessionConfig ServerGroupStickySessionConfigArgs
    The sticky session config of the Alb server group. The enable status of sticky session function defaults to off.
    Tags []ServerGroupTagArgs
    Tags.
    vpcId String
    The vpc id of the Alb server group.
    crossZoneEnabled String
    Whether to enable cross-zone load balancing for the server group. Valid values: on, off.
    description String
    The description of the Alb server group.
    healthCheck ServerGroupHealthCheck
    The health check config of the Alb server group. The enable status of health check function defaults to on.
    ipAddressType String
    The ip address type of the server group.
    projectName String
    The project name of the Alb server group.
    protocol String
    The backend protocol of the Alb server group. Valid values: HTTP, HTTPS, gRPC. Default is HTTP.
    scheduler String
    The scheduling algorithm of the Alb server group. Valid values: wrr, wlc, sh.
    serverGroupName String
    The name of the Alb server group.
    serverGroupType String
    The type of the Alb server group. Valid values: instance, ip. Default is instance.
    stickySessionConfig ServerGroupStickySessionConfig
    The sticky session config of the Alb server group. The enable status of sticky session function defaults to off.
    tags List<ServerGroupTag>
    Tags.
    vpcId string
    The vpc id of the Alb server group.
    crossZoneEnabled string
    Whether to enable cross-zone load balancing for the server group. Valid values: on, off.
    description string
    The description of the Alb server group.
    healthCheck ServerGroupHealthCheck
    The health check config of the Alb server group. The enable status of health check function defaults to on.
    ipAddressType string
    The ip address type of the server group.
    projectName string
    The project name of the Alb server group.
    protocol string
    The backend protocol of the Alb server group. Valid values: HTTP, HTTPS, gRPC. Default is HTTP.
    scheduler string
    The scheduling algorithm of the Alb server group. Valid values: wrr, wlc, sh.
    serverGroupName string
    The name of the Alb server group.
    serverGroupType string
    The type of the Alb server group. Valid values: instance, ip. Default is instance.
    stickySessionConfig ServerGroupStickySessionConfig
    The sticky session config of the Alb server group. The enable status of sticky session function defaults to off.
    tags ServerGroupTag[]
    Tags.
    vpc_id str
    The vpc id of the Alb server group.
    cross_zone_enabled str
    Whether to enable cross-zone load balancing for the server group. Valid values: on, off.
    description str
    The description of the Alb server group.
    health_check ServerGroupHealthCheckArgs
    The health check config of the Alb server group. The enable status of health check function defaults to on.
    ip_address_type str
    The ip address type of the server group.
    project_name str
    The project name of the Alb server group.
    protocol str
    The backend protocol of the Alb server group. Valid values: HTTP, HTTPS, gRPC. Default is HTTP.
    scheduler str
    The scheduling algorithm of the Alb server group. Valid values: wrr, wlc, sh.
    server_group_name str
    The name of the Alb server group.
    server_group_type str
    The type of the Alb server group. Valid values: instance, ip. Default is instance.
    sticky_session_config ServerGroupStickySessionConfigArgs
    The sticky session config of the Alb server group. The enable status of sticky session function defaults to off.
    tags Sequence[ServerGroupTagArgs]
    Tags.
    vpcId String
    The vpc id of the Alb server group.
    crossZoneEnabled String
    Whether to enable cross-zone load balancing for the server group. Valid values: on, off.
    description String
    The description of the Alb server group.
    healthCheck Property Map
    The health check config of the Alb server group. The enable status of health check function defaults to on.
    ipAddressType String
    The ip address type of the server group.
    projectName String
    The project name of the Alb server group.
    protocol String
    The backend protocol of the Alb server group. Valid values: HTTP, HTTPS, gRPC. Default is HTTP.
    scheduler String
    The scheduling algorithm of the Alb server group. Valid values: wrr, wlc, sh.
    serverGroupName String
    The name of the Alb server group.
    serverGroupType String
    The type of the Alb server group. Valid values: instance, ip. Default is instance.
    stickySessionConfig Property Map
    The sticky session config of the Alb server group. The enable status of sticky session function defaults to off.
    tags List<Property Map>
    Tags.

    Outputs

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

    CreateTime string
    The create time of the Alb server group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Listeners List<string>
    The listener information of the Alb server group.
    ServerCount int
    The server count of the Alb server group.
    Status string
    The status of the Alb server group.
    UpdateTime string
    The update time of the Alb server group.
    CreateTime string
    The create time of the Alb server group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Listeners []string
    The listener information of the Alb server group.
    ServerCount int
    The server count of the Alb server group.
    Status string
    The status of the Alb server group.
    UpdateTime string
    The update time of the Alb server group.
    createTime String
    The create time of the Alb server group.
    id String
    The provider-assigned unique ID for this managed resource.
    listeners List<String>
    The listener information of the Alb server group.
    serverCount Integer
    The server count of the Alb server group.
    status String
    The status of the Alb server group.
    updateTime String
    The update time of the Alb server group.
    createTime string
    The create time of the Alb server group.
    id string
    The provider-assigned unique ID for this managed resource.
    listeners string[]
    The listener information of the Alb server group.
    serverCount number
    The server count of the Alb server group.
    status string
    The status of the Alb server group.
    updateTime string
    The update time of the Alb server group.
    create_time str
    The create time of the Alb server group.
    id str
    The provider-assigned unique ID for this managed resource.
    listeners Sequence[str]
    The listener information of the Alb server group.
    server_count int
    The server count of the Alb server group.
    status str
    The status of the Alb server group.
    update_time str
    The update time of the Alb server group.
    createTime String
    The create time of the Alb server group.
    id String
    The provider-assigned unique ID for this managed resource.
    listeners List<String>
    The listener information of the Alb server group.
    serverCount Number
    The server count of the Alb server group.
    status String
    The status of the Alb server group.
    updateTime String
    The update time of the Alb 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[str]] = None,
        project_name: Optional[str] = None,
        protocol: Optional[str] = None,
        scheduler: Optional[str] = None,
        server_count: Optional[int] = None,
        server_group_name: Optional[str] = None,
        server_group_type: Optional[str] = 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: volcengine: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
    The create time of the Alb server group.
    CrossZoneEnabled string
    Whether to enable cross-zone load balancing for the server group. Valid values: on, off.
    Description string
    The description of the Alb server group.
    HealthCheck ServerGroupHealthCheck
    The health check config of the Alb server group. The enable status of health check function defaults to on.
    IpAddressType string
    The ip address type of the server group.
    Listeners List<string>
    The listener information of the Alb server group.
    ProjectName string
    The project name of the Alb server group.
    Protocol string
    The backend protocol of the Alb server group. Valid values: HTTP, HTTPS, gRPC. Default is HTTP.
    Scheduler string
    The scheduling algorithm of the Alb server group. Valid values: wrr, wlc, sh.
    ServerCount int
    The server count of the Alb server group.
    ServerGroupName string
    The name of the Alb server group.
    ServerGroupType string
    The type of the Alb server group. Valid values: instance, ip. Default is instance.
    Status string
    The status of the Alb server group.
    StickySessionConfig ServerGroupStickySessionConfig
    The sticky session config of the Alb server group. The enable status of sticky session function defaults to off.
    Tags List<ServerGroupTag>
    Tags.
    UpdateTime string
    The update time of the Alb server group.
    VpcId string
    The vpc id of the Alb server group.
    CreateTime string
    The create time of the Alb server group.
    CrossZoneEnabled string
    Whether to enable cross-zone load balancing for the server group. Valid values: on, off.
    Description string
    The description of the Alb server group.
    HealthCheck ServerGroupHealthCheckArgs
    The health check config of the Alb server group. The enable status of health check function defaults to on.
    IpAddressType string
    The ip address type of the server group.
    Listeners []string
    The listener information of the Alb server group.
    ProjectName string
    The project name of the Alb server group.
    Protocol string
    The backend protocol of the Alb server group. Valid values: HTTP, HTTPS, gRPC. Default is HTTP.
    Scheduler string
    The scheduling algorithm of the Alb server group. Valid values: wrr, wlc, sh.
    ServerCount int
    The server count of the Alb server group.
    ServerGroupName string
    The name of the Alb server group.
    ServerGroupType string
    The type of the Alb server group. Valid values: instance, ip. Default is instance.
    Status string
    The status of the Alb server group.
    StickySessionConfig ServerGroupStickySessionConfigArgs
    The sticky session config of the Alb server group. The enable status of sticky session function defaults to off.
    Tags []ServerGroupTagArgs
    Tags.
    UpdateTime string
    The update time of the Alb server group.
    VpcId string
    The vpc id of the Alb server group.
    createTime String
    The create time of the Alb server group.
    crossZoneEnabled String
    Whether to enable cross-zone load balancing for the server group. Valid values: on, off.
    description String
    The description of the Alb server group.
    healthCheck ServerGroupHealthCheck
    The health check config of the Alb server group. The enable status of health check function defaults to on.
    ipAddressType String
    The ip address type of the server group.
    listeners List<String>
    The listener information of the Alb server group.
    projectName String
    The project name of the Alb server group.
    protocol String
    The backend protocol of the Alb server group. Valid values: HTTP, HTTPS, gRPC. Default is HTTP.
    scheduler String
    The scheduling algorithm of the Alb server group. Valid values: wrr, wlc, sh.
    serverCount Integer
    The server count of the Alb server group.
    serverGroupName String
    The name of the Alb server group.
    serverGroupType String
    The type of the Alb server group. Valid values: instance, ip. Default is instance.
    status String
    The status of the Alb server group.
    stickySessionConfig ServerGroupStickySessionConfig
    The sticky session config of the Alb server group. The enable status of sticky session function defaults to off.
    tags List<ServerGroupTag>
    Tags.
    updateTime String
    The update time of the Alb server group.
    vpcId String
    The vpc id of the Alb server group.
    createTime string
    The create time of the Alb server group.
    crossZoneEnabled string
    Whether to enable cross-zone load balancing for the server group. Valid values: on, off.
    description string
    The description of the Alb server group.
    healthCheck ServerGroupHealthCheck
    The health check config of the Alb server group. The enable status of health check function defaults to on.
    ipAddressType string
    The ip address type of the server group.
    listeners string[]
    The listener information of the Alb server group.
    projectName string
    The project name of the Alb server group.
    protocol string
    The backend protocol of the Alb server group. Valid values: HTTP, HTTPS, gRPC. Default is HTTP.
    scheduler string
    The scheduling algorithm of the Alb server group. Valid values: wrr, wlc, sh.
    serverCount number
    The server count of the Alb server group.
    serverGroupName string
    The name of the Alb server group.
    serverGroupType string
    The type of the Alb server group. Valid values: instance, ip. Default is instance.
    status string
    The status of the Alb server group.
    stickySessionConfig ServerGroupStickySessionConfig
    The sticky session config of the Alb server group. The enable status of sticky session function defaults to off.
    tags ServerGroupTag[]
    Tags.
    updateTime string
    The update time of the Alb server group.
    vpcId string
    The vpc id of the Alb server group.
    create_time str
    The create time of the Alb server group.
    cross_zone_enabled str
    Whether to enable cross-zone load balancing for the server group. Valid values: on, off.
    description str
    The description of the Alb server group.
    health_check ServerGroupHealthCheckArgs
    The health check config of the Alb server group. The enable status of health check function defaults to on.
    ip_address_type str
    The ip address type of the server group.
    listeners Sequence[str]
    The listener information of the Alb server group.
    project_name str
    The project name of the Alb server group.
    protocol str
    The backend protocol of the Alb server group. Valid values: HTTP, HTTPS, gRPC. Default is HTTP.
    scheduler str
    The scheduling algorithm of the Alb server group. Valid values: wrr, wlc, sh.
    server_count int
    The server count of the Alb server group.
    server_group_name str
    The name of the Alb server group.
    server_group_type str
    The type of the Alb server group. Valid values: instance, ip. Default is instance.
    status str
    The status of the Alb server group.
    sticky_session_config ServerGroupStickySessionConfigArgs
    The sticky session config of the Alb server group. The enable status of sticky session function defaults to off.
    tags Sequence[ServerGroupTagArgs]
    Tags.
    update_time str
    The update time of the Alb server group.
    vpc_id str
    The vpc id of the Alb server group.
    createTime String
    The create time of the Alb server group.
    crossZoneEnabled String
    Whether to enable cross-zone load balancing for the server group. Valid values: on, off.
    description String
    The description of the Alb server group.
    healthCheck Property Map
    The health check config of the Alb server group. The enable status of health check function defaults to on.
    ipAddressType String
    The ip address type of the server group.
    listeners List<String>
    The listener information of the Alb server group.
    projectName String
    The project name of the Alb server group.
    protocol String
    The backend protocol of the Alb server group. Valid values: HTTP, HTTPS, gRPC. Default is HTTP.
    scheduler String
    The scheduling algorithm of the Alb server group. Valid values: wrr, wlc, sh.
    serverCount Number
    The server count of the Alb server group.
    serverGroupName String
    The name of the Alb server group.
    serverGroupType String
    The type of the Alb server group. Valid values: instance, ip. Default is instance.
    status String
    The status of the Alb server group.
    stickySessionConfig Property Map
    The sticky session config of the Alb server group. The enable status of sticky session function defaults to off.
    tags List<Property Map>
    Tags.
    updateTime String
    The update time of the Alb server group.
    vpcId String
    The vpc id of the Alb server group.

    Supporting Types

    ServerGroupHealthCheck, ServerGroupHealthCheckArgs

    Domain string
    The domain of health check.
    Enabled string
    The enable status of health check function. Valid values: on, off. Default is on.
    HealthyThreshold int
    The healthy threshold of health check. Valid value range in 2~10. Default is 3.
    HttpCode string
    The normal http status code of health check, the value can be http_2xx, http_3xx, http_4xx or http_5xx. Default is http_2xx,http_3xx.
    HttpVersion string
    The http version of health check. Valid values: HTTP1.0, HTTP1.1. Default is HTTP1.0.
    Interval int
    The interval executing health check. Unit: second. Valid value range in 1~300. Default is 2.
    Method string
    The method of health check. Valid values: GET or HEAD. Default is HEAD.
    Port int
    The port of health check. When the value is 0, it means use the backend server port for health check. Valid value range in 0~65535.
    Protocol string
    The protocol of health check. Valid values: HTTP, TCP. Default is HTTP.
    Timeout int
    The response timeout of health check. Unit: second. Valid value range in 1~60. Default is 2.
    UnhealthyThreshold int
    The unhealthy threshold of health check. Valid value range in 2~10. Default is 3.
    Uri string
    The uri of health check.
    Domain string
    The domain of health check.
    Enabled string
    The enable status of health check function. Valid values: on, off. Default is on.
    HealthyThreshold int
    The healthy threshold of health check. Valid value range in 2~10. Default is 3.
    HttpCode string
    The normal http status code of health check, the value can be http_2xx, http_3xx, http_4xx or http_5xx. Default is http_2xx,http_3xx.
    HttpVersion string
    The http version of health check. Valid values: HTTP1.0, HTTP1.1. Default is HTTP1.0.
    Interval int
    The interval executing health check. Unit: second. Valid value range in 1~300. Default is 2.
    Method string
    The method of health check. Valid values: GET or HEAD. Default is HEAD.
    Port int
    The port of health check. When the value is 0, it means use the backend server port for health check. Valid value range in 0~65535.
    Protocol string
    The protocol of health check. Valid values: HTTP, TCP. Default is HTTP.
    Timeout int
    The response timeout of health check. Unit: second. Valid value range in 1~60. Default is 2.
    UnhealthyThreshold int
    The unhealthy threshold of health check. Valid value range in 2~10. Default is 3.
    Uri string
    The uri of health check.
    domain String
    The domain of health check.
    enabled String
    The enable status of health check function. Valid values: on, off. Default is on.
    healthyThreshold Integer
    The healthy threshold of health check. Valid value range in 2~10. Default is 3.
    httpCode String
    The normal http status code of health check, the value can be http_2xx, http_3xx, http_4xx or http_5xx. Default is http_2xx,http_3xx.
    httpVersion String
    The http version of health check. Valid values: HTTP1.0, HTTP1.1. Default is HTTP1.0.
    interval Integer
    The interval executing health check. Unit: second. Valid value range in 1~300. Default is 2.
    method String
    The method of health check. Valid values: GET or HEAD. Default is HEAD.
    port Integer
    The port of health check. When the value is 0, it means use the backend server port for health check. Valid value range in 0~65535.
    protocol String
    The protocol of health check. Valid values: HTTP, TCP. Default is HTTP.
    timeout Integer
    The response timeout of health check. Unit: second. Valid value range in 1~60. Default is 2.
    unhealthyThreshold Integer
    The unhealthy threshold of health check. Valid value range in 2~10. Default is 3.
    uri String
    The uri of health check.
    domain string
    The domain of health check.
    enabled string
    The enable status of health check function. Valid values: on, off. Default is on.
    healthyThreshold number
    The healthy threshold of health check. Valid value range in 2~10. Default is 3.
    httpCode string
    The normal http status code of health check, the value can be http_2xx, http_3xx, http_4xx or http_5xx. Default is http_2xx,http_3xx.
    httpVersion string
    The http version of health check. Valid values: HTTP1.0, HTTP1.1. Default is HTTP1.0.
    interval number
    The interval executing health check. Unit: second. Valid value range in 1~300. Default is 2.
    method string
    The method of health check. Valid values: GET or HEAD. Default is HEAD.
    port number
    The port of health check. When the value is 0, it means use the backend server port for health check. Valid value range in 0~65535.
    protocol string
    The protocol of health check. Valid values: HTTP, TCP. Default is HTTP.
    timeout number
    The response timeout of health check. Unit: second. Valid value range in 1~60. Default is 2.
    unhealthyThreshold number
    The unhealthy threshold of health check. Valid value range in 2~10. Default is 3.
    uri string
    The uri of health check.
    domain str
    The domain of health check.
    enabled str
    The enable status of health check function. Valid values: on, off. Default is on.
    healthy_threshold int
    The healthy threshold of health check. Valid value range in 2~10. Default is 3.
    http_code str
    The normal http status code of health check, the value can be http_2xx, http_3xx, http_4xx or http_5xx. Default is http_2xx,http_3xx.
    http_version str
    The http version of health check. Valid values: HTTP1.0, HTTP1.1. Default is HTTP1.0.
    interval int
    The interval executing health check. Unit: second. Valid value range in 1~300. Default is 2.
    method str
    The method of health check. Valid values: GET or HEAD. Default is HEAD.
    port int
    The port of health check. When the value is 0, it means use the backend server port for health check. Valid value range in 0~65535.
    protocol str
    The protocol of health check. Valid values: HTTP, TCP. Default is HTTP.
    timeout int
    The response timeout of health check. Unit: second. Valid value range in 1~60. Default is 2.
    unhealthy_threshold int
    The unhealthy threshold of health check. Valid value range in 2~10. Default is 3.
    uri str
    The uri of health check.
    domain String
    The domain of health check.
    enabled String
    The enable status of health check function. Valid values: on, off. Default is on.
    healthyThreshold Number
    The healthy threshold of health check. Valid value range in 2~10. Default is 3.
    httpCode String
    The normal http status code of health check, the value can be http_2xx, http_3xx, http_4xx or http_5xx. Default is http_2xx,http_3xx.
    httpVersion String
    The http version of health check. Valid values: HTTP1.0, HTTP1.1. Default is HTTP1.0.
    interval Number
    The interval executing health check. Unit: second. Valid value range in 1~300. Default is 2.
    method String
    The method of health check. Valid values: GET or HEAD. Default is HEAD.
    port Number
    The port of health check. When the value is 0, it means use the backend server port for health check. Valid value range in 0~65535.
    protocol String
    The protocol of health check. Valid values: HTTP, TCP. Default is HTTP.
    timeout Number
    The response timeout of health check. Unit: second. Valid value range in 1~60. Default is 2.
    unhealthyThreshold Number
    The unhealthy threshold of health check. Valid value range in 2~10. Default is 3.
    uri String
    The uri of health check.

    ServerGroupStickySessionConfig, ServerGroupStickySessionConfigArgs

    Cookie string
    The cookie name of the sticky session. This field is required when the value of the sticky_session_type is server.
    CookieTimeout int
    The cookie timeout of the sticky session. Unit: second. Valid value range in 1~86400. Default is 1000. This field is required when the value of the sticky_session_type is insert.
    StickySessionEnabled string
    The enable status of sticky session. Valid values: on, off. Default is off.
    StickySessionType string
    The cookie handle type of the sticky session. Valid values: insert, server. Default is insert. This field is required when the value of the sticky_session_enabled is on.
    Cookie string
    The cookie name of the sticky session. This field is required when the value of the sticky_session_type is server.
    CookieTimeout int
    The cookie timeout of the sticky session. Unit: second. Valid value range in 1~86400. Default is 1000. This field is required when the value of the sticky_session_type is insert.
    StickySessionEnabled string
    The enable status of sticky session. Valid values: on, off. Default is off.
    StickySessionType string
    The cookie handle type of the sticky session. Valid values: insert, server. Default is insert. This field is required when the value of the sticky_session_enabled is on.
    cookie String
    The cookie name of the sticky session. This field is required when the value of the sticky_session_type is server.
    cookieTimeout Integer
    The cookie timeout of the sticky session. Unit: second. Valid value range in 1~86400. Default is 1000. This field is required when the value of the sticky_session_type is insert.
    stickySessionEnabled String
    The enable status of sticky session. Valid values: on, off. Default is off.
    stickySessionType String
    The cookie handle type of the sticky session. Valid values: insert, server. Default is insert. This field is required when the value of the sticky_session_enabled is on.
    cookie string
    The cookie name of the sticky session. This field is required when the value of the sticky_session_type is server.
    cookieTimeout number
    The cookie timeout of the sticky session. Unit: second. Valid value range in 1~86400. Default is 1000. This field is required when the value of the sticky_session_type is insert.
    stickySessionEnabled string
    The enable status of sticky session. Valid values: on, off. Default is off.
    stickySessionType string
    The cookie handle type of the sticky session. Valid values: insert, server. Default is insert. This field is required when the value of the sticky_session_enabled is on.
    cookie str
    The cookie name of the sticky session. This field is required when the value of the sticky_session_type is server.
    cookie_timeout int
    The cookie timeout of the sticky session. Unit: second. Valid value range in 1~86400. Default is 1000. This field is required when the value of the sticky_session_type is insert.
    sticky_session_enabled str
    The enable status of sticky session. Valid values: on, off. Default is off.
    sticky_session_type str
    The cookie handle type of the sticky session. Valid values: insert, server. Default is insert. This field is required when the value of the sticky_session_enabled is on.
    cookie String
    The cookie name of the sticky session. This field is required when the value of the sticky_session_type is server.
    cookieTimeout Number
    The cookie timeout of the sticky session. Unit: second. Valid value range in 1~86400. Default is 1000. This field is required when the value of the sticky_session_type is insert.
    stickySessionEnabled String
    The enable status of sticky session. Valid values: on, off. Default is off.
    stickySessionType String
    The cookie handle type of the sticky session. Valid values: insert, server. Default is insert. This field is required when the value of the sticky_session_enabled is on.

    ServerGroupTag, ServerGroupTagArgs

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Import

    AlbServerGroup can be imported using the id, e.g.

    $ pulumi import volcengine:alb/serverGroup:ServerGroup default resource_id

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate