Docs Home
alicloud.gwlb.ServerGroup
Explore with Pulumi AI
Provides a GWLB Server Group resource.
For information about GWLB Server Group and how to use it, see What is Server Group.
NOTE: Available since v1.234.0.
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,
connection_drain_config: Optional[ServerGroupConnectionDrainConfigArgs] = None,
dry_run: Optional[bool] = None,
health_check_config: Optional[ServerGroupHealthCheckConfigArgs] = None,
protocol: Optional[str] = None,
resource_group_id: Optional[str] = None,
scheduler: Optional[str] = None,
server_group_name: Optional[str] = None,
server_group_type: Optional[str] = None,
servers: Optional[Sequence[ServerGroupServerArgs]] = None,
tags: Optional[Mapping[str, 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: alicloud:gwlb: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 alicloudServerGroupResource = new AliCloud.Gwlb.ServerGroup("alicloudServerGroupResource", new()
{
VpcId = "string",
ConnectionDrainConfig = new AliCloud.Gwlb.Inputs.ServerGroupConnectionDrainConfigArgs
{
ConnectionDrainEnabled = false,
ConnectionDrainTimeout = 0,
},
DryRun = false,
HealthCheckConfig = new AliCloud.Gwlb.Inputs.ServerGroupHealthCheckConfigArgs
{
HealthCheckConnectPort = 0,
HealthCheckConnectTimeout = 0,
HealthCheckDomain = "string",
HealthCheckEnabled = false,
HealthCheckHttpCodes = new[]
{
"string",
},
HealthCheckInterval = 0,
HealthCheckPath = "string",
HealthCheckProtocol = "string",
HealthyThreshold = 0,
UnhealthyThreshold = 0,
},
Protocol = "string",
ResourceGroupId = "string",
Scheduler = "string",
ServerGroupName = "string",
ServerGroupType = "string",
Servers = new[]
{
new AliCloud.Gwlb.Inputs.ServerGroupServerArgs
{
ServerId = "string",
ServerType = "string",
Port = 0,
ServerGroupId = "string",
ServerIp = "string",
Status = "string",
},
},
Tags =
{
{ "string", "string" },
},
});
example, err := gwlb.NewServerGroup(ctx, "alicloudServerGroupResource", &gwlb.ServerGroupArgs{
VpcId: pulumi.String("string"),
ConnectionDrainConfig: &gwlb.ServerGroupConnectionDrainConfigArgs{
ConnectionDrainEnabled: pulumi.Bool(false),
ConnectionDrainTimeout: pulumi.Int(0),
},
DryRun: pulumi.Bool(false),
HealthCheckConfig: &gwlb.ServerGroupHealthCheckConfigArgs{
HealthCheckConnectPort: pulumi.Int(0),
HealthCheckConnectTimeout: pulumi.Int(0),
HealthCheckDomain: pulumi.String("string"),
HealthCheckEnabled: pulumi.Bool(false),
HealthCheckHttpCodes: pulumi.StringArray{
pulumi.String("string"),
},
HealthCheckInterval: pulumi.Int(0),
HealthCheckPath: pulumi.String("string"),
HealthCheckProtocol: pulumi.String("string"),
HealthyThreshold: pulumi.Int(0),
UnhealthyThreshold: pulumi.Int(0),
},
Protocol: pulumi.String("string"),
ResourceGroupId: pulumi.String("string"),
Scheduler: pulumi.String("string"),
ServerGroupName: pulumi.String("string"),
ServerGroupType: pulumi.String("string"),
Servers: gwlb.ServerGroupServerArray{
&gwlb.ServerGroupServerArgs{
ServerId: pulumi.String("string"),
ServerType: pulumi.String("string"),
Port: pulumi.Int(0),
ServerGroupId: pulumi.String("string"),
ServerIp: pulumi.String("string"),
Status: pulumi.String("string"),
},
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var alicloudServerGroupResource = new ServerGroup("alicloudServerGroupResource", ServerGroupArgs.builder()
.vpcId("string")
.connectionDrainConfig(ServerGroupConnectionDrainConfigArgs.builder()
.connectionDrainEnabled(false)
.connectionDrainTimeout(0)
.build())
.dryRun(false)
.healthCheckConfig(ServerGroupHealthCheckConfigArgs.builder()
.healthCheckConnectPort(0)
.healthCheckConnectTimeout(0)
.healthCheckDomain("string")
.healthCheckEnabled(false)
.healthCheckHttpCodes("string")
.healthCheckInterval(0)
.healthCheckPath("string")
.healthCheckProtocol("string")
.healthyThreshold(0)
.unhealthyThreshold(0)
.build())
.protocol("string")
.resourceGroupId("string")
.scheduler("string")
.serverGroupName("string")
.serverGroupType("string")
.servers(ServerGroupServerArgs.builder()
.serverId("string")
.serverType("string")
.port(0)
.serverGroupId("string")
.serverIp("string")
.status("string")
.build())
.tags(Map.of("string", "string"))
.build());
alicloud_server_group_resource = alicloud.gwlb.ServerGroup("alicloudServerGroupResource",
vpc_id="string",
connection_drain_config={
"connection_drain_enabled": False,
"connection_drain_timeout": 0,
},
dry_run=False,
health_check_config={
"health_check_connect_port": 0,
"health_check_connect_timeout": 0,
"health_check_domain": "string",
"health_check_enabled": False,
"health_check_http_codes": ["string"],
"health_check_interval": 0,
"health_check_path": "string",
"health_check_protocol": "string",
"healthy_threshold": 0,
"unhealthy_threshold": 0,
},
protocol="string",
resource_group_id="string",
scheduler="string",
server_group_name="string",
server_group_type="string",
servers=[{
"server_id": "string",
"server_type": "string",
"port": 0,
"server_group_id": "string",
"server_ip": "string",
"status": "string",
}],
tags={
"string": "string",
})
const alicloudServerGroupResource = new alicloud.gwlb.ServerGroup("alicloudServerGroupResource", {
vpcId: "string",
connectionDrainConfig: {
connectionDrainEnabled: false,
connectionDrainTimeout: 0,
},
dryRun: false,
healthCheckConfig: {
healthCheckConnectPort: 0,
healthCheckConnectTimeout: 0,
healthCheckDomain: "string",
healthCheckEnabled: false,
healthCheckHttpCodes: ["string"],
healthCheckInterval: 0,
healthCheckPath: "string",
healthCheckProtocol: "string",
healthyThreshold: 0,
unhealthyThreshold: 0,
},
protocol: "string",
resourceGroupId: "string",
scheduler: "string",
serverGroupName: "string",
serverGroupType: "string",
servers: [{
serverId: "string",
serverType: "string",
port: 0,
serverGroupId: "string",
serverIp: "string",
status: "string",
}],
tags: {
string: "string",
},
});
type: alicloud:gwlb:ServerGroup
properties:
connectionDrainConfig:
connectionDrainEnabled: false
connectionDrainTimeout: 0
dryRun: false
healthCheckConfig:
healthCheckConnectPort: 0
healthCheckConnectTimeout: 0
healthCheckDomain: string
healthCheckEnabled: false
healthCheckHttpCodes:
- string
healthCheckInterval: 0
healthCheckPath: string
healthCheckProtocol: string
healthyThreshold: 0
unhealthyThreshold: 0
protocol: string
resourceGroupId: string
scheduler: string
serverGroupName: string
serverGroupType: string
servers:
- port: 0
serverGroupId: string
serverId: string
serverIp: string
serverType: string
status: string
tags:
string: 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 The VPC instance ID.
NOTE: If the value of ServerGroupType is Instance, only servers in the VPC can be added to the server group.
- Connection
Drain Pulumi.Config Ali Cloud. Gwlb. Inputs. Server Group Connection Drain Config - Connected graceful interrupt configuration. See
connection_drain_configbelow. - Dry
Run bool - Specifies whether to perform only a dry run, without performing the actual request.
- Health
Check Pulumi.Config Ali Cloud. Gwlb. Inputs. Server Group Health Check Config - Health check configurations. See
health_check_configbelow. - Protocol string
- Backend Protocol. Value:
- *GENEVE (default)**.
- Resource
Group stringId - The ID of the resource group.
- Scheduler string
- Scheduling algorithm. Value:
- 5TCH (default): quintuple hash, which is based on the consistent hash of the quintuple (source IP, Destination IP, source port, destination port, and protocol). The same flow is scheduled to the same backend server.
3TCH: a three-tuple hash, which is based on the consistent hash of three tuples (source IP address, destination IP address, and protocol). The same flow is dispatched to the same backend server.2TCH: Binary Group hash, which is based on the consistent hash of the binary group (source IP and destination IP). The same flow is scheduled to the same backend server.
- Server
Group stringName The server group name.
It must be 2 to 128 characters in length, start with an uppercase letter or a Chinese character, and can contain digits, half-width periods (.), underscores (_), and dashes (-).
- Server
Group stringType - The server group type. Value:
- Instance (default): The instance type. You can add Ecs, Eni, and Eci instances to the server group.
Ip: The Ip address type. You can directly add backend servers of the Ip address type to the server group.
- Servers
List<Pulumi.
Ali Cloud. Gwlb. Inputs. Server Group Server> - List of servers. See
serversbelow. - Dictionary<string, string>
- List of resource tags.
- Vpc
Id string The VPC instance ID.
NOTE: If the value of ServerGroupType is Instance, only servers in the VPC can be added to the server group.
- Connection
Drain ServerConfig Group Connection Drain Config Args - Connected graceful interrupt configuration. See
connection_drain_configbelow. - Dry
Run bool - Specifies whether to perform only a dry run, without performing the actual request.
- Health
Check ServerConfig Group Health Check Config Args - Health check configurations. See
health_check_configbelow. - Protocol string
- Backend Protocol. Value:
- *GENEVE (default)**.
- Resource
Group stringId - The ID of the resource group.
- Scheduler string
- Scheduling algorithm. Value:
- 5TCH (default): quintuple hash, which is based on the consistent hash of the quintuple (source IP, Destination IP, source port, destination port, and protocol). The same flow is scheduled to the same backend server.
3TCH: a three-tuple hash, which is based on the consistent hash of three tuples (source IP address, destination IP address, and protocol). The same flow is dispatched to the same backend server.2TCH: Binary Group hash, which is based on the consistent hash of the binary group (source IP and destination IP). The same flow is scheduled to the same backend server.
- Server
Group stringName The server group name.
It must be 2 to 128 characters in length, start with an uppercase letter or a Chinese character, and can contain digits, half-width periods (.), underscores (_), and dashes (-).
- Server
Group stringType - The server group type. Value:
- Instance (default): The instance type. You can add Ecs, Eni, and Eci instances to the server group.
Ip: The Ip address type. You can directly add backend servers of the Ip address type to the server group.
- Servers
[]Server
Group Server Args - List of servers. See
serversbelow. - map[string]string
- List of resource tags.
- vpc
Id String The VPC instance ID.
NOTE: If the value of ServerGroupType is Instance, only servers in the VPC can be added to the server group.
- connection
Drain ServerConfig Group Connection Drain Config - Connected graceful interrupt configuration. See
connection_drain_configbelow. - dry
Run Boolean - Specifies whether to perform only a dry run, without performing the actual request.
- health
Check ServerConfig Group Health Check Config - Health check configurations. See
health_check_configbelow. - protocol String
- Backend Protocol. Value:
- *GENEVE (default)**.
- resource
Group StringId - The ID of the resource group.
- scheduler String
- Scheduling algorithm. Value:
- 5TCH (default): quintuple hash, which is based on the consistent hash of the quintuple (source IP, Destination IP, source port, destination port, and protocol). The same flow is scheduled to the same backend server.
3TCH: a three-tuple hash, which is based on the consistent hash of three tuples (source IP address, destination IP address, and protocol). The same flow is dispatched to the same backend server.2TCH: Binary Group hash, which is based on the consistent hash of the binary group (source IP and destination IP). The same flow is scheduled to the same backend server.
- server
Group StringName The server group name.
It must be 2 to 128 characters in length, start with an uppercase letter or a Chinese character, and can contain digits, half-width periods (.), underscores (_), and dashes (-).
- server
Group StringType - The server group type. Value:
- Instance (default): The instance type. You can add Ecs, Eni, and Eci instances to the server group.
Ip: The Ip address type. You can directly add backend servers of the Ip address type to the server group.
- servers
List<Server
Group Server> - List of servers. See
serversbelow. - Map<String,String>
- List of resource tags.
- vpc
Id string The VPC instance ID.
NOTE: If the value of ServerGroupType is Instance, only servers in the VPC can be added to the server group.
- connection
Drain ServerConfig Group Connection Drain Config - Connected graceful interrupt configuration. See
connection_drain_configbelow. - dry
Run boolean - Specifies whether to perform only a dry run, without performing the actual request.
- health
Check ServerConfig Group Health Check Config - Health check configurations. See
health_check_configbelow. - protocol string
- Backend Protocol. Value:
- *GENEVE (default)**.
- resource
Group stringId - The ID of the resource group.
- scheduler string
- Scheduling algorithm. Value:
- 5TCH (default): quintuple hash, which is based on the consistent hash of the quintuple (source IP, Destination IP, source port, destination port, and protocol). The same flow is scheduled to the same backend server.
3TCH: a three-tuple hash, which is based on the consistent hash of three tuples (source IP address, destination IP address, and protocol). The same flow is dispatched to the same backend server.2TCH: Binary Group hash, which is based on the consistent hash of the binary group (source IP and destination IP). The same flow is scheduled to the same backend server.
- server
Group stringName The server group name.
It must be 2 to 128 characters in length, start with an uppercase letter or a Chinese character, and can contain digits, half-width periods (.), underscores (_), and dashes (-).
- server
Group stringType - The server group type. Value:
- Instance (default): The instance type. You can add Ecs, Eni, and Eci instances to the server group.
Ip: The Ip address type. You can directly add backend servers of the Ip address type to the server group.
- servers
Server
Group Server[] - List of servers. See
serversbelow. - {[key: string]: string}
- List of resource tags.
- vpc_
id str The VPC instance ID.
NOTE: If the value of ServerGroupType is Instance, only servers in the VPC can be added to the server group.
- connection_
drain_ Serverconfig Group Connection Drain Config Args - Connected graceful interrupt configuration. See
connection_drain_configbelow. - dry_
run bool - Specifies whether to perform only a dry run, without performing the actual request.
- health_
check_ Serverconfig Group Health Check Config Args - Health check configurations. See
health_check_configbelow. - protocol str
- Backend Protocol. Value:
- *GENEVE (default)**.
- resource_
group_ strid - The ID of the resource group.
- scheduler str
- Scheduling algorithm. Value:
- 5TCH (default): quintuple hash, which is based on the consistent hash of the quintuple (source IP, Destination IP, source port, destination port, and protocol). The same flow is scheduled to the same backend server.
3TCH: a three-tuple hash, which is based on the consistent hash of three tuples (source IP address, destination IP address, and protocol). The same flow is dispatched to the same backend server.2TCH: Binary Group hash, which is based on the consistent hash of the binary group (source IP and destination IP). The same flow is scheduled to the same backend server.
- server_
group_ strname The server group name.
It must be 2 to 128 characters in length, start with an uppercase letter or a Chinese character, and can contain digits, half-width periods (.), underscores (_), and dashes (-).
- server_
group_ strtype - The server group type. Value:
- Instance (default): The instance type. You can add Ecs, Eni, and Eci instances to the server group.
Ip: The Ip address type. You can directly add backend servers of the Ip address type to the server group.
- servers
Sequence[Server
Group Server Args] - List of servers. See
serversbelow. - Mapping[str, str]
- List of resource tags.
- vpc
Id String The VPC instance ID.
NOTE: If the value of ServerGroupType is Instance, only servers in the VPC can be added to the server group.
- connection
Drain Property MapConfig - Connected graceful interrupt configuration. See
connection_drain_configbelow. - dry
Run Boolean - Specifies whether to perform only a dry run, without performing the actual request.
- health
Check Property MapConfig - Health check configurations. See
health_check_configbelow. - protocol String
- Backend Protocol. Value:
- *GENEVE (default)**.
- resource
Group StringId - The ID of the resource group.
- scheduler String
- Scheduling algorithm. Value:
- 5TCH (default): quintuple hash, which is based on the consistent hash of the quintuple (source IP, Destination IP, source port, destination port, and protocol). The same flow is scheduled to the same backend server.
3TCH: a three-tuple hash, which is based on the consistent hash of three tuples (source IP address, destination IP address, and protocol). The same flow is dispatched to the same backend server.2TCH: Binary Group hash, which is based on the consistent hash of the binary group (source IP and destination IP). The same flow is scheduled to the same backend server.
- server
Group StringName The server group name.
It must be 2 to 128 characters in length, start with an uppercase letter or a Chinese character, and can contain digits, half-width periods (.), underscores (_), and dashes (-).
- server
Group StringType - The server group type. Value:
- Instance (default): The instance type. You can add Ecs, Eni, and Eci instances to the server group.
Ip: The Ip address type. You can directly add backend servers of the Ip address type to the server group.
- servers List<Property Map>
- List of servers. See
serversbelow. - Map<String>
- List of resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the ServerGroup resource produces the following output properties:
- Create
Time string - The creation time of the server group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- Server group status. Value:
- Create
Time string - The creation time of the server group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- Server group status. Value:
- create
Time String - The creation time of the server group.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- Server group status. Value:
- create
Time string - The creation time of the server group.
- id string
- The provider-assigned unique ID for this managed resource.
- status string
- Server group status. Value:
- create_
time str - The creation time of the server group.
- id str
- The provider-assigned unique ID for this managed resource.
- status str
- Server group status. Value:
- create
Time String - The creation time of the server group.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- Server group status. Value:
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,
connection_drain_config: Optional[ServerGroupConnectionDrainConfigArgs] = None,
create_time: Optional[str] = None,
dry_run: Optional[bool] = None,
health_check_config: Optional[ServerGroupHealthCheckConfigArgs] = None,
protocol: Optional[str] = None,
resource_group_id: Optional[str] = None,
scheduler: Optional[str] = None,
server_group_name: Optional[str] = None,
server_group_type: Optional[str] = None,
servers: Optional[Sequence[ServerGroupServerArgs]] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, 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)Resource lookup is not supported in YAML- 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.
- Connection
Drain Pulumi.Config Ali Cloud. Gwlb. Inputs. Server Group Connection Drain Config - Connected graceful interrupt configuration. See
connection_drain_configbelow. - Create
Time string - The creation time of the server group.
- Dry
Run bool - Specifies whether to perform only a dry run, without performing the actual request.
- Health
Check Pulumi.Config Ali Cloud. Gwlb. Inputs. Server Group Health Check Config - Health check configurations. See
health_check_configbelow. - Protocol string
- Backend Protocol. Value:
- *GENEVE (default)**.
- Resource
Group stringId - The ID of the resource group.
- Scheduler string
- Scheduling algorithm. Value:
- 5TCH (default): quintuple hash, which is based on the consistent hash of the quintuple (source IP, Destination IP, source port, destination port, and protocol). The same flow is scheduled to the same backend server.
3TCH: a three-tuple hash, which is based on the consistent hash of three tuples (source IP address, destination IP address, and protocol). The same flow is dispatched to the same backend server.2TCH: Binary Group hash, which is based on the consistent hash of the binary group (source IP and destination IP). The same flow is scheduled to the same backend server.
- Server
Group stringName The server group name.
It must be 2 to 128 characters in length, start with an uppercase letter or a Chinese character, and can contain digits, half-width periods (.), underscores (_), and dashes (-).
- Server
Group stringType - The server group type. Value:
- Instance (default): The instance type. You can add Ecs, Eni, and Eci instances to the server group.
Ip: The Ip address type. You can directly add backend servers of the Ip address type to the server group.
- Servers
List<Pulumi.
Ali Cloud. Gwlb. Inputs. Server Group Server> - List of servers. See
serversbelow. - Status string
- Server group status. Value:
- Dictionary<string, string>
- List of resource tags.
- Vpc
Id string The VPC instance ID.
NOTE: If the value of ServerGroupType is Instance, only servers in the VPC can be added to the server group.
- Connection
Drain ServerConfig Group Connection Drain Config Args - Connected graceful interrupt configuration. See
connection_drain_configbelow. - Create
Time string - The creation time of the server group.
- Dry
Run bool - Specifies whether to perform only a dry run, without performing the actual request.
- Health
Check ServerConfig Group Health Check Config Args - Health check configurations. See
health_check_configbelow. - Protocol string
- Backend Protocol. Value:
- *GENEVE (default)**.
- Resource
Group stringId - The ID of the resource group.
- Scheduler string
- Scheduling algorithm. Value:
- 5TCH (default): quintuple hash, which is based on the consistent hash of the quintuple (source IP, Destination IP, source port, destination port, and protocol). The same flow is scheduled to the same backend server.
3TCH: a three-tuple hash, which is based on the consistent hash of three tuples (source IP address, destination IP address, and protocol). The same flow is dispatched to the same backend server.2TCH: Binary Group hash, which is based on the consistent hash of the binary group (source IP and destination IP). The same flow is scheduled to the same backend server.
- Server
Group stringName The server group name.
It must be 2 to 128 characters in length, start with an uppercase letter or a Chinese character, and can contain digits, half-width periods (.), underscores (_), and dashes (-).
- Server
Group stringType - The server group type. Value:
- Instance (default): The instance type. You can add Ecs, Eni, and Eci instances to the server group.
Ip: The Ip address type. You can directly add backend servers of the Ip address type to the server group.
- Servers
[]Server
Group Server Args - List of servers. See
serversbelow. - Status string
- Server group status. Value:
- map[string]string
- List of resource tags.
- Vpc
Id string The VPC instance ID.
NOTE: If the value of ServerGroupType is Instance, only servers in the VPC can be added to the server group.
- connection
Drain ServerConfig Group Connection Drain Config - Connected graceful interrupt configuration. See
connection_drain_configbelow. - create
Time String - The creation time of the server group.
- dry
Run Boolean - Specifies whether to perform only a dry run, without performing the actual request.
- health
Check ServerConfig Group Health Check Config - Health check configurations. See
health_check_configbelow. - protocol String
- Backend Protocol. Value:
- *GENEVE (default)**.
- resource
Group StringId - The ID of the resource group.
- scheduler String
- Scheduling algorithm. Value:
- 5TCH (default): quintuple hash, which is based on the consistent hash of the quintuple (source IP, Destination IP, source port, destination port, and protocol). The same flow is scheduled to the same backend server.
3TCH: a three-tuple hash, which is based on the consistent hash of three tuples (source IP address, destination IP address, and protocol). The same flow is dispatched to the same backend server.2TCH: Binary Group hash, which is based on the consistent hash of the binary group (source IP and destination IP). The same flow is scheduled to the same backend server.
- server
Group StringName The server group name.
It must be 2 to 128 characters in length, start with an uppercase letter or a Chinese character, and can contain digits, half-width periods (.), underscores (_), and dashes (-).
- server
Group StringType - The server group type. Value:
- Instance (default): The instance type. You can add Ecs, Eni, and Eci instances to the server group.
Ip: The Ip address type. You can directly add backend servers of the Ip address type to the server group.
- servers
List<Server
Group Server> - List of servers. See
serversbelow. - status String
- Server group status. Value:
- Map<String,String>
- List of resource tags.
- vpc
Id String The VPC instance ID.
NOTE: If the value of ServerGroupType is Instance, only servers in the VPC can be added to the server group.
- connection
Drain ServerConfig Group Connection Drain Config - Connected graceful interrupt configuration. See
connection_drain_configbelow. - create
Time string - The creation time of the server group.
- dry
Run boolean - Specifies whether to perform only a dry run, without performing the actual request.
- health
Check ServerConfig Group Health Check Config - Health check configurations. See
health_check_configbelow. - protocol string
- Backend Protocol. Value:
- *GENEVE (default)**.
- resource
Group stringId - The ID of the resource group.
- scheduler string
- Scheduling algorithm. Value:
- 5TCH (default): quintuple hash, which is based on the consistent hash of the quintuple (source IP, Destination IP, source port, destination port, and protocol). The same flow is scheduled to the same backend server.
3TCH: a three-tuple hash, which is based on the consistent hash of three tuples (source IP address, destination IP address, and protocol). The same flow is dispatched to the same backend server.2TCH: Binary Group hash, which is based on the consistent hash of the binary group (source IP and destination IP). The same flow is scheduled to the same backend server.
- server
Group stringName The server group name.
It must be 2 to 128 characters in length, start with an uppercase letter or a Chinese character, and can contain digits, half-width periods (.), underscores (_), and dashes (-).
- server
Group stringType - The server group type. Value:
- Instance (default): The instance type. You can add Ecs, Eni, and Eci instances to the server group.
Ip: The Ip address type. You can directly add backend servers of the Ip address type to the server group.
- servers
Server
Group Server[] - List of servers. See
serversbelow. - status string
- Server group status. Value:
- {[key: string]: string}
- List of resource tags.
- vpc
Id string The VPC instance ID.
NOTE: If the value of ServerGroupType is Instance, only servers in the VPC can be added to the server group.
- connection_
drain_ Serverconfig Group Connection Drain Config Args - Connected graceful interrupt configuration. See
connection_drain_configbelow. - create_
time str - The creation time of the server group.
- dry_
run bool - Specifies whether to perform only a dry run, without performing the actual request.
- health_
check_ Serverconfig Group Health Check Config Args - Health check configurations. See
health_check_configbelow. - protocol str
- Backend Protocol. Value:
- *GENEVE (default)**.
- resource_
group_ strid - The ID of the resource group.
- scheduler str
- Scheduling algorithm. Value:
- 5TCH (default): quintuple hash, which is based on the consistent hash of the quintuple (source IP, Destination IP, source port, destination port, and protocol). The same flow is scheduled to the same backend server.
3TCH: a three-tuple hash, which is based on the consistent hash of three tuples (source IP address, destination IP address, and protocol). The same flow is dispatched to the same backend server.2TCH: Binary Group hash, which is based on the consistent hash of the binary group (source IP and destination IP). The same flow is scheduled to the same backend server.
- server_
group_ strname The server group name.
It must be 2 to 128 characters in length, start with an uppercase letter or a Chinese character, and can contain digits, half-width periods (.), underscores (_), and dashes (-).
- server_
group_ strtype - The server group type. Value:
- Instance (default): The instance type. You can add Ecs, Eni, and Eci instances to the server group.
Ip: The Ip address type. You can directly add backend servers of the Ip address type to the server group.
- servers
Sequence[Server
Group Server Args] - List of servers. See
serversbelow. - status str
- Server group status. Value:
- Mapping[str, str]
- List of resource tags.
- vpc_
id str The VPC instance ID.
NOTE: If the value of ServerGroupType is Instance, only servers in the VPC can be added to the server group.
- connection
Drain Property MapConfig - Connected graceful interrupt configuration. See
connection_drain_configbelow. - create
Time String - The creation time of the server group.
- dry
Run Boolean - Specifies whether to perform only a dry run, without performing the actual request.
- health
Check Property MapConfig - Health check configurations. See
health_check_configbelow. - protocol String
- Backend Protocol. Value:
- *GENEVE (default)**.
- resource
Group StringId - The ID of the resource group.
- scheduler String
- Scheduling algorithm. Value:
- 5TCH (default): quintuple hash, which is based on the consistent hash of the quintuple (source IP, Destination IP, source port, destination port, and protocol). The same flow is scheduled to the same backend server.
3TCH: a three-tuple hash, which is based on the consistent hash of three tuples (source IP address, destination IP address, and protocol). The same flow is dispatched to the same backend server.2TCH: Binary Group hash, which is based on the consistent hash of the binary group (source IP and destination IP). The same flow is scheduled to the same backend server.
- server
Group StringName The server group name.
It must be 2 to 128 characters in length, start with an uppercase letter or a Chinese character, and can contain digits, half-width periods (.), underscores (_), and dashes (-).
- server
Group StringType - The server group type. Value:
- Instance (default): The instance type. You can add Ecs, Eni, and Eci instances to the server group.
Ip: The Ip address type. You can directly add backend servers of the Ip address type to the server group.
- servers List<Property Map>
- List of servers. See
serversbelow. - status String
- Server group status. Value:
- Map<String>
- List of resource tags.
- vpc
Id String The VPC instance ID.
NOTE: If the value of ServerGroupType is Instance, only servers in the VPC can be added to the server group.
Supporting Types
ServerGroupConnectionDrainConfig, ServerGroupConnectionDrainConfigArgs
- Connection
Drain boolEnabled - Whether to open the connection graceful interrupt. Value:
- Connection
Drain intTimeout Connection Grace interrupt timeout.
Unit: seconds.
Value range: 1~3600.
- Connection
Drain boolEnabled - Whether to open the connection graceful interrupt. Value:
- Connection
Drain intTimeout Connection Grace interrupt timeout.
Unit: seconds.
Value range: 1~3600.
- connection
Drain BooleanEnabled - Whether to open the connection graceful interrupt. Value:
- connection
Drain IntegerTimeout Connection Grace interrupt timeout.
Unit: seconds.
Value range: 1~3600.
- connection
Drain booleanEnabled - Whether to open the connection graceful interrupt. Value:
- connection
Drain numberTimeout Connection Grace interrupt timeout.
Unit: seconds.
Value range: 1~3600.
- connection_
drain_ boolenabled - Whether to open the connection graceful interrupt. Value:
- connection_
drain_ inttimeout Connection Grace interrupt timeout.
Unit: seconds.
Value range: 1~3600.
- connection
Drain BooleanEnabled - Whether to open the connection graceful interrupt. Value:
- connection
Drain NumberTimeout Connection Grace interrupt timeout.
Unit: seconds.
Value range: 1~3600.
ServerGroupHealthCheckConfig, ServerGroupHealthCheckConfigArgs
- Health
Check intConnect Port The port of the backend server used for health check.
Value range: 1 to 65535.
Default value:
80.- Health
Check intConnect Timeout The maximum timeout period for health check responses.
Unit: seconds.
Value range: 1 to 300.
Default value:
5.- Health
Check stringDomain - The domain name used for health checks. Value:
- $SERVER_IP (default): Use the internal IP address of the backend server.
- Health
Check boolEnabled - Whether to enable health check. Value:
- true (default): enabled.
- Health
Check List<string>Http Codes - Health status return code list.
- Health
Check intInterval The time interval of the health check.
Unit: seconds.
Value range: 1~50.
Default value:
10.- Health
Check stringPath Health check path.
It can be 1 to 80 characters in length and can only use upper and lower case letters, digits, dashes (-), forward slashes (/), half-width periods (.), percent signs (%), and half-width question marks (?), Pound sign (#) and and(&) and extended character set_;~! ()*[]@$^: ',+ =
Must start with a forward slash (/).
NOTE: This parameter takes effect only when the HealthCheckProtocol is HTTP.
- Health
Check stringProtocol - Health check protocol, value:
TCP(default): Sends a SYN handshake packet to check whether the server port is alive.HTTP: Sends a GET request to simulate the access behavior of the browser to check whether the server application is healthy.
- Healthy
Threshold int After the number of consecutive successful health checks, the health check status of the backend server is determined as successful from failed.
Value range: 2 to 10.
Default value:
2.- Unhealthy
Threshold int The number of consecutive failed health checks that determine the health check status of the backend server from success to failure.
Value range: 2 to 10.
Default value:
2.
- Health
Check intConnect Port The port of the backend server used for health check.
Value range: 1 to 65535.
Default value:
80.- Health
Check intConnect Timeout The maximum timeout period for health check responses.
Unit: seconds.
Value range: 1 to 300.
Default value:
5.- Health
Check stringDomain - The domain name used for health checks. Value:
- $SERVER_IP (default): Use the internal IP address of the backend server.
- Health
Check boolEnabled - Whether to enable health check. Value:
- true (default): enabled.
- Health
Check []stringHttp Codes - Health status return code list.
- Health
Check intInterval The time interval of the health check.
Unit: seconds.
Value range: 1~50.
Default value:
10.- Health
Check stringPath Health check path.
It can be 1 to 80 characters in length and can only use upper and lower case letters, digits, dashes (-), forward slashes (/), half-width periods (.), percent signs (%), and half-width question marks (?), Pound sign (#) and and(&) and extended character set_;~! ()*[]@$^: ',+ =
Must start with a forward slash (/).
NOTE: This parameter takes effect only when the HealthCheckProtocol is HTTP.
- Health
Check stringProtocol - Health check protocol, value:
TCP(default): Sends a SYN handshake packet to check whether the server port is alive.HTTP: Sends a GET request to simulate the access behavior of the browser to check whether the server application is healthy.
- Healthy
Threshold int After the number of consecutive successful health checks, the health check status of the backend server is determined as successful from failed.
Value range: 2 to 10.
Default value:
2.- Unhealthy
Threshold int The number of consecutive failed health checks that determine the health check status of the backend server from success to failure.
Value range: 2 to 10.
Default value:
2.
- health
Check IntegerConnect Port The port of the backend server used for health check.
Value range: 1 to 65535.
Default value:
80.- health
Check IntegerConnect Timeout The maximum timeout period for health check responses.
Unit: seconds.
Value range: 1 to 300.
Default value:
5.- health
Check StringDomain - The domain name used for health checks. Value:
- $SERVER_IP (default): Use the internal IP address of the backend server.
- health
Check BooleanEnabled - Whether to enable health check. Value:
- true (default): enabled.
- health
Check List<String>Http Codes - Health status return code list.
- health
Check IntegerInterval The time interval of the health check.
Unit: seconds.
Value range: 1~50.
Default value:
10.- health
Check StringPath Health check path.
It can be 1 to 80 characters in length and can only use upper and lower case letters, digits, dashes (-), forward slashes (/), half-width periods (.), percent signs (%), and half-width question marks (?), Pound sign (#) and and(&) and extended character set_;~! ()*[]@$^: ',+ =
Must start with a forward slash (/).
NOTE: This parameter takes effect only when the HealthCheckProtocol is HTTP.
- health
Check StringProtocol - Health check protocol, value:
TCP(default): Sends a SYN handshake packet to check whether the server port is alive.HTTP: Sends a GET request to simulate the access behavior of the browser to check whether the server application is healthy.
- healthy
Threshold Integer After the number of consecutive successful health checks, the health check status of the backend server is determined as successful from failed.
Value range: 2 to 10.
Default value:
2.- unhealthy
Threshold Integer The number of consecutive failed health checks that determine the health check status of the backend server from success to failure.
Value range: 2 to 10.
Default value:
2.
- health
Check numberConnect Port The port of the backend server used for health check.
Value range: 1 to 65535.
Default value:
80.- health
Check numberConnect Timeout The maximum timeout period for health check responses.
Unit: seconds.
Value range: 1 to 300.
Default value:
5.- health
Check stringDomain - The domain name used for health checks. Value:
- $SERVER_IP (default): Use the internal IP address of the backend server.
- health
Check booleanEnabled - Whether to enable health check. Value:
- true (default): enabled.
- health
Check string[]Http Codes - Health status return code list.
- health
Check numberInterval The time interval of the health check.
Unit: seconds.
Value range: 1~50.
Default value:
10.- health
Check stringPath Health check path.
It can be 1 to 80 characters in length and can only use upper and lower case letters, digits, dashes (-), forward slashes (/), half-width periods (.), percent signs (%), and half-width question marks (?), Pound sign (#) and and(&) and extended character set_;~! ()*[]@$^: ',+ =
Must start with a forward slash (/).
NOTE: This parameter takes effect only when the HealthCheckProtocol is HTTP.
- health
Check stringProtocol - Health check protocol, value:
TCP(default): Sends a SYN handshake packet to check whether the server port is alive.HTTP: Sends a GET request to simulate the access behavior of the browser to check whether the server application is healthy.
- healthy
Threshold number After the number of consecutive successful health checks, the health check status of the backend server is determined as successful from failed.
Value range: 2 to 10.
Default value:
2.- unhealthy
Threshold number The number of consecutive failed health checks that determine the health check status of the backend server from success to failure.
Value range: 2 to 10.
Default value:
2.
- health_
check_ intconnect_ port The port of the backend server used for health check.
Value range: 1 to 65535.
Default value:
80.- health_
check_ intconnect_ timeout The maximum timeout period for health check responses.
Unit: seconds.
Value range: 1 to 300.
Default value:
5.- health_
check_ strdomain - The domain name used for health checks. Value:
- $SERVER_IP (default): Use the internal IP address of the backend server.
- health_
check_ boolenabled - Whether to enable health check. Value:
- true (default): enabled.
- health_
check_ Sequence[str]http_ codes - Health status return code list.
- health_
check_ intinterval The time interval of the health check.
Unit: seconds.
Value range: 1~50.
Default value:
10.- health_
check_ strpath Health check path.
It can be 1 to 80 characters in length and can only use upper and lower case letters, digits, dashes (-), forward slashes (/), half-width periods (.), percent signs (%), and half-width question marks (?), Pound sign (#) and and(&) and extended character set_;~! ()*[]@$^: ',+ =
Must start with a forward slash (/).
NOTE: This parameter takes effect only when the HealthCheckProtocol is HTTP.
- health_
check_ strprotocol - Health check protocol, value:
TCP(default): Sends a SYN handshake packet to check whether the server port is alive.HTTP: Sends a GET request to simulate the access behavior of the browser to check whether the server application is healthy.
- healthy_
threshold int After the number of consecutive successful health checks, the health check status of the backend server is determined as successful from failed.
Value range: 2 to 10.
Default value:
2.- unhealthy_
threshold int The number of consecutive failed health checks that determine the health check status of the backend server from success to failure.
Value range: 2 to 10.
Default value:
2.
- health
Check NumberConnect Port The port of the backend server used for health check.
Value range: 1 to 65535.
Default value:
80.- health
Check NumberConnect Timeout The maximum timeout period for health check responses.
Unit: seconds.
Value range: 1 to 300.
Default value:
5.- health
Check StringDomain - The domain name used for health checks. Value:
- $SERVER_IP (default): Use the internal IP address of the backend server.
- health
Check BooleanEnabled - Whether to enable health check. Value:
- true (default): enabled.
- health
Check List<String>Http Codes - Health status return code list.
- health
Check NumberInterval The time interval of the health check.
Unit: seconds.
Value range: 1~50.
Default value:
10.- health
Check StringPath Health check path.
It can be 1 to 80 characters in length and can only use upper and lower case letters, digits, dashes (-), forward slashes (/), half-width periods (.), percent signs (%), and half-width question marks (?), Pound sign (#) and and(&) and extended character set_;~! ()*[]@$^: ',+ =
Must start with a forward slash (/).
NOTE: This parameter takes effect only when the HealthCheckProtocol is HTTP.
- health
Check StringProtocol - Health check protocol, value:
TCP(default): Sends a SYN handshake packet to check whether the server port is alive.HTTP: Sends a GET request to simulate the access behavior of the browser to check whether the server application is healthy.
- healthy
Threshold Number After the number of consecutive successful health checks, the health check status of the backend server is determined as successful from failed.
Value range: 2 to 10.
Default value:
2.- unhealthy
Threshold Number The number of consecutive failed health checks that determine the health check status of the backend server from success to failure.
Value range: 2 to 10.
Default value:
2.
ServerGroupServer, ServerGroupServerArgs
- Server
Id string - The ID of the backend server.
- Server
Type string - Backend server type. Valid values:
Ecs: ECS instance.Eni: ENI instance.Eci: ECI elastic container.Ip: Ip address.
- Port int
- The port used by the backend server.
- Server
Group stringId - The server group ID.
- Server
Ip string - Server ip.
- Status string
- Server group status. Value:
- Server
Id string - The ID of the backend server.
- Server
Type string - Backend server type. Valid values:
Ecs: ECS instance.Eni: ENI instance.Eci: ECI elastic container.Ip: Ip address.
- Port int
- The port used by the backend server.
- Server
Group stringId - The server group ID.
- Server
Ip string - Server ip.
- Status string
- Server group status. Value:
- server
Id String - The ID of the backend server.
- server
Type String - Backend server type. Valid values:
Ecs: ECS instance.Eni: ENI instance.Eci: ECI elastic container.Ip: Ip address.
- port Integer
- The port used by the backend server.
- server
Group StringId - The server group ID.
- server
Ip String - Server ip.
- status String
- Server group status. Value:
- server
Id string - The ID of the backend server.
- server
Type string - Backend server type. Valid values:
Ecs: ECS instance.Eni: ENI instance.Eci: ECI elastic container.Ip: Ip address.
- port number
- The port used by the backend server.
- server
Group stringId - The server group ID.
- server
Ip string - Server ip.
- status string
- Server group status. Value:
- server_
id str - The ID of the backend server.
- server_
type str - Backend server type. Valid values:
Ecs: ECS instance.Eni: ENI instance.Eci: ECI elastic container.Ip: Ip address.
- port int
- The port used by the backend server.
- server_
group_ strid - The server group ID.
- server_
ip str - Server ip.
- status str
- Server group status. Value:
- server
Id String - The ID of the backend server.
- server
Type String - Backend server type. Valid values:
Ecs: ECS instance.Eni: ENI instance.Eci: ECI elastic container.Ip: Ip address.
- port Number
- The port used by the backend server.
- server
Group StringId - The server group ID.
- server
Ip String - Server ip.
- status String
- Server group status. Value:
Import
GWLB Server Group can be imported using the id, e.g.
$ pulumi import alicloud:gwlb/serverGroup:ServerGroup example <id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloudTerraform Provider.