volcenginecc.alb.ServerGroup

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

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

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  albServergroupDemo:
    type: volcenginecc:alb:ServerGroup
    name: AlbServergroupDemo
    properties:
      vpcId: vpc-13f8***
      serverGroupName: test-servergroup
      serverGroupType: instance
      protocol: HTTP
      scheduler: wrr
      crossZoneEnabled: on
      healthCheck:
        enabled: on
        port: 80
        interval: 2
        timeout: 5
        healthy_threshold: 3
        unhealthy_threshold: 3
        method: GET
        http_version: HTTP1.1
        uri: /health
        http_code: http_2xx
      stickySessionConfig:
        sticky_session_enabled: on
        sticky_session_type: insert
        cookie_timeout: 1000
      servers:
        - instance_id: i-ye3***
          type: ecs
          ip: 192.168.1.**
          port: 80
          weight: 10
      tags:
        - key: env
          value: test

Create ServerGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ServerGroup(name: string, args: ServerGroupArgs, opts?: CustomResourceOptions);

@overload
def ServerGroup(resource_name: str,
                args: ServerGroupArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def ServerGroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                vpc_id: Optional[str] = None,
                scheduler: Optional[str] = None,
                health_check: Optional[ServerGroupHealthCheckArgs] = None,
                ip_address_type: Optional[str] = None,
                project_name: Optional[str] = None,
                protocol: Optional[str] = None,
                cross_zone_enabled: Optional[str] = None,
                server_group_name: Optional[str] = None,
                server_group_type: Optional[str] = None,
                servers: Optional[Sequence[ServerGroupServerArgs]] = None,
                status: Optional[str] = None,
                sticky_session_config: Optional[ServerGroupStickySessionConfigArgs] = None,
                tags: Optional[Sequence[ServerGroupTagArgs]] = None,
                description: Optional[str] = None)

func NewServerGroup(ctx *Context, name string, args ServerGroupArgs, opts ...ResourceOption) (*ServerGroup, error)

public ServerGroup(string name, ServerGroupArgs args, CustomResourceOptions? opts = null)

public ServerGroup(String name, ServerGroupArgs args)
public ServerGroup(String name, ServerGroupArgs args, CustomResourceOptions options)

type: volcenginecc: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.

ServerGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ServerGroup resource accepts the following input properties:

VpcId string: ID of the VPC to which the backend server group belongs.
CrossZoneEnabled string: Whether to enable cross-zone load balancing for the server group. Values: on (default): enabled, off: disabled.
Description string: Description of the backend server group.
HealthCheck Volcengine.ServerGroupHealthCheck: Server group health check configuration information.
IpAddressType string: IP address type of the server group. Only IPv4 is supported.
ProjectName string: Name of the project to which the backend server group belongs.
Protocol string: Backend protocol: HTTP, HTTPS.
Scheduler string: Scheduling algorithm. Parameter values: wrr: Weighted round robin. wlc: Weighted least connections. sh: Source IP hash.
ServerGroupName string: Name of the backend server group.
ServerGroupType string: Type of backend server group. instance: Server type. This type of server group supports adding ECS and ENI instances as backend servers. ip: IP type. This type of server group supports adding IP addresses as backend servers.
Servers List<Volcengine.ServerGroupServer>
Status string: Server group status. Creating: creating. Active: running. Configuring: configuring. Deleting: deleting.
StickySessionConfig Volcengine.ServerGroupStickySessionConfig: Session persistence parameter information.
Tags List<Volcengine.ServerGroupTag>

VpcId string: ID of the VPC to which the backend server group belongs.
CrossZoneEnabled string: Whether to enable cross-zone load balancing for the server group. Values: on (default): enabled, off: disabled.
Description string: Description of the backend server group.
HealthCheck ServerGroupHealthCheckArgs: Server group health check configuration information.
IpAddressType string: IP address type of the server group. Only IPv4 is supported.
ProjectName string: Name of the project to which the backend server group belongs.
Protocol string: Backend protocol: HTTP, HTTPS.
Scheduler string: Scheduling algorithm. Parameter values: wrr: Weighted round robin. wlc: Weighted least connections. sh: Source IP hash.
ServerGroupName string: Name of the backend server group.
ServerGroupType string: Type of backend server group. instance: Server type. This type of server group supports adding ECS and ENI instances as backend servers. ip: IP type. This type of server group supports adding IP addresses as backend servers.
Servers []ServerGroupServerArgs
Status string: Server group status. Creating: creating. Active: running. Configuring: configuring. Deleting: deleting.
StickySessionConfig ServerGroupStickySessionConfigArgs: Session persistence parameter information.
Tags []ServerGroupTagArgs

vpcId String: ID of the VPC to which the backend server group belongs.
crossZoneEnabled String: Whether to enable cross-zone load balancing for the server group. Values: on (default): enabled, off: disabled.
description String: Description of the backend server group.
healthCheck ServerGroupHealthCheck: Server group health check configuration information.
ipAddressType String: IP address type of the server group. Only IPv4 is supported.
projectName String: Name of the project to which the backend server group belongs.
protocol String: Backend protocol: HTTP, HTTPS.
scheduler String: Scheduling algorithm. Parameter values: wrr: Weighted round robin. wlc: Weighted least connections. sh: Source IP hash.
serverGroupName String: Name of the backend server group.
serverGroupType String: Type of backend server group. instance: Server type. This type of server group supports adding ECS and ENI instances as backend servers. ip: IP type. This type of server group supports adding IP addresses as backend servers.
servers List<ServerGroupServer>
status String: Server group status. Creating: creating. Active: running. Configuring: configuring. Deleting: deleting.
stickySessionConfig ServerGroupStickySessionConfig: Session persistence parameter information.
tags List<ServerGroupTag>

