1. Packages
  2. Volcengine
  3. API Docs
  4. nlb
  5. ServerGroup
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.nlb.ServerGroup

volcengine logo
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    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,
                server_group_name: Optional[str] = None,
                vpc_id: Optional[str] = None,
                proxy_protocol_type: Optional[str] = None,
                scheduler: Optional[str] = None,
                description: Optional[str] = None,
                health_check: Optional[ServerGroupHealthCheckArgs] = None,
                ip_address_version: Optional[str] = None,
                preserve_client_ip_enabled: Optional[bool] = None,
                project_name: Optional[str] = None,
                protocol: Optional[str] = None,
                any_port_enabled: Optional[bool] = None,
                connection_drain_timeout: Optional[int] = None,
                connection_drain_enabled: Optional[bool] = None,
                servers: Optional[Sequence[ServerGroupServerArgs]] = None,
                session_persistence_enabled: Optional[bool] = None,
                session_persistence_timeout: Optional[int] = None,
                tags: Optional[Sequence[ServerGroupTagArgs]] = None,
                timestamp_remove_enabled: Optional[bool] = None,
                type: Optional[str] = None,
                bypass_security_group_enabled: Optional[bool] = 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:nlb: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 exampleserverGroupResourceResourceFromNlbserverGroup = new Volcengine.Nlb.ServerGroup("exampleserverGroupResourceResourceFromNlbserverGroup", new()
{
    ServerGroupName = "string",
    VpcId = "string",
    ProxyProtocolType = "string",
    Scheduler = "string",
    Description = "string",
    HealthCheck = new Volcengine.Nlb.Inputs.ServerGroupHealthCheckArgs
    {
        Domain = "string",
        Enabled = false,
        HealthyThreshold = 0,
        HttpCode = "string",
        Interval = 0,
        Method = "string",
        Port = 0,
        Timeout = 0,
        Type = "string",
        UdpConnectTimeout = 0,
        UdpExpect = "string",
        UdpRequest = "string",
        UnhealthyThreshold = 0,
        Uri = "string",
    },
    IpAddressVersion = "string",
    PreserveClientIpEnabled = false,
    ProjectName = "string",
    Protocol = "string",
    AnyPortEnabled = false,
    ConnectionDrainTimeout = 0,
    ConnectionDrainEnabled = false,
    Servers = new[]
    {
        new Volcengine.Nlb.Inputs.ServerGroupServerArgs
        {
            Description = "string",
            InstanceId = "string",
            Ip = "string",
            Port = 0,
            ServerId = "string",
            Type = "string",
            Weight = 0,
            ZoneId = "string",
        },
    },
    SessionPersistenceEnabled = false,
    SessionPersistenceTimeout = 0,
    Tags = new[]
    {
        new Volcengine.Nlb.Inputs.ServerGroupTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    TimestampRemoveEnabled = false,
    Type = "string",
    BypassSecurityGroupEnabled = false,
});

    example, err := nlb.NewServerGroup(ctx, "exampleserverGroupResourceResourceFromNlbserverGroup", &nlb.ServerGroupArgs{
	ServerGroupName:   pulumi.String("string"),
	VpcId:             pulumi.String("string"),
	ProxyProtocolType: pulumi.String("string"),
	Scheduler:         pulumi.String("string"),
	Description:       pulumi.String("string"),
	HealthCheck: &nlb.ServerGroupHealthCheckArgs{
		Domain:             pulumi.String("string"),
		Enabled:            pulumi.Bool(false),
		HealthyThreshold:   pulumi.Int(0),
		HttpCode:           pulumi.String("string"),
		Interval:           pulumi.Int(0),
		Method:             pulumi.String("string"),
		Port:               pulumi.Int(0),
		Timeout:            pulumi.Int(0),
		Type:               pulumi.String("string"),
		UdpConnectTimeout:  pulumi.Int(0),
		UdpExpect:          pulumi.String("string"),
		UdpRequest:         pulumi.String("string"),
		UnhealthyThreshold: pulumi.Int(0),
		Uri:                pulumi.String("string"),
	},
	IpAddressVersion:        pulumi.String("string"),
	PreserveClientIpEnabled: pulumi.Bool(false),
	ProjectName:             pulumi.String("string"),
	Protocol:                pulumi.String("string"),
	AnyPortEnabled:          pulumi.Bool(false),
	ConnectionDrainTimeout:  pulumi.Int(0),
	ConnectionDrainEnabled:  pulumi.Bool(false),
	Servers: nlb.ServerGroupServerArray{
		&nlb.ServerGroupServerArgs{
			Description: pulumi.String("string"),
			InstanceId:  pulumi.String("string"),
			Ip:          pulumi.String("string"),
			Port:        pulumi.Int(0),
			ServerId:    pulumi.String("string"),
			Type:        pulumi.String("string"),
			Weight:      pulumi.Int(0),
			ZoneId:      pulumi.String("string"),
		},
	},
	SessionPersistenceEnabled: pulumi.Bool(false),
	SessionPersistenceTimeout: pulumi.Int(0),
	Tags: nlb.ServerGroupTagArray{
		&nlb.ServerGroupTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	TimestampRemoveEnabled:     pulumi.Bool(false),
	Type:                       pulumi.String("string"),
	BypassSecurityGroupEnabled: pulumi.Bool(false),
})

    var exampleserverGroupResourceResourceFromNlbserverGroup = new com.pulumi.volcengine.nlb.ServerGroup("exampleserverGroupResourceResourceFromNlbserverGroup", com.pulumi.volcengine.nlb.ServerGroupArgs.builder()
    .serverGroupName("string")
    .vpcId("string")
    .proxyProtocolType("string")
    .scheduler("string")
    .description("string")
    .healthCheck(ServerGroupHealthCheckArgs.builder()
        .domain("string")
        .enabled(false)
        .healthyThreshold(0)
        .httpCode("string")
        .interval(0)
        .method("string")
        .port(0)
        .timeout(0)
        .type("string")
        .udpConnectTimeout(0)
        .udpExpect("string")
        .udpRequest("string")
        .unhealthyThreshold(0)
        .uri("string")
        .build())
    .ipAddressVersion("string")
    .preserveClientIpEnabled(false)
    .projectName("string")
    .protocol("string")
    .anyPortEnabled(false)
    .connectionDrainTimeout(0)
    .connectionDrainEnabled(false)
    .servers(ServerGroupServerArgs.builder()
        .description("string")
        .instanceId("string")
        .ip("string")
        .port(0)
        .serverId("string")
        .type("string")
        .weight(0)
        .zoneId("string")
        .build())
    .sessionPersistenceEnabled(false)
    .sessionPersistenceTimeout(0)
    .tags(ServerGroupTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .timestampRemoveEnabled(false)
    .type("string")
    .bypassSecurityGroupEnabled(false)
    .build());

    exampleserver_group_resource_resource_from_nlbserver_group = volcengine.nlb.ServerGroup("exampleserverGroupResourceResourceFromNlbserverGroup",
    server_group_name="string",
    vpc_id="string",
    proxy_protocol_type="string",
    scheduler="string",
    description="string",
    health_check={
        "domain": "string",
        "enabled": False,
        "healthy_threshold": 0,
        "http_code": "string",
        "interval": 0,
        "method": "string",
        "port": 0,
        "timeout": 0,
        "type": "string",
        "udp_connect_timeout": 0,
        "udp_expect": "string",
        "udp_request": "string",
        "unhealthy_threshold": 0,
        "uri": "string",
    },
    ip_address_version="string",
    preserve_client_ip_enabled=False,
    project_name="string",
    protocol="string",
    any_port_enabled=False,
    connection_drain_timeout=0,
    connection_drain_enabled=False,
    servers=[{
        "description": "string",
        "instance_id": "string",
        "ip": "string",
        "port": 0,
        "server_id": "string",
        "type": "string",
        "weight": 0,
        "zone_id": "string",
    }],
    session_persistence_enabled=False,
    session_persistence_timeout=0,
    tags=[{
        "key": "string",
        "value": "string",
    }],
    timestamp_remove_enabled=False,
    type="string",
    bypass_security_group_enabled=False)

    const exampleserverGroupResourceResourceFromNlbserverGroup = new volcengine.nlb.ServerGroup("exampleserverGroupResourceResourceFromNlbserverGroup", {
    serverGroupName: "string",
    vpcId: "string",
    proxyProtocolType: "string",
    scheduler: "string",
    description: "string",
    healthCheck: {
        domain: "string",
        enabled: false,
        healthyThreshold: 0,
        httpCode: "string",
        interval: 0,
        method: "string",
        port: 0,
        timeout: 0,
        type: "string",
        udpConnectTimeout: 0,
        udpExpect: "string",
        udpRequest: "string",
        unhealthyThreshold: 0,
        uri: "string",
    },
    ipAddressVersion: "string",
    preserveClientIpEnabled: false,
    projectName: "string",
    protocol: "string",
    anyPortEnabled: false,
    connectionDrainTimeout: 0,
    connectionDrainEnabled: false,
    servers: [{
        description: "string",
        instanceId: "string",
        ip: "string",
        port: 0,
        serverId: "string",
        type: "string",
        weight: 0,
        zoneId: "string",
    }],
    sessionPersistenceEnabled: false,
    sessionPersistenceTimeout: 0,
    tags: [{
        key: "string",
        value: "string",
    }],
    timestampRemoveEnabled: false,
    type: "string",
    bypassSecurityGroupEnabled: false,
});

    type: volcengine:nlb:ServerGroup
properties:
    anyPortEnabled: false
    bypassSecurityGroupEnabled: false
    connectionDrainEnabled: false
    connectionDrainTimeout: 0
    description: string
    healthCheck:
        domain: string
        enabled: false
        healthyThreshold: 0
        httpCode: string
        interval: 0
        method: string
        port: 0
        timeout: 0
        type: string
        udpConnectTimeout: 0
        udpExpect: string
        udpRequest: string
        unhealthyThreshold: 0
        uri: string
    ipAddressVersion: string
    preserveClientIpEnabled: false
    projectName: string
    protocol: string
    proxyProtocolType: string
    scheduler: string
    serverGroupName: string
    servers:
        - description: string
          instanceId: string
          ip: string
          port: 0
          serverId: string
          type: string
          weight: 0
          zoneId: string
    sessionPersistenceEnabled: false
    sessionPersistenceTimeout: 0
    tags:
        - key: string
          value: string
    timestampRemoveEnabled: false
    type: 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:

    ServerGroupName string
    The name of the server group.
    VpcId string
    The id of the VPC to which the server group belongs.
    AnyPortEnabled bool
    Whether to enable full port forwarding. Default is false.
    BypassSecurityGroupEnabled bool
    Whether to enable the function of passing through the backend security group. Default is false.
    ConnectionDrainEnabled bool
    Whether to enable connection graceful interruption. Default is false.
    ConnectionDrainTimeout int
    Connection graceful interruption timeout. Unit: second. Value range: 0 ~ 900. Default is 0.
    Description string
    The description of the server group.
    HealthCheck ServerGroupHealthCheck
    The health check config of the server group.
    IpAddressVersion string
    The ip address version of the server group. Valid values: ipv4 (default), ipv6.
    PreserveClientIpEnabled bool
    Whether to enable source address retention. Default is true.
    ProjectName string
    The project name of the server group.
    Protocol string
    The protocol of the server group. Valid values: TCP (default), UDP, TCP_SSL.
    ProxyProtocolType string
    Whether to enable Proxy Protocol. Valid values: off (default), standard.
    Scheduler string
    The scheduling algorithm. Valid values: wrr (default), wlc, sh.
    Servers List<ServerGroupServer>
    The backend servers of the server group.
    SessionPersistenceEnabled bool
    Whether to enable session persistence. Default is false.
    SessionPersistenceTimeout int
    Session persistence timeout. Unit: second. Value range: 1 ~ 3600. Default is 1000.
    Tags List<ServerGroupTag>
    Tags.
    TimestampRemoveEnabled bool
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Default is false.
    Type string
    The type of the server group. Valid values: instance (default), ip.
    ServerGroupName string
    The name of the server group.
    VpcId string
    The id of the VPC to which the server group belongs.
    AnyPortEnabled bool
    Whether to enable full port forwarding. Default is false.
    BypassSecurityGroupEnabled bool
    Whether to enable the function of passing through the backend security group. Default is false.
    ConnectionDrainEnabled bool
    Whether to enable connection graceful interruption. Default is false.
    ConnectionDrainTimeout int
    Connection graceful interruption timeout. Unit: second. Value range: 0 ~ 900. Default is 0.
    Description string
    The description of the server group.
    HealthCheck ServerGroupHealthCheckArgs
    The health check config of the server group.
    IpAddressVersion string
    The ip address version of the server group. Valid values: ipv4 (default), ipv6.
    PreserveClientIpEnabled bool
    Whether to enable source address retention. Default is true.
    ProjectName string
    The project name of the server group.
    Protocol string
    The protocol of the server group. Valid values: TCP (default), UDP, TCP_SSL.
    ProxyProtocolType string
    Whether to enable Proxy Protocol. Valid values: off (default), standard.
    Scheduler string
    The scheduling algorithm. Valid values: wrr (default), wlc, sh.
    Servers []ServerGroupServerArgs
    The backend servers of the server group.
    SessionPersistenceEnabled bool
    Whether to enable session persistence. Default is false.
    SessionPersistenceTimeout int
    Session persistence timeout. Unit: second. Value range: 1 ~ 3600. Default is 1000.
    Tags []ServerGroupTagArgs
    Tags.
    TimestampRemoveEnabled bool
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Default is false.
    Type string
    The type of the server group. Valid values: instance (default), ip.
    serverGroupName String
    The name of the server group.
    vpcId String
    The id of the VPC to which the server group belongs.
    anyPortEnabled Boolean
    Whether to enable full port forwarding. Default is false.
    bypassSecurityGroupEnabled Boolean
    Whether to enable the function of passing through the backend security group. Default is false.
    connectionDrainEnabled Boolean
    Whether to enable connection graceful interruption. Default is false.
    connectionDrainTimeout Integer
    Connection graceful interruption timeout. Unit: second. Value range: 0 ~ 900. Default is 0.
    description String
    The description of the server group.
    healthCheck ServerGroupHealthCheck
    The health check config of the server group.
    ipAddressVersion String
    The ip address version of the server group. Valid values: ipv4 (default), ipv6.
    preserveClientIpEnabled Boolean
    Whether to enable source address retention. Default is true.
    projectName String
    The project name of the server group.
    protocol String
    The protocol of the server group. Valid values: TCP (default), UDP, TCP_SSL.
    proxyProtocolType String
    Whether to enable Proxy Protocol. Valid values: off (default), standard.
    scheduler String
    The scheduling algorithm. Valid values: wrr (default), wlc, sh.
    servers List<ServerGroupServer>
    The backend servers of the server group.
    sessionPersistenceEnabled Boolean
    Whether to enable session persistence. Default is false.
    sessionPersistenceTimeout Integer
    Session persistence timeout. Unit: second. Value range: 1 ~ 3600. Default is 1000.
    tags List<ServerGroupTag>
    Tags.
    timestampRemoveEnabled Boolean
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Default is false.
    type String
    The type of the server group. Valid values: instance (default), ip.
    serverGroupName string
    The name of the server group.
    vpcId string
    The id of the VPC to which the server group belongs.
    anyPortEnabled boolean
    Whether to enable full port forwarding. Default is false.
    bypassSecurityGroupEnabled boolean
    Whether to enable the function of passing through the backend security group. Default is false.
    connectionDrainEnabled boolean
    Whether to enable connection graceful interruption. Default is false.
    connectionDrainTimeout number
    Connection graceful interruption timeout. Unit: second. Value range: 0 ~ 900. Default is 0.
    description string
    The description of the server group.
    healthCheck ServerGroupHealthCheck
    The health check config of the server group.
    ipAddressVersion string
    The ip address version of the server group. Valid values: ipv4 (default), ipv6.
    preserveClientIpEnabled boolean
    Whether to enable source address retention. Default is true.
    projectName string
    The project name of the server group.
    protocol string
    The protocol of the server group. Valid values: TCP (default), UDP, TCP_SSL.
    proxyProtocolType string
    Whether to enable Proxy Protocol. Valid values: off (default), standard.
    scheduler string
    The scheduling algorithm. Valid values: wrr (default), wlc, sh.
    servers ServerGroupServer[]
    The backend servers of the server group.
    sessionPersistenceEnabled boolean
    Whether to enable session persistence. Default is false.
    sessionPersistenceTimeout number
    Session persistence timeout. Unit: second. Value range: 1 ~ 3600. Default is 1000.
    tags ServerGroupTag[]
    Tags.
    timestampRemoveEnabled boolean
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Default is false.
    type string
    The type of the server group. Valid values: instance (default), ip.
    server_group_name str
    The name of the server group.
    vpc_id str
    The id of the VPC to which the server group belongs.
    any_port_enabled bool
    Whether to enable full port forwarding. Default is false.
    bypass_security_group_enabled bool
    Whether to enable the function of passing through the backend security group. Default is false.
    connection_drain_enabled bool
    Whether to enable connection graceful interruption. Default is false.
    connection_drain_timeout int
    Connection graceful interruption timeout. Unit: second. Value range: 0 ~ 900. Default is 0.
    description str
    The description of the server group.
    health_check ServerGroupHealthCheckArgs
    The health check config of the server group.
    ip_address_version str
    The ip address version of the server group. Valid values: ipv4 (default), ipv6.
    preserve_client_ip_enabled bool
    Whether to enable source address retention. Default is true.
    project_name str
    The project name of the server group.
    protocol str
    The protocol of the server group. Valid values: TCP (default), UDP, TCP_SSL.
    proxy_protocol_type str
    Whether to enable Proxy Protocol. Valid values: off (default), standard.
    scheduler str
    The scheduling algorithm. Valid values: wrr (default), wlc, sh.
    servers Sequence[ServerGroupServerArgs]
    The backend servers of the server group.
    session_persistence_enabled bool
    Whether to enable session persistence. Default is false.
    session_persistence_timeout int
    Session persistence timeout. Unit: second. Value range: 1 ~ 3600. Default is 1000.
    tags Sequence[ServerGroupTagArgs]
    Tags.
    timestamp_remove_enabled bool
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Default is false.
    type str
    The type of the server group. Valid values: instance (default), ip.
    serverGroupName String
    The name of the server group.
    vpcId String
    The id of the VPC to which the server group belongs.
    anyPortEnabled Boolean
    Whether to enable full port forwarding. Default is false.
    bypassSecurityGroupEnabled Boolean
    Whether to enable the function of passing through the backend security group. Default is false.
    connectionDrainEnabled Boolean
    Whether to enable connection graceful interruption. Default is false.
    connectionDrainTimeout Number
    Connection graceful interruption timeout. Unit: second. Value range: 0 ~ 900. Default is 0.
    description String
    The description of the server group.
    healthCheck Property Map
    The health check config of the server group.
    ipAddressVersion String
    The ip address version of the server group. Valid values: ipv4 (default), ipv6.
    preserveClientIpEnabled Boolean
    Whether to enable source address retention. Default is true.
    projectName String
    The project name of the server group.
    protocol String
    The protocol of the server group. Valid values: TCP (default), UDP, TCP_SSL.
    proxyProtocolType String
    Whether to enable Proxy Protocol. Valid values: off (default), standard.
    scheduler String
    The scheduling algorithm. Valid values: wrr (default), wlc, sh.
    servers List<Property Map>
    The backend servers of the server group.
    sessionPersistenceEnabled Boolean
    Whether to enable session persistence. Default is false.
    sessionPersistenceTimeout Number
    Session persistence timeout. Unit: second. Value range: 1 ~ 3600. Default is 1000.
    tags List<Property Map>
    Tags.
    timestampRemoveEnabled Boolean
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Default is false.
    type String
    The type of the server group. Valid values: instance (default), ip.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ServerCount int
    The server count of the server group.
    Status string
    The status of the server group.
    Id string
    The provider-assigned unique ID for this managed resource.
    ServerCount int
    The server count of the server group.
    Status string
    The status of the server group.
    id String
    The provider-assigned unique ID for this managed resource.
    serverCount Integer
    The server count of the server group.
    status String
    The status of the server group.
    id string
    The provider-assigned unique ID for this managed resource.
    serverCount number
    The server count of the server group.
    status string
    The status of the server group.
    id str
    The provider-assigned unique ID for this managed resource.
    server_count int
    The server count of the server group.
    status str
    The status of the server group.
    id String
    The provider-assigned unique ID for this managed resource.
    serverCount Number
    The server count of the server group.
    status String
    The status of the 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,
        any_port_enabled: Optional[bool] = None,
        bypass_security_group_enabled: Optional[bool] = None,
        connection_drain_enabled: Optional[bool] = None,
        connection_drain_timeout: Optional[int] = None,
        description: Optional[str] = None,
        health_check: Optional[ServerGroupHealthCheckArgs] = None,
        ip_address_version: Optional[str] = None,
        preserve_client_ip_enabled: Optional[bool] = None,
        project_name: Optional[str] = None,
        protocol: Optional[str] = None,
        proxy_protocol_type: Optional[str] = None,
        scheduler: Optional[str] = None,
        server_count: Optional[int] = None,
        server_group_name: Optional[str] = None,
        servers: Optional[Sequence[ServerGroupServerArgs]] = None,
        session_persistence_enabled: Optional[bool] = None,
        session_persistence_timeout: Optional[int] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[ServerGroupTagArgs]] = None,
        timestamp_remove_enabled: Optional[bool] = None,
        type: 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:nlb: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:
    AnyPortEnabled bool
    Whether to enable full port forwarding. Default is false.
    BypassSecurityGroupEnabled bool
    Whether to enable the function of passing through the backend security group. Default is false.
    ConnectionDrainEnabled bool
    Whether to enable connection graceful interruption. Default is false.
    ConnectionDrainTimeout int
    Connection graceful interruption timeout. Unit: second. Value range: 0 ~ 900. Default is 0.
    Description string
    The description of the server group.
    HealthCheck ServerGroupHealthCheck
    The health check config of the server group.
    IpAddressVersion string
    The ip address version of the server group. Valid values: ipv4 (default), ipv6.
    PreserveClientIpEnabled bool
    Whether to enable source address retention. Default is true.
    ProjectName string
    The project name of the server group.
    Protocol string
    The protocol of the server group. Valid values: TCP (default), UDP, TCP_SSL.
    ProxyProtocolType string
    Whether to enable Proxy Protocol. Valid values: off (default), standard.
    Scheduler string
    The scheduling algorithm. Valid values: wrr (default), wlc, sh.
    ServerCount int
    The server count of the server group.
    ServerGroupName string
    The name of the server group.
    Servers List<ServerGroupServer>
    The backend servers of the server group.
    SessionPersistenceEnabled bool
    Whether to enable session persistence. Default is false.
    SessionPersistenceTimeout int
    Session persistence timeout. Unit: second. Value range: 1 ~ 3600. Default is 1000.
    Status string
    The status of the server group.
    Tags List<ServerGroupTag>
    Tags.
    TimestampRemoveEnabled bool
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Default is false.
    Type string
    The type of the server group. Valid values: instance (default), ip.
    VpcId string
    The id of the VPC to which the server group belongs.
    AnyPortEnabled bool
    Whether to enable full port forwarding. Default is false.
    BypassSecurityGroupEnabled bool
    Whether to enable the function of passing through the backend security group. Default is false.
    ConnectionDrainEnabled bool
    Whether to enable connection graceful interruption. Default is false.
    ConnectionDrainTimeout int
    Connection graceful interruption timeout. Unit: second. Value range: 0 ~ 900. Default is 0.
    Description string
    The description of the server group.
    HealthCheck ServerGroupHealthCheckArgs
    The health check config of the server group.
    IpAddressVersion string
    The ip address version of the server group. Valid values: ipv4 (default), ipv6.
    PreserveClientIpEnabled bool
    Whether to enable source address retention. Default is true.
    ProjectName string
    The project name of the server group.
    Protocol string
    The protocol of the server group. Valid values: TCP (default), UDP, TCP_SSL.
    ProxyProtocolType string
    Whether to enable Proxy Protocol. Valid values: off (default), standard.
    Scheduler string
    The scheduling algorithm. Valid values: wrr (default), wlc, sh.
    ServerCount int
    The server count of the server group.
    ServerGroupName string
    The name of the server group.
    Servers []ServerGroupServerArgs
    The backend servers of the server group.
    SessionPersistenceEnabled bool
    Whether to enable session persistence. Default is false.
    SessionPersistenceTimeout int
    Session persistence timeout. Unit: second. Value range: 1 ~ 3600. Default is 1000.
    Status string
    The status of the server group.
    Tags []ServerGroupTagArgs
    Tags.
    TimestampRemoveEnabled bool
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Default is false.
    Type string
    The type of the server group. Valid values: instance (default), ip.
    VpcId string
    The id of the VPC to which the server group belongs.
    anyPortEnabled Boolean
    Whether to enable full port forwarding. Default is false.
    bypassSecurityGroupEnabled Boolean
    Whether to enable the function of passing through the backend security group. Default is false.
    connectionDrainEnabled Boolean
    Whether to enable connection graceful interruption. Default is false.
    connectionDrainTimeout Integer
    Connection graceful interruption timeout. Unit: second. Value range: 0 ~ 900. Default is 0.
    description String
    The description of the server group.
    healthCheck ServerGroupHealthCheck
    The health check config of the server group.
    ipAddressVersion String
    The ip address version of the server group. Valid values: ipv4 (default), ipv6.
    preserveClientIpEnabled Boolean
    Whether to enable source address retention. Default is true.
    projectName String
    The project name of the server group.
    protocol String
    The protocol of the server group. Valid values: TCP (default), UDP, TCP_SSL.
    proxyProtocolType String
    Whether to enable Proxy Protocol. Valid values: off (default), standard.
    scheduler String
    The scheduling algorithm. Valid values: wrr (default), wlc, sh.
    serverCount Integer
    The server count of the server group.
    serverGroupName String
    The name of the server group.
    servers List<ServerGroupServer>
    The backend servers of the server group.
    sessionPersistenceEnabled Boolean
    Whether to enable session persistence. Default is false.
    sessionPersistenceTimeout Integer
    Session persistence timeout. Unit: second. Value range: 1 ~ 3600. Default is 1000.
    status String
    The status of the server group.
    tags List<ServerGroupTag>
    Tags.
    timestampRemoveEnabled Boolean
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Default is false.
    type String
    The type of the server group. Valid values: instance (default), ip.
    vpcId String
    The id of the VPC to which the server group belongs.
    anyPortEnabled boolean
    Whether to enable full port forwarding. Default is false.
    bypassSecurityGroupEnabled boolean
    Whether to enable the function of passing through the backend security group. Default is false.
    connectionDrainEnabled boolean
    Whether to enable connection graceful interruption. Default is false.
    connectionDrainTimeout number
    Connection graceful interruption timeout. Unit: second. Value range: 0 ~ 900. Default is 0.
    description string
    The description of the server group.
    healthCheck ServerGroupHealthCheck
    The health check config of the server group.
    ipAddressVersion string
    The ip address version of the server group. Valid values: ipv4 (default), ipv6.
    preserveClientIpEnabled boolean
    Whether to enable source address retention. Default is true.
    projectName string
    The project name of the server group.
    protocol string
    The protocol of the server group. Valid values: TCP (default), UDP, TCP_SSL.
    proxyProtocolType string
    Whether to enable Proxy Protocol. Valid values: off (default), standard.
    scheduler string
    The scheduling algorithm. Valid values: wrr (default), wlc, sh.
    serverCount number
    The server count of the server group.
    serverGroupName string
    The name of the server group.
    servers ServerGroupServer[]
    The backend servers of the server group.
    sessionPersistenceEnabled boolean
    Whether to enable session persistence. Default is false.
    sessionPersistenceTimeout number
    Session persistence timeout. Unit: second. Value range: 1 ~ 3600. Default is 1000.
    status string
    The status of the server group.
    tags ServerGroupTag[]
    Tags.
    timestampRemoveEnabled boolean
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Default is false.
    type string
    The type of the server group. Valid values: instance (default), ip.
    vpcId string
    The id of the VPC to which the server group belongs.
    any_port_enabled bool
    Whether to enable full port forwarding. Default is false.
    bypass_security_group_enabled bool
    Whether to enable the function of passing through the backend security group. Default is false.
    connection_drain_enabled bool
    Whether to enable connection graceful interruption. Default is false.
    connection_drain_timeout int
    Connection graceful interruption timeout. Unit: second. Value range: 0 ~ 900. Default is 0.
    description str
    The description of the server group.
    health_check ServerGroupHealthCheckArgs
    The health check config of the server group.
    ip_address_version str
    The ip address version of the server group. Valid values: ipv4 (default), ipv6.
    preserve_client_ip_enabled bool
    Whether to enable source address retention. Default is true.
    project_name str
    The project name of the server group.
    protocol str
    The protocol of the server group. Valid values: TCP (default), UDP, TCP_SSL.
    proxy_protocol_type str
    Whether to enable Proxy Protocol. Valid values: off (default), standard.
    scheduler str
    The scheduling algorithm. Valid values: wrr (default), wlc, sh.
    server_count int
    The server count of the server group.
    server_group_name str
    The name of the server group.
    servers Sequence[ServerGroupServerArgs]
    The backend servers of the server group.
    session_persistence_enabled bool
    Whether to enable session persistence. Default is false.
    session_persistence_timeout int
    Session persistence timeout. Unit: second. Value range: 1 ~ 3600. Default is 1000.
    status str
    The status of the server group.
    tags Sequence[ServerGroupTagArgs]
    Tags.
    timestamp_remove_enabled bool
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Default is false.
    type str
    The type of the server group. Valid values: instance (default), ip.
    vpc_id str
    The id of the VPC to which the server group belongs.
    anyPortEnabled Boolean
    Whether to enable full port forwarding. Default is false.
    bypassSecurityGroupEnabled Boolean
    Whether to enable the function of passing through the backend security group. Default is false.
    connectionDrainEnabled Boolean
    Whether to enable connection graceful interruption. Default is false.
    connectionDrainTimeout Number
    Connection graceful interruption timeout. Unit: second. Value range: 0 ~ 900. Default is 0.
    description String
    The description of the server group.
    healthCheck Property Map
    The health check config of the server group.
    ipAddressVersion String
    The ip address version of the server group. Valid values: ipv4 (default), ipv6.
    preserveClientIpEnabled Boolean
    Whether to enable source address retention. Default is true.
    projectName String
    The project name of the server group.
    protocol String
    The protocol of the server group. Valid values: TCP (default), UDP, TCP_SSL.
    proxyProtocolType String
    Whether to enable Proxy Protocol. Valid values: off (default), standard.
    scheduler String
    The scheduling algorithm. Valid values: wrr (default), wlc, sh.
    serverCount Number
    The server count of the server group.
    serverGroupName String
    The name of the server group.
    servers List<Property Map>
    The backend servers of the server group.
    sessionPersistenceEnabled Boolean
    Whether to enable session persistence. Default is false.
    sessionPersistenceTimeout Number
    Session persistence timeout. Unit: second. Value range: 1 ~ 3600. Default is 1000.
    status String
    The status of the server group.
    tags List<Property Map>
    Tags.
    timestampRemoveEnabled Boolean
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Default is false.
    type String
    The type of the server group. Valid values: instance (default), ip.
    vpcId String
    The id of the VPC to which the server group belongs.

    Supporting Types

    ServerGroupHealthCheck, ServerGroupHealthCheckArgs

    Domain string
    The domain of health check. Only available when HealthCheck.Type is HTTP.
    Enabled bool
    Whether to enable health check. Valid values: true (default), false.
    HealthyThreshold int
    The healthy threshold of health check. Value range: 2 ~ 10. Default is 3.
    HttpCode string
    The http code of health check. Valid values: http_2xx, http_3xx, http_4xx, http_5xx. Default is http_2xx,http_3xx. Only available when HealthCheck.Type is HTTP.
    Interval int
    The interval of health check. Unit: second. Value range: 1 ~ 300. Default is 2.
    Method string
    The method of health check. Valid values: GET (default), HEAD. Only available when HealthCheck.Type is HTTP.
    Port int
    The port of health check. Value range: 1 ~ 65535. Default is 0, which means using the port of the backend server.
    Timeout int
    The response timeout of health check. Unit: second. Value range: 1 ~ 60. Default is 2.
    Type string
    The type of the health check. Valid values: TCP (default), HTTP, UDP.
    UdpConnectTimeout int
    The udp connect timeout of health check. Unit: second. Value range: 1 ~ 60. Default is 3. Only available when HealthCheck.Type is UDP.
    UdpExpect string
    The udp expect of health check. Only available when HealthCheck.Type is UDP.
    UdpRequest string
    The udp request of health check. Only available when HealthCheck.Type is UDP.
    UnhealthyThreshold int
    The unhealthy threshold of health check. Value range: 2 ~ 10. Default is 3.
    Uri string
    The uri of health check. Must start with /. Only available when HealthCheck.Type is HTTP.
    Domain string
    The domain of health check. Only available when HealthCheck.Type is HTTP.
    Enabled bool
    Whether to enable health check. Valid values: true (default), false.
    HealthyThreshold int
    The healthy threshold of health check. Value range: 2 ~ 10. Default is 3.
    HttpCode string
    The http code of health check. Valid values: http_2xx, http_3xx, http_4xx, http_5xx. Default is http_2xx,http_3xx. Only available when HealthCheck.Type is HTTP.
    Interval int
    The interval of health check. Unit: second. Value range: 1 ~ 300. Default is 2.
    Method string
    The method of health check. Valid values: GET (default), HEAD. Only available when HealthCheck.Type is HTTP.
    Port int
    The port of health check. Value range: 1 ~ 65535. Default is 0, which means using the port of the backend server.
    Timeout int
    The response timeout of health check. Unit: second. Value range: 1 ~ 60. Default is 2.
    Type string
    The type of the health check. Valid values: TCP (default), HTTP, UDP.
    UdpConnectTimeout int
    The udp connect timeout of health check. Unit: second. Value range: 1 ~ 60. Default is 3. Only available when HealthCheck.Type is UDP.
    UdpExpect string
    The udp expect of health check. Only available when HealthCheck.Type is UDP.
    UdpRequest string
    The udp request of health check. Only available when HealthCheck.Type is UDP.
    UnhealthyThreshold int
    The unhealthy threshold of health check. Value range: 2 ~ 10. Default is 3.
    Uri string
    The uri of health check. Must start with /. Only available when HealthCheck.Type is HTTP.
    domain String
    The domain of health check. Only available when HealthCheck.Type is HTTP.
    enabled Boolean
    Whether to enable health check. Valid values: true (default), false.
    healthyThreshold Integer
    The healthy threshold of health check. Value range: 2 ~ 10. Default is 3.
    httpCode String
    The http code of health check. Valid values: http_2xx, http_3xx, http_4xx, http_5xx. Default is http_2xx,http_3xx. Only available when HealthCheck.Type is HTTP.
    interval Integer
    The interval of health check. Unit: second. Value range: 1 ~ 300. Default is 2.
    method String
    The method of health check. Valid values: GET (default), HEAD. Only available when HealthCheck.Type is HTTP.
    port Integer
    The port of health check. Value range: 1 ~ 65535. Default is 0, which means using the port of the backend server.
    timeout Integer
    The response timeout of health check. Unit: second. Value range: 1 ~ 60. Default is 2.
    type String
    The type of the health check. Valid values: TCP (default), HTTP, UDP.
    udpConnectTimeout Integer
    The udp connect timeout of health check. Unit: second. Value range: 1 ~ 60. Default is 3. Only available when HealthCheck.Type is UDP.
    udpExpect String
    The udp expect of health check. Only available when HealthCheck.Type is UDP.
    udpRequest String
    The udp request of health check. Only available when HealthCheck.Type is UDP.
    unhealthyThreshold Integer
    The unhealthy threshold of health check. Value range: 2 ~ 10. Default is 3.
    uri String
    The uri of health check. Must start with /. Only available when HealthCheck.Type is HTTP.
    domain string
    The domain of health check. Only available when HealthCheck.Type is HTTP.
    enabled boolean
    Whether to enable health check. Valid values: true (default), false.
    healthyThreshold number
    The healthy threshold of health check. Value range: 2 ~ 10. Default is 3.
    httpCode string
    The http code of health check. Valid values: http_2xx, http_3xx, http_4xx, http_5xx. Default is http_2xx,http_3xx. Only available when HealthCheck.Type is HTTP.
    interval number
    The interval of health check. Unit: second. Value range: 1 ~ 300. Default is 2.
    method string
    The method of health check. Valid values: GET (default), HEAD. Only available when HealthCheck.Type is HTTP.
    port number
    The port of health check. Value range: 1 ~ 65535. Default is 0, which means using the port of the backend server.
    timeout number
    The response timeout of health check. Unit: second. Value range: 1 ~ 60. Default is 2.
    type string
    The type of the health check. Valid values: TCP (default), HTTP, UDP.
    udpConnectTimeout number
    The udp connect timeout of health check. Unit: second. Value range: 1 ~ 60. Default is 3. Only available when HealthCheck.Type is UDP.
    udpExpect string
    The udp expect of health check. Only available when HealthCheck.Type is UDP.
    udpRequest string
    The udp request of health check. Only available when HealthCheck.Type is UDP.
    unhealthyThreshold number
    The unhealthy threshold of health check. Value range: 2 ~ 10. Default is 3.
    uri string
    The uri of health check. Must start with /. Only available when HealthCheck.Type is HTTP.
    domain str
    The domain of health check. Only available when HealthCheck.Type is HTTP.
    enabled bool
    Whether to enable health check. Valid values: true (default), false.
    healthy_threshold int
    The healthy threshold of health check. Value range: 2 ~ 10. Default is 3.
    http_code str
    The http code of health check. Valid values: http_2xx, http_3xx, http_4xx, http_5xx. Default is http_2xx,http_3xx. Only available when HealthCheck.Type is HTTP.
    interval int
    The interval of health check. Unit: second. Value range: 1 ~ 300. Default is 2.
    method str
    The method of health check. Valid values: GET (default), HEAD. Only available when HealthCheck.Type is HTTP.
    port int
    The port of health check. Value range: 1 ~ 65535. Default is 0, which means using the port of the backend server.
    timeout int
    The response timeout of health check. Unit: second. Value range: 1 ~ 60. Default is 2.
    type str
    The type of the health check. Valid values: TCP (default), HTTP, UDP.
    udp_connect_timeout int
    The udp connect timeout of health check. Unit: second. Value range: 1 ~ 60. Default is 3. Only available when HealthCheck.Type is UDP.
    udp_expect str
    The udp expect of health check. Only available when HealthCheck.Type is UDP.
    udp_request str
    The udp request of health check. Only available when HealthCheck.Type is UDP.
    unhealthy_threshold int
    The unhealthy threshold of health check. Value range: 2 ~ 10. Default is 3.
    uri str
    The uri of health check. Must start with /. Only available when HealthCheck.Type is HTTP.
    domain String
    The domain of health check. Only available when HealthCheck.Type is HTTP.
    enabled Boolean
    Whether to enable health check. Valid values: true (default), false.
    healthyThreshold Number
    The healthy threshold of health check. Value range: 2 ~ 10. Default is 3.
    httpCode String
    The http code of health check. Valid values: http_2xx, http_3xx, http_4xx, http_5xx. Default is http_2xx,http_3xx. Only available when HealthCheck.Type is HTTP.
    interval Number
    The interval of health check. Unit: second. Value range: 1 ~ 300. Default is 2.
    method String
    The method of health check. Valid values: GET (default), HEAD. Only available when HealthCheck.Type is HTTP.
    port Number
    The port of health check. Value range: 1 ~ 65535. Default is 0, which means using the port of the backend server.
    timeout Number
    The response timeout of health check. Unit: second. Value range: 1 ~ 60. Default is 2.
    type String
    The type of the health check. Valid values: TCP (default), HTTP, UDP.
    udpConnectTimeout Number
    The udp connect timeout of health check. Unit: second. Value range: 1 ~ 60. Default is 3. Only available when HealthCheck.Type is UDP.
    udpExpect String
    The udp expect of health check. Only available when HealthCheck.Type is UDP.
    udpRequest String
    The udp request of health check. Only available when HealthCheck.Type is UDP.
    unhealthyThreshold Number
    The unhealthy threshold of health check. Value range: 2 ~ 10. Default is 3.
    uri String
    The uri of health check. Must start with /. Only available when HealthCheck.Type is HTTP.

    ServerGroupServer, ServerGroupServerArgs

    Description string
    The description of the backend server.
    InstanceId string
    The instance ID of the backend server.
    Ip string
    The IP address of the backend server.
    Port int
    The port of the backend server.
    ServerId string
    The ID of the backend server.
    Type string
    The type of the backend server. Valid values: ecs, eni, ip.
    Weight int
    The weight of the backend server. Value range: 0 ~ 100. Default is 100.
    ZoneId string
    The zone ID of the backend server.
    Description string
    The description of the backend server.
    InstanceId string
    The instance ID of the backend server.
    Ip string
    The IP address of the backend server.
    Port int
    The port of the backend server.
    ServerId string
    The ID of the backend server.
    Type string
    The type of the backend server. Valid values: ecs, eni, ip.
    Weight int
    The weight of the backend server. Value range: 0 ~ 100. Default is 100.
    ZoneId string
    The zone ID of the backend server.
    description String
    The description of the backend server.
    instanceId String
    The instance ID of the backend server.
    ip String
    The IP address of the backend server.
    port Integer
    The port of the backend server.
    serverId String
    The ID of the backend server.
    type String
    The type of the backend server. Valid values: ecs, eni, ip.
    weight Integer
    The weight of the backend server. Value range: 0 ~ 100. Default is 100.
    zoneId String
    The zone ID of the backend server.
    description string
    The description of the backend server.
    instanceId string
    The instance ID of the backend server.
    ip string
    The IP address of the backend server.
    port number
    The port of the backend server.
    serverId string
    The ID of the backend server.
    type string
    The type of the backend server. Valid values: ecs, eni, ip.
    weight number
    The weight of the backend server. Value range: 0 ~ 100. Default is 100.
    zoneId string
    The zone ID of the backend server.
    description str
    The description of the backend server.
    instance_id str
    The instance ID of the backend server.
    ip str
    The IP address of the backend server.
    port int
    The port of the backend server.
    server_id str
    The ID of the backend server.
    type str
    The type of the backend server. Valid values: ecs, eni, ip.
    weight int
    The weight of the backend server. Value range: 0 ~ 100. Default is 100.
    zone_id str
    The zone ID of the backend server.
    description String
    The description of the backend server.
    instanceId String
    The instance ID of the backend server.
    ip String
    The IP address of the backend server.
    port Number
    The port of the backend server.
    serverId String
    The ID of the backend server.
    type String
    The type of the backend server. Valid values: ecs, eni, ip.
    weight Number
    The weight of the backend server. Value range: 0 ~ 100. Default is 100.
    zoneId String
    The zone ID of the backend server.

    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.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Viewing docs for Volcengine v0.0.47
    published on Friday, Mar 13, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Try Pulumi Cloud free. Your team will thank you.