published on Thursday, May 7, 2026 by Volcengine
published on Thursday, May 7, 2026 by Volcengine
A server group is a logical collection of backend servers. The ALB instance determines which server group to forward client requests to based on your forwarding rules. Then, the ALB instance distributes requests to backend servers within the server group according to your load balancing policy. Backend servers receive and process the requests.
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
albServergroupDemo:
type: 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var serverGroupResource = new Volcenginecc.Alb.ServerGroup("serverGroupResource", new()
{
VpcId = "string",
Scheduler = "string",
HealthCheck = new Volcenginecc.Alb.Inputs.ServerGroupHealthCheckArgs
{
Domain = "string",
Enabled = "string",
HealthyThreshold = 0,
HttpCode = "string",
HttpVersion = "string",
Interval = 0,
Method = "string",
Port = 0,
Protocol = "string",
Timeout = 0,
UnhealthyThreshold = 0,
Uri = "string",
},
IpAddressType = "string",
ProjectName = "string",
Protocol = "string",
CrossZoneEnabled = "string",
ServerGroupName = "string",
ServerGroupType = "string",
Servers = new[]
{
new Volcenginecc.Alb.Inputs.ServerGroupServerArgs
{
Description = "string",
InstanceId = "string",
Ip = "string",
Port = 0,
RemoteEnabled = "string",
ServerId = "string",
Type = "string",
Weight = 0,
},
},
Status = "string",
StickySessionConfig = new Volcenginecc.Alb.Inputs.ServerGroupStickySessionConfigArgs
{
Cookie = "string",
CookieTimeout = 0,
StickySessionEnabled = "string",
StickySessionType = "string",
},
Tags = new[]
{
new Volcenginecc.Alb.Inputs.ServerGroupTagArgs
{
Key = "string",
Value = "string",
},
},
Description = "string",
});
example, err := alb.NewServerGroup(ctx, "serverGroupResource", &alb.ServerGroupArgs{
VpcId: pulumi.String("string"),
Scheduler: pulumi.String("string"),
HealthCheck: &alb.ServerGroupHealthCheckArgs{
Domain: pulumi.String("string"),
Enabled: pulumi.String("string"),
HealthyThreshold: pulumi.Int(0),
HttpCode: pulumi.String("string"),
HttpVersion: pulumi.String("string"),
Interval: pulumi.Int(0),
Method: pulumi.String("string"),
Port: pulumi.Int(0),
Protocol: pulumi.String("string"),
Timeout: pulumi.Int(0),
UnhealthyThreshold: pulumi.Int(0),
Uri: pulumi.String("string"),
},
IpAddressType: pulumi.String("string"),
ProjectName: pulumi.String("string"),
Protocol: pulumi.String("string"),
CrossZoneEnabled: pulumi.String("string"),
ServerGroupName: pulumi.String("string"),
ServerGroupType: pulumi.String("string"),
Servers: alb.ServerGroupServerArray{
&alb.ServerGroupServerArgs{
Description: pulumi.String("string"),
InstanceId: pulumi.String("string"),
Ip: pulumi.String("string"),
Port: pulumi.Int(0),
RemoteEnabled: pulumi.String("string"),
ServerId: pulumi.String("string"),
Type: pulumi.String("string"),
Weight: pulumi.Int(0),
},
},
Status: pulumi.String("string"),
StickySessionConfig: &alb.ServerGroupStickySessionConfigArgs{
Cookie: pulumi.String("string"),
CookieTimeout: pulumi.Int(0),
StickySessionEnabled: pulumi.String("string"),
StickySessionType: pulumi.String("string"),
},
Tags: alb.ServerGroupTagArray{
&alb.ServerGroupTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
})
var serverGroupResource = new com.volcengine.volcenginecc.alb.ServerGroup("serverGroupResource", com.volcengine.volcenginecc.alb.ServerGroupArgs.builder()
.vpcId("string")
.scheduler("string")
.healthCheck(ServerGroupHealthCheckArgs.builder()
.domain("string")
.enabled("string")
.healthyThreshold(0)
.httpCode("string")
.httpVersion("string")
.interval(0)
.method("string")
.port(0)
.protocol("string")
.timeout(0)
.unhealthyThreshold(0)
.uri("string")
.build())
.ipAddressType("string")
.projectName("string")
.protocol("string")
.crossZoneEnabled("string")
.serverGroupName("string")
.serverGroupType("string")
.servers(ServerGroupServerArgs.builder()
.description("string")
.instanceId("string")
.ip("string")
.port(0)
.remoteEnabled("string")
.serverId("string")
.type("string")
.weight(0)
.build())
.status("string")
.stickySessionConfig(ServerGroupStickySessionConfigArgs.builder()
.cookie("string")
.cookieTimeout(0)
.stickySessionEnabled("string")
.stickySessionType("string")
.build())
.tags(ServerGroupTagArgs.builder()
.key("string")
.value("string")
.build())
.description("string")
.build());
server_group_resource = volcenginecc.alb.ServerGroup("serverGroupResource",
vpc_id="string",
scheduler="string",
health_check={
"domain": "string",
"enabled": "string",
"healthy_threshold": 0,
"http_code": "string",
"http_version": "string",
"interval": 0,
"method": "string",
"port": 0,
"protocol": "string",
"timeout": 0,
"unhealthy_threshold": 0,
"uri": "string",
},
ip_address_type="string",
project_name="string",
protocol="string",
cross_zone_enabled="string",
server_group_name="string",
server_group_type="string",
servers=[{
"description": "string",
"instance_id": "string",
"ip": "string",
"port": 0,
"remote_enabled": "string",
"server_id": "string",
"type": "string",
"weight": 0,
}],
status="string",
sticky_session_config={
"cookie": "string",
"cookie_timeout": 0,
"sticky_session_enabled": "string",
"sticky_session_type": "string",
},
tags=[{
"key": "string",
"value": "string",
}],
description="string")
const serverGroupResource = new volcenginecc.alb.ServerGroup("serverGroupResource", {
vpcId: "string",
scheduler: "string",
healthCheck: {
domain: "string",
enabled: "string",
healthyThreshold: 0,
httpCode: "string",
httpVersion: "string",
interval: 0,
method: "string",
port: 0,
protocol: "string",
timeout: 0,
unhealthyThreshold: 0,
uri: "string",
},
ipAddressType: "string",
projectName: "string",
protocol: "string",
crossZoneEnabled: "string",
serverGroupName: "string",
serverGroupType: "string",
servers: [{
description: "string",
instanceId: "string",
ip: "string",
port: 0,
remoteEnabled: "string",
serverId: "string",
type: "string",
weight: 0,
}],
status: "string",
stickySessionConfig: {
cookie: "string",
cookieTimeout: 0,
stickySessionEnabled: "string",
stickySessionType: "string",
},
tags: [{
key: "string",
value: "string",
}],
description: "string",
});
type: volcenginecc:alb:ServerGroup
properties:
crossZoneEnabled: string
description: string
healthCheck:
domain: string
enabled: string
healthyThreshold: 0
httpCode: string
httpVersion: string
interval: 0
method: string
port: 0
protocol: string
timeout: 0
unhealthyThreshold: 0
uri: string
ipAddressType: string
projectName: string
protocol: string
scheduler: string
serverGroupName: string
serverGroupType: string
servers:
- description: string
instanceId: string
ip: string
port: 0
remoteEnabled: string
serverId: string
type: string
weight: 0
status: string
stickySessionConfig:
cookie: string
cookieTimeout: 0
stickySessionEnabled: string
stickySessionType: string
tags:
- key: string
value: string
vpcId: string
ServerGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ServerGroup resource accepts the following input properties:
- Vpc
Id string - ID of the VPC to which the backend server group belongs.
- Cross
Zone stringEnabled - Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
- Description string
- Description of the backend server group.
- Health
Check Volcengine.Server Group Health Check - Health check configuration information for the server group.
- Ip
Address stringType - IP address type of the server group. Currently, only IPv4 is supported.
- Project
Name string - Name of the project to which the backend server group belongs.
- Protocol string
- Backend protocol: HTTP, HTTPS.
- Scheduler string
- Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
- Server
Group stringName - Backend server group name.
- Server
Group stringType - Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
- Servers
List<Volcengine.
Server Group Server> - Status string
- Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
- Sticky
Session Volcengine.Config Server Group Sticky Session Config - Session persistence parameter information.
-
List<Volcengine.
Server Group Tag>
- Vpc
Id string - ID of the VPC to which the backend server group belongs.
- Cross
Zone stringEnabled - Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
- Description string
- Description of the backend server group.
- Health
Check ServerGroup Health Check Args - Health check configuration information for the server group.
- Ip
Address stringType - IP address type of the server group. Currently, only IPv4 is supported.
- Project
Name string - Name of the project to which the backend server group belongs.
- Protocol string
- Backend protocol: HTTP, HTTPS.
- Scheduler string
- Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
- Server
Group stringName - Backend server group name.
- Server
Group stringType - Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
- Servers
[]Server
Group Server Args - Status string
- Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
- Sticky
Session ServerConfig Group Sticky Session Config Args - Session persistence parameter information.
-
[]Server
Group Tag Args
- vpc
Id String - ID of the VPC to which the backend server group belongs.
- cross
Zone StringEnabled - Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
- description String
- Description of the backend server group.
- health
Check ServerGroup Health Check - Health check configuration information for the server group.
- ip
Address StringType - IP address type of the server group. Currently, only IPv4 is supported.
- project
Name String - Name of the project to which the backend server group belongs.
- protocol String
- Backend protocol: HTTP, HTTPS.
- scheduler String
- Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
- server
Group StringName - Backend server group name.
- server
Group StringType - Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
- servers
List<Server
Group Server> - status String
- Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
- sticky
Session ServerConfig Group Sticky Session Config - Session persistence parameter information.
-
List<Server
Group Tag>
- vpc
Id string - ID of the VPC to which the backend server group belongs.
- cross
Zone stringEnabled - Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
- description string
- Description of the backend server group.
- health
Check ServerGroup Health Check - Health check configuration information for the server group.
- ip
Address stringType - IP address type of the server group. Currently, only IPv4 is supported.
- project
Name string - Name of the project to which the backend server group belongs.
- protocol string
- Backend protocol: HTTP, HTTPS.
- scheduler string
- Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
- server
Group stringName - Backend server group name.
- server
Group stringType - Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
- servers
Server
Group Server[] - status string
- Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
- sticky
Session ServerConfig Group Sticky Session Config - Session persistence parameter information.
-
Server
Group Tag[]
- vpc_
id str - ID of the VPC to which the backend server group belongs.
- cross_
zone_ strenabled - Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
- description str
- Description of the backend server group.
- health_
check ServerGroup Health Check Args - Health check configuration information for the server group.
- ip_
address_ strtype - IP address type of the server group. Currently, only IPv4 is supported.
- project_
name str - Name of the project to which the backend server group belongs.
- protocol str
- Backend protocol: HTTP, HTTPS.
- scheduler str
- Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
- server_
group_ strname - Backend server group name.
- server_
group_ strtype - Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
- servers
Sequence[Server
Group Server Args] - status str
- Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
- sticky_
session_ Serverconfig Group Sticky Session Config Args - Session persistence parameter information.
-
Sequence[Server
Group Tag Args]
- vpc
Id String - ID of the VPC to which the backend server group belongs.
- cross
Zone StringEnabled - Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
- description String
- Description of the backend server group.
- health
Check Property Map - Health check configuration information for the server group.
- ip
Address StringType - IP address type of the server group. Currently, only IPv4 is supported.
- project
Name String - Name of the project to which the backend server group belongs.
- protocol String
- Backend protocol: HTTP, HTTPS.
- scheduler String
- Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
- server
Group StringName - Backend server group name.
- server
Group StringType - Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
- servers List<Property Map>
- status String
- Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
- sticky
Session Property MapConfig - Session persistence parameter information.
- List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the ServerGroup resource produces the following output properties:
- Create
Time string - Creation time of the backend server group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Listeners
List<Volcengine.
Server Group Listener> - Server
Count int - Number of backend servers in the server group.
- Server
Group stringId - Backend server group ID.
- Update
Time string - Last operation time of the backend server group.
- Create
Time string - Creation time of the backend server group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Listeners
[]Server
Group Listener - Server
Count int - Number of backend servers in the server group.
- Server
Group stringId - Backend server group ID.
- Update
Time string - Last operation time of the backend server group.
- create
Time String - Creation time of the backend server group.
- id String
- The provider-assigned unique ID for this managed resource.
- listeners
List<Server
Group Listener> - server
Count Integer - Number of backend servers in the server group.
- server
Group StringId - Backend server group ID.
- update
Time String - Last operation time of the backend server group.
- create
Time string - Creation time of the backend server group.
- id string
- The provider-assigned unique ID for this managed resource.
- listeners
Server
Group Listener[] - server
Count number - Number of backend servers in the server group.
- server
Group stringId - Backend server group ID.
- update
Time 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[Server
Group Listener] - server_
count int - Number of backend servers in the server group.
- server_
group_ strid - Backend server group ID.
- update_
time str - Last operation time of the backend server group.
- create
Time String - Creation time of the backend server group.
- id String
- The provider-assigned unique ID for this managed resource.
- listeners List<Property Map>
- server
Count Number - Number of backend servers in the server group.
- server
Group StringId - Backend server group ID.
- update
Time 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) -> ServerGroupfunc 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.
- Create
Time string - Creation time of the backend server group.
- Cross
Zone stringEnabled - Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
- Description string
- Description of the backend server group.
- Health
Check Volcengine.Server Group Health Check - Health check configuration information for the server group.
- Ip
Address stringType - IP address type of the server group. Currently, only IPv4 is supported.
- Listeners
List<Volcengine.
Server Group Listener> - Project
Name string - Name of the project to which the backend server group belongs.
- Protocol string
- Backend protocol: HTTP, HTTPS.
- Scheduler string
- Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
- Server
Count int - Number of backend servers in the server group.
- Server
Group stringId - Backend server group ID.
- Server
Group stringName - Backend server group name.
- Server
Group stringType - Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
- Servers
List<Volcengine.
Server Group Server> - Status string
- Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
- Sticky
Session Volcengine.Config Server Group Sticky Session Config - Session persistence parameter information.
-
List<Volcengine.
Server Group Tag> - Update
Time string - Last operation time of the backend server group.
- Vpc
Id string - ID of the VPC to which the backend server group belongs.
- Create
Time string - Creation time of the backend server group.
- Cross
Zone stringEnabled - Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
- Description string
- Description of the backend server group.
- Health
Check ServerGroup Health Check Args - Health check configuration information for the server group.
- Ip
Address stringType - IP address type of the server group. Currently, only IPv4 is supported.
- Listeners
[]Server
Group Listener Args - Project
Name string - Name of the project to which the backend server group belongs.
- Protocol string
- Backend protocol: HTTP, HTTPS.
- Scheduler string
- Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
- Server
Count int - Number of backend servers in the server group.
- Server
Group stringId - Backend server group ID.
- Server
Group stringName - Backend server group name.
- Server
Group stringType - Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
- Servers
[]Server
Group Server Args - Status string
- Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
- Sticky
Session ServerConfig Group Sticky Session Config Args - Session persistence parameter information.
-
[]Server
Group Tag Args - Update
Time string - Last operation time of the backend server group.
- Vpc
Id string - ID of the VPC to which the backend server group belongs.
- create
Time String - Creation time of the backend server group.
- cross
Zone StringEnabled - Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
- description String
- Description of the backend server group.
- health
Check ServerGroup Health Check - Health check configuration information for the server group.
- ip
Address StringType - IP address type of the server group. Currently, only IPv4 is supported.
- listeners
List<Server
Group Listener> - project
Name String - Name of the project to which the backend server group belongs.
- protocol String
- Backend protocol: HTTP, HTTPS.
- scheduler String
- Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
- server
Count Integer - Number of backend servers in the server group.
- server
Group StringId - Backend server group ID.
- server
Group StringName - Backend server group name.
- server
Group StringType - Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
- servers
List<Server
Group Server> - status String
- Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
- sticky
Session ServerConfig Group Sticky Session Config - Session persistence parameter information.
-
List<Server
Group Tag> - update
Time String - Last operation time of the backend server group.
- vpc
Id String - ID of the VPC to which the backend server group belongs.
- create
Time string - Creation time of the backend server group.
- cross
Zone stringEnabled - Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
- description string
- Description of the backend server group.
- health
Check ServerGroup Health Check - Health check configuration information for the server group.
- ip
Address stringType - IP address type of the server group. Currently, only IPv4 is supported.
- listeners
Server
Group Listener[] - project
Name string - Name of the project to which the backend server group belongs.
- protocol string
- Backend protocol: HTTP, HTTPS.
- scheduler string
- Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
- server
Count number - Number of backend servers in the server group.
- server
Group stringId - Backend server group ID.
- server
Group stringName - Backend server group name.
- server
Group stringType - Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
- servers
Server
Group Server[] - status string
- Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
- sticky
Session ServerConfig Group Sticky Session Config - Session persistence parameter information.
-
Server
Group Tag[] - update
Time string - Last operation time of the backend server group.
- vpc
Id string - ID of the VPC to which the backend server group belongs.
- create_
time str - Creation time of the backend server group.
- cross_
zone_ strenabled - Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
- description str
- Description of the backend server group.
- health_
check ServerGroup Health Check Args - Health check configuration information for the server group.
- ip_
address_ strtype - IP address type of the server group. Currently, only IPv4 is supported.
- listeners
Sequence[Server
Group Listener Args] - project_
name str - Name of the project to which the backend server group belongs.
- protocol str
- Backend protocol: HTTP, HTTPS.
- scheduler str
- Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
- server_
count int - Number of backend servers in the server group.
- server_
group_ strid - Backend server group ID.
- server_
group_ strname - Backend server group name.
- server_
group_ strtype - Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
- servers
Sequence[Server
Group Server Args] - status str
- Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
- sticky_
session_ Serverconfig Group Sticky Session Config Args - Session persistence parameter information.
-
Sequence[Server
Group Tag Args] - 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.
- create
Time String - Creation time of the backend server group.
- cross
Zone StringEnabled - Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
- description String
- Description of the backend server group.
- health
Check Property Map - Health check configuration information for the server group.
- ip
Address StringType - IP address type of the server group. Currently, only IPv4 is supported.
- listeners List<Property Map>
- project
Name String - Name of the project to which the backend server group belongs.
- protocol String
- Backend protocol: HTTP, HTTPS.
- scheduler String
- Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
- server
Count Number - Number of backend servers in the server group.
- server
Group StringId - Backend server group ID.
- server
Group StringName - Backend server group name.
- server
Group StringType - Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
- servers List<Property Map>
- status String
- Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
- sticky
Session Property MapConfig - Session persistence parameter information.
- List<Property Map>
- update
Time String - Last operation time of the backend server group.
- vpc
Id String - ID of the VPC to which the backend server group belongs.
Supporting Types
ServerGroupHealthCheck, ServerGroupHealthCheckArgs
- Domain string
- The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
- Enabled string
- Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
- Healthy
Threshold int - Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
- Http
Code string - HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
- Http
Version string - HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
- Interval int
- After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
- Method string
- After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
- Port int
- Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- Protocol string
- Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
- Timeout int
- Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
- Unhealthy
Threshold int - Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
- Uri string
- Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
- Domain string
- The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
- Enabled string
- Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
- Healthy
Threshold int - Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
- Http
Code string - HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
- Http
Version string - HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
- Interval int
- After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
- Method string
- After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
- Port int
- Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- Protocol string
- Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
- Timeout int
- Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
- Unhealthy
Threshold int - Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
- Uri string
- Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
- domain String
- The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
- enabled String
- Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
- healthy
Threshold Integer - Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
- http
Code String - HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
- http
Version String - HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
- interval Integer
- After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
- method String
- After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
- port Integer
- Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- protocol String
- Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
- timeout Integer
- Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
- unhealthy
Threshold Integer - Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
- uri String
- Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
- domain string
- The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
- enabled string
- Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
- healthy
Threshold number - Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
- http
Code string - HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
- http
Version string - HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
- interval number
- After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
- method string
- After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
- port number
- Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- protocol string
- Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
- timeout number
- Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
- unhealthy
Threshold number - Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
- uri string
- Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
- domain str
- The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
- enabled str
- Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
- healthy_
threshold int - Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
- http_
code str - HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
- http_
version str - HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
- interval int
- After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
- method str
- After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
- port int
- Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- protocol str
- Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
- timeout int
- Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
- unhealthy_
threshold int - Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
- uri str
- Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
- domain String
- The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
- enabled String
- Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
- healthy
Threshold Number - Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
- http
Code String - HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
- http
Version String - HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
- interval Number
- After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
- method String
- After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
- port Number
- Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- protocol String
- Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
- timeout Number
- Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
- unhealthy
Threshold Number - Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
- uri String
- Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
ServerGroupListener, ServerGroupListenerArgs
- Listener
Id string - Listener ID.
- Listener
Id string - Listener ID.
- listener
Id String - Listener ID.
- listener
Id string - Listener ID.
- listener_
id str - Listener ID.
- listener
Id String - Listener ID.
ServerGroupServer, ServerGroupServerArgs
- Description string
- Description of the backend server.
- Instance
Id string - ID of the cloud server instance or network interface.
- Ip string
- Private IP address of the backend server.
- Port int
- Port number on which the backend server receives requests.
- Remote
Enabled string - Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
- Server
Id string - Backend server ID.
- Type string
- Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
- Weight int
- Backend server weight.
- Description string
- Description of the backend server.
- Instance
Id string - ID of the cloud server instance or network interface.
- Ip string
- Private IP address of the backend server.
- Port int
- Port number on which the backend server receives requests.
- Remote
Enabled string - Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
- Server
Id string - Backend server ID.
- Type string
- Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
- Weight int
- Backend server weight.
- description String
- Description of the backend server.
- instance
Id String - ID of the cloud server instance or network interface.
- ip String
- Private IP address of the backend server.
- port Integer
- Port number on which the backend server receives requests.
- remote
Enabled String - Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
- server
Id String - Backend server ID.
- type String
- Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
- weight Integer
- Backend server weight.
- description string
- Description of the backend server.
- instance
Id string - ID of the cloud server instance or network interface.
- ip string
- Private IP address of the backend server.
- port number
- Port number on which the backend server receives requests.
- remote
Enabled string - Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
- server
Id string - Backend server ID.
- type string
- Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
- weight number
- Backend server weight.
- description str
- Description of the backend server.
- instance_
id str - ID of the cloud server instance or network interface.
- ip str
- Private IP address of the backend server.
- port int
- Port number on which the backend server receives requests.
- remote_
enabled str - Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
- server_
id str - Backend server ID.
- type str
- Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
- weight int
- Backend server weight.
- description String
- Description of the backend server.
- instance
Id String - ID of the cloud server instance or network interface.
- ip String
- Private IP address of the backend server.
- port Number
- Port number on which the backend server receives requests.
- remote
Enabled String - Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
- server
Id String - Backend server ID.
- type String
- Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
- weight Number
- Backend server weight.
ServerGroupStickySessionConfig, ServerGroupStickySessionConfigArgs
- string
- Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
- int
- Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
- Sticky
Session stringEnabled - Enable session persistence. on: Enable; off (default): Disable.
- Sticky
Session stringType - Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
- string
- Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
- int
- Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
- Sticky
Session stringEnabled - Enable session persistence. on: Enable; off (default): Disable.
- Sticky
Session stringType - Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
- String
- Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
- Integer
- Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
- sticky
Session StringEnabled - Enable session persistence. on: Enable; off (default): Disable.
- sticky
Session StringType - Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
- string
- Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
- number
- Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
- sticky
Session stringEnabled - Enable session persistence. on: Enable; off (default): Disable.
- sticky
Session stringType - Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
- str
- Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
- int
- Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
- sticky_
session_ strenabled - Enable session persistence. on: Enable; off (default): Disable.
- sticky_
session_ strtype - Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
- String
- Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
- Number
- Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
- sticky
Session StringEnabled - Enable session persistence. on: Enable; off (default): Disable.
- sticky
Session StringType - Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
ServerGroupTag, ServerGroupTagArgs
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
volcengineccTerraform Provider.
published on Thursday, May 7, 2026 by Volcengine