vpcId string: ID of the VPC to which the backend server group belongs.
crossZoneEnabled string: Whether to enable cross-zone load balancing for the server group. Values: on (default): enabled, off: disabled.
description string: Description of the backend server group.
healthCheck ServerGroupHealthCheck: Server group health check configuration information.
ipAddressType string: IP address type of the server group. Only IPv4 is supported.
projectName string: Name of the project to which the backend server group belongs.
protocol string: Backend protocol: HTTP, HTTPS.
scheduler string: Scheduling algorithm. Parameter values: wrr: Weighted round robin. wlc: Weighted least connections. sh: Source IP hash.
serverGroupName string: Name of the backend server group.
serverGroupType string: Type of backend server group. instance: Server type. This type of server group supports adding ECS and ENI instances as backend servers. ip: IP type. This type of server group supports adding IP addresses as backend servers.
servers ServerGroupServer[]
status string: Server group status. Creating: creating. Active: running. Configuring: configuring. Deleting: deleting.
stickySessionConfig ServerGroupStickySessionConfig: Session persistence parameter information.
tags ServerGroupTag[]

vpc_id str: ID of the VPC to which the backend server group belongs.
cross_zone_enabled str: Whether to enable cross-zone load balancing for the server group. Values: on (default): enabled, off: disabled.
description str: Description of the backend server group.
health_check ServerGroupHealthCheckArgs: Server group health check configuration information.
ip_address_type str: IP address type of the server group. Only IPv4 is supported.
project_name str: Name of the project to which the backend server group belongs.
protocol str: Backend protocol: HTTP, HTTPS.
scheduler str: Scheduling algorithm. Parameter values: wrr: Weighted round robin. wlc: Weighted least connections. sh: Source IP hash.
server_group_name str: Name of the backend server group.
server_group_type str: Type of backend server group. instance: Server type. This type of server group supports adding ECS and ENI instances as backend servers. ip: IP type. This type of server group supports adding IP addresses as backend servers.
servers Sequence[ServerGroupServerArgs]
status str: Server group status. Creating: creating. Active: running. Configuring: configuring. Deleting: deleting.
sticky_session_config ServerGroupStickySessionConfigArgs: Session persistence parameter information.
tags Sequence[ServerGroupTagArgs]

vpcId String: ID of the VPC to which the backend server group belongs.
crossZoneEnabled String: Whether to enable cross-zone load balancing for the server group. Values: on (default): enabled, off: disabled.
description String: Description of the backend server group.
healthCheck Property Map: Server group health check configuration information.
ipAddressType String: IP address type of the server group. Only IPv4 is supported.
projectName String: Name of the project to which the backend server group belongs.
protocol String: Backend protocol: HTTP, HTTPS.
scheduler String: Scheduling algorithm. Parameter values: wrr: Weighted round robin. wlc: Weighted least connections. sh: Source IP hash.
serverGroupName String: Name of the backend server group.
serverGroupType String: Type of backend server group. instance: Server type. This type of server group supports adding ECS and ENI instances as backend servers. ip: IP type. This type of server group supports adding IP addresses as backend servers.
servers List<Property Map>
status String: Server group status. Creating: creating. Active: running. Configuring: configuring. Deleting: deleting.
stickySessionConfig Property Map: Session persistence parameter information.
tags List<Property Map>

Outputs

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

CreateTime string: Creation time of the backend server group.
Id string: The provider-assigned unique ID for this managed resource.
Listeners List<Volcengine.ServerGroupListener>
ServerCount int: Number of backend servers in the server group.
ServerGroupId string: ID of the backend server group.
UpdateTime string: Last operation time of the backend server group.

CreateTime string: Creation time of the backend server group.
Id string: The provider-assigned unique ID for this managed resource.
Listeners []ServerGroupListener
ServerCount int: Number of backend servers in the server group.
ServerGroupId string: ID of the backend server group.
UpdateTime string: Last operation time of the backend server group.

createTime String: Creation time of the backend server group.
id String: The provider-assigned unique ID for this managed resource.
listeners List<ServerGroupListener>
serverCount Integer: Number of backend servers in the server group.
serverGroupId String: ID of the backend server group.
updateTime String: Last operation time of the backend server group.

createTime string: Creation time of the backend server group.
id string: The provider-assigned unique ID for this managed resource.
listeners ServerGroupListener[]
serverCount number: Number of backend servers in the server group.
serverGroupId string: ID of the backend server group.
updateTime string: Last operation time of the backend server group.

create_time str: Creation time of the backend server group.
id str: The provider-assigned unique ID for this managed resource.
listeners Sequence[ServerGroupListener]
server_count int: Number of backend servers in the server group.
server_group_id str: ID of the backend server group.
update_time str: Last operation time of the backend server group.

createTime String: Creation time of the backend server group.
id String: The provider-assigned unique ID for this managed resource.
listeners List<Property Map>
serverCount Number: Number of backend servers in the server group.
serverGroupId String: ID of the backend server group.
updateTime String: Last operation time of the backend server group.

Look up Existing ServerGroup Resource

Get an existing ServerGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ServerGroupState, opts?: CustomResourceOptions): ServerGroup

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        cross_zone_enabled: Optional[str] = None,
        description: Optional[str] = None,
        health_check: Optional[ServerGroupHealthCheckArgs] = None,
        ip_address_type: Optional[str] = None,
        listeners: Optional[Sequence[ServerGroupListenerArgs]] = None,
        project_name: Optional[str] = None,
        protocol: Optional[str] = None,
        scheduler: Optional[str] = None,
        server_count: Optional[int] = None,
        server_group_id: Optional[str] = None,
        server_group_name: Optional[str] = None,
        server_group_type: Optional[str] = None,
        servers: Optional[Sequence[ServerGroupServerArgs]] = None,
        status: Optional[str] = None,
        sticky_session_config: Optional[ServerGroupStickySessionConfigArgs] = None,
        tags: Optional[Sequence[ServerGroupTagArgs]] = None,
        update_time: Optional[str] = None,
        vpc_id: Optional[str] = None) -> ServerGroup

func GetServerGroup(ctx *Context, name string, id IDInput, state *ServerGroupState, opts ...ResourceOption) (*ServerGroup, error)

public static ServerGroup Get(string name, Input<string> id, ServerGroupState? state, CustomResourceOptions? opts = null)

public static ServerGroup get(String name, Output<String> id, ServerGroupState state, CustomResourceOptions options)

resources:  _:    type: volcenginecc:alb:ServerGroup    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CreateTime string: Creation time of the backend server group.
CrossZoneEnabled string: Whether to enable cross-zone load balancing for the server group. Values: on (default): enabled, off: disabled.
Description string: Description of the backend server group.
HealthCheck Volcengine.ServerGroupHealthCheck: Server group health check configuration information.
IpAddressType string: IP address type of the server group. Only IPv4 is supported.
Listeners List<Volcengine.ServerGroupListener>
ProjectName string: Name of the project to which the backend server group belongs.
Protocol string: Backend protocol: HTTP, HTTPS.
Scheduler string: Scheduling algorithm. Parameter values: wrr: Weighted round robin. wlc: Weighted least connections. sh: Source IP hash.
ServerCount int: Number of backend servers in the server group.
ServerGroupId string: ID of the backend server group.
ServerGroupName string: Name of the backend server group.
ServerGroupType string: Type of backend server group. instance: Server type. This type of server group supports adding ECS and ENI instances as backend servers. ip: IP type. This type of server group supports adding IP addresses as backend servers.
Servers List<Volcengine.ServerGroupServer>
Status string: Server group status. Creating: creating. Active: running. Configuring: configuring. Deleting: deleting.
StickySessionConfig Volcengine.ServerGroupStickySessionConfig: Session persistence parameter information.
Tags List<Volcengine.ServerGroupTag>
UpdateTime string: Last operation time of the backend server group.
VpcId string: ID of the VPC to which the backend server group belongs.

CreateTime string: Creation time of the backend server group.
CrossZoneEnabled string: Whether to enable cross-zone load balancing for the server group. Values: on (default): enabled, off: disabled.
Description string: Description of the backend server group.
HealthCheck ServerGroupHealthCheckArgs: Server group health check configuration information.
IpAddressType string: IP address type of the server group. Only IPv4 is supported.
Listeners []ServerGroupListenerArgs
ProjectName string: Name of the project to which the backend server group belongs.
Protocol string: Backend protocol: HTTP, HTTPS.
Scheduler string: Scheduling algorithm. Parameter values: wrr: Weighted round robin. wlc: Weighted least connections. sh: Source IP hash.
ServerCount int: Number of backend servers in the server group.
ServerGroupId string: ID of the backend server group.
ServerGroupName string: Name of the backend server group.
ServerGroupType string: Type of backend server group. instance: Server type. This type of server group supports adding ECS and ENI instances as backend servers. ip: IP type. This type of server group supports adding IP addresses as backend servers.
Servers []ServerGroupServerArgs
Status string: Server group status. Creating: creating. Active: running. Configuring: configuring. Deleting: deleting.
StickySessionConfig ServerGroupStickySessionConfigArgs: Session persistence parameter information.
Tags []ServerGroupTagArgs
UpdateTime string: Last operation time of the backend server group.
VpcId string: ID of the VPC to which the backend server group belongs.

createTime String: Creation time of the backend server group.
crossZoneEnabled String: Whether to enable cross-zone load balancing for the server group. Values: on (default): enabled, off: disabled.
description String: Description of the backend server group.
healthCheck ServerGroupHealthCheck: Server group health check configuration information.
ipAddressType String: IP address type of the server group. Only IPv4 is supported.
listeners List<ServerGroupListener>
projectName String: Name of the project to which the backend server group belongs.
protocol String: Backend protocol: HTTP, HTTPS.
scheduler String: Scheduling algorithm. Parameter values: wrr: Weighted round robin. wlc: Weighted least connections. sh: Source IP hash.
serverCount Integer: Number of backend servers in the server group.
serverGroupId String: ID of the backend server group.
serverGroupName String: Name of the backend server group.
serverGroupType String: Type of backend server group. instance: Server type. This type of server group supports adding ECS and ENI instances as backend servers. ip: IP type. This type of server group supports adding IP addresses as backend servers.
servers List<ServerGroupServer>
status String: Server group status. Creating: creating. Active: running. Configuring: configuring. Deleting: deleting.
stickySessionConfig ServerGroupStickySessionConfig: Session persistence parameter information.
tags List<ServerGroupTag>
updateTime String: Last operation time of the backend server group.
vpcId String: ID of the VPC to which the backend server group belongs.

createTime string: Creation time of the backend server group.
crossZoneEnabled string: Whether to enable cross-zone load balancing for the server group. Values: on (default): enabled, off: disabled.
description string: Description of the backend server group.
healthCheck ServerGroupHealthCheck: Server group health check configuration information.
ipAddressType string: IP address type of the server group. Only IPv4 is supported.
listeners ServerGroupListener[]
projectName string: Name of the project to which the backend server group belongs.
protocol string: Backend protocol: HTTP, HTTPS.
scheduler string: Scheduling algorithm. Parameter values: wrr: Weighted round robin. wlc: Weighted least connections. sh: Source IP hash.
serverCount number: Number of backend servers in the server group.
serverGroupId string: ID of the backend server group.
serverGroupName string: Name of the backend server group.
serverGroupType string: Type of backend server group. instance: Server type. This type of server group supports adding ECS and ENI instances as backend servers. ip: IP type. This type of server group supports adding IP addresses as backend servers.
servers ServerGroupServer[]
status string: Server group status. Creating: creating. Active: running. Configuring: configuring. Deleting: deleting.
stickySessionConfig ServerGroupStickySessionConfig: Session persistence parameter information.
tags ServerGroupTag[]
updateTime string: Last operation time of the backend server group.
vpcId string: ID of the VPC to which the backend server group belongs.

create_time str: Creation time of the backend server group.
cross_zone_enabled str: Whether to enable cross-zone load balancing for the server group. Values: on (default): enabled, off: disabled.
description str: Description of the backend server group.
health_check ServerGroupHealthCheckArgs: Server group health check configuration information.
ip_address_type str: IP address type of the server group. Only IPv4 is supported.
listeners Sequence[ServerGroupListenerArgs]
project_name str: Name of the project to which the backend server group belongs.
protocol str: Backend protocol: HTTP, HTTPS.
scheduler str: Scheduling algorithm. Parameter values: wrr: Weighted round robin. wlc: Weighted least connections. sh: Source IP hash.
server_count int: Number of backend servers in the server group.
server_group_id str: ID of the backend server group.
server_group_name str: Name of the backend server group.
server_group_type str: Type of backend server group. instance: Server type. This type of server group supports adding ECS and ENI instances as backend servers. ip: IP type. This type of server group supports adding IP addresses as backend servers.
servers Sequence[ServerGroupServerArgs]
status str: Server group status. Creating: creating. Active: running. Configuring: configuring. Deleting: deleting.
sticky_session_config ServerGroupStickySessionConfigArgs: Session persistence parameter information.
tags Sequence[ServerGroupTagArgs]
update_time str: Last operation time of the backend server group.
vpc_id str: ID of the VPC to which the backend server group belongs.

createTime String: Creation time of the backend server group.
crossZoneEnabled String: Whether to enable cross-zone load balancing for the server group. Values: on (default): enabled, off: disabled.
description String: Description of the backend server group.
healthCheck Property Map: Server group health check configuration information.
ipAddressType String: IP address type of the server group. Only IPv4 is supported.
listeners List<Property Map>
projectName String: Name of the project to which the backend server group belongs.
protocol String: Backend protocol: HTTP, HTTPS.
scheduler String: Scheduling algorithm. Parameter values: wrr: Weighted round robin. wlc: Weighted least connections. sh: Source IP hash.
serverCount Number: Number of backend servers in the server group.
serverGroupId String: ID of the backend server group.
serverGroupName String: Name of the backend server group.
serverGroupType String: Type of backend server group. instance: Server type. This type of server group supports adding ECS and ENI instances as backend servers. ip: IP type. This type of server group supports adding IP addresses as backend servers.
servers List<Property Map>
status String: Server group status. Creating: creating. Active: running. Configuring: configuring. Deleting: deleting.
stickySessionConfig Property Map: Session persistence parameter information.
tags List<Property Map>
updateTime String: Last operation time of the backend server group.
vpcId String: ID of the VPC to which the backend server group belongs.

Supporting Types

ServerGroupHealthCheck, ServerGroupHealthCheckArgs

Domain string: Domain name for health check. Configure this as the actual service address provided by the backend server. This parameter takes effect only when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with '.'. Each level of the domain name can contain letters, digits, '-', and '.' characters, and '-' cannot appear at the beginning or end of any level. Length: 1–128 characters. If this parameter is not specified or no value is provided, the default is empty, meaning the load balancer uses the private IP address of each backend server for health checks.
Enabled string: Whether the listener enables health check. Values: on: enabled (default), off: disabled.
HealthyThreshold int: Health check threshold. Indicates the number of consecutive successful health checks required for a backend server to be considered healthy. Unit: times. Value range: 2–10. Default: 3.
HttpCode string: HTTP status codes for a successful health check. Separate multiple codes with commas. This parameter is available only when HealthCheck.Protocol is HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
HttpVersion string: Health check HTTP protocol version. This parameter is available only when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default for API usage), HTTP1.1.
Interval int: After health checks are enabled, the interval for performing health checks. Unit: seconds. Value range: 1–300s. Default: 2.
Method string: Health check method after health checks are enabled. This parameter is valid only when HealthCheck.Protocol is set to HTTP. Values: GET: The server must support the GET method. HEAD (default): The server returns only the HEAD header, which reduces backend resource consumption, but the server must support the HEAD method.
Port int: Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
Protocol string: Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
Timeout int: Health check response timeout. If the backend server does not respond correctly within the specified time, the health check is considered abnormal. Unit: seconds. Value range: 1–60. Default: 2.
UnhealthyThreshold int: Unhealthy threshold for health checks. Indicates that a backend server is considered unhealthy if it fails the specified number of consecutive health checks. Unit: times. Range: 2–10. Default: 3.
Uri string: Health check path. Must be configured as the actual path provided by the backend server. This parameter is only effective when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length: 1–128 characters. If this parameter is not specified or specified without a value, the default is '/'.

Domain string: Domain name for health check. Configure this as the actual service address provided by the backend server. This parameter takes effect only when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with '.'. Each level of the domain name can contain letters, digits, '-', and '.' characters, and '-' cannot appear at the beginning or end of any level. Length: 1–128 characters. If this parameter is not specified or no value is provided, the default is empty, meaning the load balancer uses the private IP address of each backend server for health checks.
Enabled string: Whether the listener enables health check. Values: on: enabled (default), off: disabled.
HealthyThreshold int: Health check threshold. Indicates the number of consecutive successful health checks required for a backend server to be considered healthy. Unit: times. Value range: 2–10. Default: 3.
HttpCode string: HTTP status codes for a successful health check. Separate multiple codes with commas. This parameter is available only when HealthCheck.Protocol is HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
HttpVersion string: Health check HTTP protocol version. This parameter is available only when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default for API usage), HTTP1.1.
Interval int: After health checks are enabled, the interval for performing health checks. Unit: seconds. Value range: 1–300s. Default: 2.
Method string: Health check method after health checks are enabled. This parameter is valid only when HealthCheck.Protocol is set to HTTP. Values: GET: The server must support the GET method. HEAD (default): The server returns only the HEAD header, which reduces backend resource consumption, but the server must support the HEAD method.
Port int: Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
Protocol string: Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
Timeout int: Health check response timeout. If the backend server does not respond correctly within the specified time, the health check is considered abnormal. Unit: seconds. Value range: 1–60. Default: 2.
UnhealthyThreshold int: Unhealthy threshold for health checks. Indicates that a backend server is considered unhealthy if it fails the specified number of consecutive health checks. Unit: times. Range: 2–10. Default: 3.
Uri string: Health check path. Must be configured as the actual path provided by the backend server. This parameter is only effective when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length: 1–128 characters. If this parameter is not specified or specified without a value, the default is '/'.

domain String: Domain name for health check. Configure this as the actual service address provided by the backend server. This parameter takes effect only when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with '.'. Each level of the domain name can contain letters, digits, '-', and '.' characters, and '-' cannot appear at the beginning or end of any level. Length: 1–128 characters. If this parameter is not specified or no value is provided, the default is empty, meaning the load balancer uses the private IP address of each backend server for health checks.
enabled String: Whether the listener enables health check. Values: on: enabled (default), off: disabled.
healthyThreshold Integer: Health check threshold. Indicates the number of consecutive successful health checks required for a backend server to be considered healthy. Unit: times. Value range: 2–10. Default: 3.
httpCode String: HTTP status codes for a successful health check. Separate multiple codes with commas. This parameter is available only when HealthCheck.Protocol is HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
httpVersion String: Health check HTTP protocol version. This parameter is available only when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default for API usage), HTTP1.1.
interval Integer: After health checks are enabled, the interval for performing health checks. Unit: seconds. Value range: 1–300s. Default: 2.
method String: Health check method after health checks are enabled. This parameter is valid only when HealthCheck.Protocol is set to HTTP. Values: GET: The server must support the GET method. HEAD (default): The server returns only the HEAD header, which reduces backend resource consumption, but the server must support the HEAD method.
port Integer: Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
protocol String: Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
timeout Integer: Health check response timeout. If the backend server does not respond correctly within the specified time, the health check is considered abnormal. Unit: seconds. Value range: 1–60. Default: 2.
unhealthyThreshold Integer: Unhealthy threshold for health checks. Indicates that a backend server is considered unhealthy if it fails the specified number of consecutive health checks. Unit: times. Range: 2–10. Default: 3.
uri String: Health check path. Must be configured as the actual path provided by the backend server. This parameter is only effective when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length: 1–128 characters. If this parameter is not specified or specified without a value, the default is '/'.

domain string: Domain name for health check. Configure this as the actual service address provided by the backend server. This parameter takes effect only when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with '.'. Each level of the domain name can contain letters, digits, '-', and '.' characters, and '-' cannot appear at the beginning or end of any level. Length: 1–128 characters. If this parameter is not specified or no value is provided, the default is empty, meaning the load balancer uses the private IP address of each backend server for health checks.
enabled string: Whether the listener enables health check. Values: on: enabled (default), off: disabled.
healthyThreshold number: Health check threshold. Indicates the number of consecutive successful health checks required for a backend server to be considered healthy. Unit: times. Value range: 2–10. Default: 3.
httpCode string: HTTP status codes for a successful health check. Separate multiple codes with commas. This parameter is available only when HealthCheck.Protocol is HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
httpVersion string: Health check HTTP protocol version. This parameter is available only when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default for API usage), HTTP1.1.
interval number: After health checks are enabled, the interval for performing health checks. Unit: seconds. Value range: 1–300s. Default: 2.
method string: Health check method after health checks are enabled. This parameter is valid only when HealthCheck.Protocol is set to HTTP. Values: GET: The server must support the GET method. HEAD (default): The server returns only the HEAD header, which reduces backend resource consumption, but the server must support the HEAD method.
port number: Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
protocol string: Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
timeout number: Health check response timeout. If the backend server does not respond correctly within the specified time, the health check is considered abnormal. Unit: seconds. Value range: 1–60. Default: 2.
unhealthyThreshold number: Unhealthy threshold for health checks. Indicates that a backend server is considered unhealthy if it fails the specified number of consecutive health checks. Unit: times. Range: 2–10. Default: 3.
uri string: Health check path. Must be configured as the actual path provided by the backend server. This parameter is only effective when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length: 1–128 characters. If this parameter is not specified or specified without a value, the default is '/'.

domain str: Domain name for health check. Configure this as the actual service address provided by the backend server. This parameter takes effect only when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with '.'. Each level of the domain name can contain letters, digits, '-', and '.' characters, and '-' cannot appear at the beginning or end of any level. Length: 1–128 characters. If this parameter is not specified or no value is provided, the default is empty, meaning the load balancer uses the private IP address of each backend server for health checks.
enabled str: Whether the listener enables health check. Values: on: enabled (default), off: disabled.
healthy_threshold int: Health check threshold. Indicates the number of consecutive successful health checks required for a backend server to be considered healthy. Unit: times. Value range: 2–10. Default: 3.
http_code str: HTTP status codes for a successful health check. Separate multiple codes with commas. This parameter is available only when HealthCheck.Protocol is HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
http_version str: Health check HTTP protocol version. This parameter is available only when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default for API usage), HTTP1.1.
interval int: After health checks are enabled, the interval for performing health checks. Unit: seconds. Value range: 1–300s. Default: 2.
method str: Health check method after health checks are enabled. This parameter is valid only when HealthCheck.Protocol is set to HTTP. Values: GET: The server must support the GET method. HEAD (default): The server returns only the HEAD header, which reduces backend resource consumption, but the server must support the HEAD method.
port int: Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
protocol str: Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
timeout int: Health check response timeout. If the backend server does not respond correctly within the specified time, the health check is considered abnormal. Unit: seconds. Value range: 1–60. Default: 2.
unhealthy_threshold int: Unhealthy threshold for health checks. Indicates that a backend server is considered unhealthy if it fails the specified number of consecutive health checks. Unit: times. Range: 2–10. Default: 3.
uri str: Health check path. Must be configured as the actual path provided by the backend server. This parameter is only effective when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length: 1–128 characters. If this parameter is not specified or specified without a value, the default is '/'.

domain String: Domain name for health check. Configure this as the actual service address provided by the backend server. This parameter takes effect only when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with '.'. Each level of the domain name can contain letters, digits, '-', and '.' characters, and '-' cannot appear at the beginning or end of any level. Length: 1–128 characters. If this parameter is not specified or no value is provided, the default is empty, meaning the load balancer uses the private IP address of each backend server for health checks.
enabled String: Whether the listener enables health check. Values: on: enabled (default), off: disabled.
healthyThreshold Number: Health check threshold. Indicates the number of consecutive successful health checks required for a backend server to be considered healthy. Unit: times. Value range: 2–10. Default: 3.
httpCode String: HTTP status codes for a successful health check. Separate multiple codes with commas. This parameter is available only when HealthCheck.Protocol is HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
httpVersion String: Health check HTTP protocol version. This parameter is available only when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default for API usage), HTTP1.1.
interval Number: After health checks are enabled, the interval for performing health checks. Unit: seconds. Value range: 1–300s. Default: 2.
method String: Health check method after health checks are enabled. This parameter is valid only when HealthCheck.Protocol is set to HTTP. Values: GET: The server must support the GET method. HEAD (default): The server returns only the HEAD header, which reduces backend resource consumption, but the server must support the HEAD method.
port Number: Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
protocol String: Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
timeout Number: Health check response timeout. If the backend server does not respond correctly within the specified time, the health check is considered abnormal. Unit: seconds. Value range: 1–60. Default: 2.
unhealthyThreshold Number: Unhealthy threshold for health checks. Indicates that a backend server is considered unhealthy if it fails the specified number of consecutive health checks. Unit: times. Range: 2–10. Default: 3.
uri String: Health check path. Must be configured as the actual path provided by the backend server. This parameter is only effective when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length: 1–128 characters. If this parameter is not specified or specified without a value, the default is '/'.

ServerGroupListener, ServerGroupListenerArgs

ListenerId string: Listener ID.

ListenerId string: Listener ID.

listenerId String: Listener ID.

listenerId string: Listener ID.

listener_id str: Listener ID.

listenerId String: Listener ID.

ServerGroupServer, ServerGroupServerArgs

Description string: Description of the backend server.
InstanceId string: ID of the cloud server instance or network interface card.
Ip string: Private IP address of the backend server.
Port int: Port number on which the backend server receives requests.
RemoteEnabled string: Enable remote IP feature. This field is valid only when the backend server instance type is IP address, that is, when Type is set to ip. Parameter values: on: Enable. off (default): Disable.
ServerId string: Backend server ID.
Type string: Backend server instance type. ecs: ECS instance. eni: auxiliary ENI. ip: IP address (valid only for IP-type server groups).
Weight int: Weight of the backend server.

Description string: Description of the backend server.
InstanceId string: ID of the cloud server instance or network interface card.
Ip string: Private IP address of the backend server.
Port int: Port number on which the backend server receives requests.
RemoteEnabled string: Enable remote IP feature. This field is valid only when the backend server instance type is IP address, that is, when Type is set to ip. Parameter values: on: Enable. off (default): Disable.
ServerId string: Backend server ID.
Type string: Backend server instance type. ecs: ECS instance. eni: auxiliary ENI. ip: IP address (valid only for IP-type server groups).
Weight int: Weight of the backend server.

description String: Description of the backend server.
instanceId String: ID of the cloud server instance or network interface card.
ip String: Private IP address of the backend server.
port Integer: Port number on which the backend server receives requests.
remoteEnabled String: Enable remote IP feature. This field is valid only when the backend server instance type is IP address, that is, when Type is set to ip. Parameter values: on: Enable. off (default): Disable.
serverId String: Backend server ID.
type String: Backend server instance type. ecs: ECS instance. eni: auxiliary ENI. ip: IP address (valid only for IP-type server groups).
weight Integer: Weight of the backend server.

description string: Description of the backend server.
instanceId string: ID of the cloud server instance or network interface card.
ip string: Private IP address of the backend server.
port number: Port number on which the backend server receives requests.
remoteEnabled string: Enable remote IP feature. This field is valid only when the backend server instance type is IP address, that is, when Type is set to ip. Parameter values: on: Enable. off (default): Disable.
serverId string: Backend server ID.
type string: Backend server instance type. ecs: ECS instance. eni: auxiliary ENI. ip: IP address (valid only for IP-type server groups).
weight number: Weight of the backend server.

description str: Description of the backend server.
instance_id str: ID of the cloud server instance or network interface card.
ip str: Private IP address of the backend server.
port int: Port number on which the backend server receives requests.
remote_enabled str: Enable remote IP feature. This field is valid only when the backend server instance type is IP address, that is, when Type is set to ip. Parameter values: on: Enable. off (default): Disable.
server_id str: Backend server ID.
type str: Backend server instance type. ecs: ECS instance. eni: auxiliary ENI. ip: IP address (valid only for IP-type server groups).
weight int: Weight of the backend server.

description String: Description of the backend server.
instanceId String: ID of the cloud server instance or network interface card.
ip String: Private IP address of the backend server.
port Number: Port number on which the backend server receives requests.
remoteEnabled String: Enable remote IP feature. This field is valid only when the backend server instance type is IP address, that is, when Type is set to ip. Parameter values: on: Enable. off (default): Disable.
serverId String: Backend server ID.
type String: Backend server instance type. ecs: ECS instance. eni: auxiliary ENI. ip: IP address (valid only for IP-type server groups).
weight Number: Weight of the backend server.

ServerGroupStickySessionConfig, ServerGroupStickySessionConfigArgs

Cookie string: Name of the session persistence Cookie for service configuration. This is only valid when session persistence is enabled and Cookie overwrite is selected. The specific rules are as follows: The Cookie name must be 1–200 characters long. The name can only contain ASCII letters and digits, cannot contain commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). This parameter is required when tickySessionConfig.StickySessionEnabled is set to on and StickySessionConfig.StickySessionType is server. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert.
CookieTimeout int: Session persistence cookie timeout. Only valid when session persistence is enabled and the insert cookie option is selected. Unit: seconds. Rules: Timeout range: 1–86400. Default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
StickySessionEnabled string: Enable session persistence. on: Enable; off (default): Disable.
StickySessionType string: Cookie handling method. This field is required when StickySessionConfig.StickySessionEnabled is set to on. Parameter values: insert: Inserts a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response. Subsequent client requests carry this Cookie, and ALB forwards the requests to the previously recorded backend server. server: Overwrites the Cookie. When session persistence with Cookie overwrite is enabled, after the client's first request is forwarded to the backend server, if ALB detects your custom Cookie in the response, it overwrites the original Cookie. Subsequent client requests carry the overwritten Cookie, and ALB forwards the requests to the previously recorded backend server.

Cookie string: Name of the session persistence Cookie for service configuration. This is only valid when session persistence is enabled and Cookie overwrite is selected. The specific rules are as follows: The Cookie name must be 1–200 characters long. The name can only contain ASCII letters and digits, cannot contain commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). This parameter is required when tickySessionConfig.StickySessionEnabled is set to on and StickySessionConfig.StickySessionType is server. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert.
CookieTimeout int: Session persistence cookie timeout. Only valid when session persistence is enabled and the insert cookie option is selected. Unit: seconds. Rules: Timeout range: 1–86400. Default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
StickySessionEnabled string: Enable session persistence. on: Enable; off (default): Disable.
StickySessionType string: Cookie handling method. This field is required when StickySessionConfig.StickySessionEnabled is set to on. Parameter values: insert: Inserts a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response. Subsequent client requests carry this Cookie, and ALB forwards the requests to the previously recorded backend server. server: Overwrites the Cookie. When session persistence with Cookie overwrite is enabled, after the client's first request is forwarded to the backend server, if ALB detects your custom Cookie in the response, it overwrites the original Cookie. Subsequent client requests carry the overwritten Cookie, and ALB forwards the requests to the previously recorded backend server.

cookie String: Name of the session persistence Cookie for service configuration. This is only valid when session persistence is enabled and Cookie overwrite is selected. The specific rules are as follows: The Cookie name must be 1–200 characters long. The name can only contain ASCII letters and digits, cannot contain commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). This parameter is required when tickySessionConfig.StickySessionEnabled is set to on and StickySessionConfig.StickySessionType is server. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert.
cookieTimeout Integer: Session persistence cookie timeout. Only valid when session persistence is enabled and the insert cookie option is selected. Unit: seconds. Rules: Timeout range: 1–86400. Default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
stickySessionEnabled String: Enable session persistence. on: Enable; off (default): Disable.
stickySessionType String: Cookie handling method. This field is required when StickySessionConfig.StickySessionEnabled is set to on. Parameter values: insert: Inserts a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response. Subsequent client requests carry this Cookie, and ALB forwards the requests to the previously recorded backend server. server: Overwrites the Cookie. When session persistence with Cookie overwrite is enabled, after the client's first request is forwarded to the backend server, if ALB detects your custom Cookie in the response, it overwrites the original Cookie. Subsequent client requests carry the overwritten Cookie, and ALB forwards the requests to the previously recorded backend server.

cookie string: Name of the session persistence Cookie for service configuration. This is only valid when session persistence is enabled and Cookie overwrite is selected. The specific rules are as follows: The Cookie name must be 1–200 characters long. The name can only contain ASCII letters and digits, cannot contain commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). This parameter is required when tickySessionConfig.StickySessionEnabled is set to on and StickySessionConfig.StickySessionType is server. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert.
cookieTimeout number: Session persistence cookie timeout. Only valid when session persistence is enabled and the insert cookie option is selected. Unit: seconds. Rules: Timeout range: 1–86400. Default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
stickySessionEnabled string: Enable session persistence. on: Enable; off (default): Disable.
stickySessionType string: Cookie handling method. This field is required when StickySessionConfig.StickySessionEnabled is set to on. Parameter values: insert: Inserts a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response. Subsequent client requests carry this Cookie, and ALB forwards the requests to the previously recorded backend server. server: Overwrites the Cookie. When session persistence with Cookie overwrite is enabled, after the client's first request is forwarded to the backend server, if ALB detects your custom Cookie in the response, it overwrites the original Cookie. Subsequent client requests carry the overwritten Cookie, and ALB forwards the requests to the previously recorded backend server.

cookie str: Name of the session persistence Cookie for service configuration. This is only valid when session persistence is enabled and Cookie overwrite is selected. The specific rules are as follows: The Cookie name must be 1–200 characters long. The name can only contain ASCII letters and digits, cannot contain commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). This parameter is required when tickySessionConfig.StickySessionEnabled is set to on and StickySessionConfig.StickySessionType is server. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert.
cookie_timeout int: Session persistence cookie timeout. Only valid when session persistence is enabled and the insert cookie option is selected. Unit: seconds. Rules: Timeout range: 1–86400. Default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
sticky_session_enabled str: Enable session persistence. on: Enable; off (default): Disable.
sticky_session_type str: Cookie handling method. This field is required when StickySessionConfig.StickySessionEnabled is set to on. Parameter values: insert: Inserts a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response. Subsequent client requests carry this Cookie, and ALB forwards the requests to the previously recorded backend server. server: Overwrites the Cookie. When session persistence with Cookie overwrite is enabled, after the client's first request is forwarded to the backend server, if ALB detects your custom Cookie in the response, it overwrites the original Cookie. Subsequent client requests carry the overwritten Cookie, and ALB forwards the requests to the previously recorded backend server.

cookie String: Name of the session persistence Cookie for service configuration. This is only valid when session persistence is enabled and Cookie overwrite is selected. The specific rules are as follows: The Cookie name must be 1–200 characters long. The name can only contain ASCII letters and digits, cannot contain commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). This parameter is required when tickySessionConfig.StickySessionEnabled is set to on and StickySessionConfig.StickySessionType is server. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert.
cookieTimeout Number: Session persistence cookie timeout. Only valid when session persistence is enabled and the insert cookie option is selected. Unit: seconds. Rules: Timeout range: 1–86400. Default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
stickySessionEnabled String: Enable session persistence. on: Enable; off (default): Disable.
stickySessionType String: Cookie handling method. This field is required when StickySessionConfig.StickySessionEnabled is set to on. Parameter values: insert: Inserts a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response. Subsequent client requests carry this Cookie, and ALB forwards the requests to the previously recorded backend server. server: Overwrites the Cookie. When session persistence with Cookie overwrite is enabled, after the client's first request is forwarded to the backend server, if ALB detects your custom Cookie in the response, it overwrites the original Cookie. Subsequent client requests carry the overwritten Cookie, and ALB forwards the requests to the previously recorded backend server.

ServerGroupTag, ServerGroupTagArgs

Key string: Tag key. Tag keys for the same resource must be unique.
Value string: Tag value of the tag.

Key string: Tag key. Tag keys for the same resource must be unique.
Value string: Tag value of the tag.

key String: Tag key. Tag keys for the same resource must be unique.
value String: Tag value of the tag.

key string: Tag key. Tag keys for the same resource must be unique.
value string: Tag value of the tag.

key str: Tag key. Tag keys for the same resource must be unique.
value str: Tag value of the tag.

key String: Tag key. Tag keys for the same resource must be unique.
value String: Tag value of the tag.

Import

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

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

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.alb.ServerGroup

On this page

On this page

Example Usage

Create ServerGroup Resource

Constructor syntax

Parameters

ServerGroup Resource Properties

Inputs

Outputs

Look up Existing ServerGroup Resource

Supporting Types

ServerGroupHealthCheck, ServerGroupHealthCheckArgs

ServerGroupListener, ServerGroupListenerArgs

ServerGroupServer, ServerGroupServerArgs

ServerGroupStickySessionConfig, ServerGroupStickySessionConfigArgs

ServerGroupTag, ServerGroupTagArgs

Import

Package Details

On this page

On this page