1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. gwlb
  5. ServerGroup
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

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 This property is required. string
The unique name of the resource.
args This property is required. ServerGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ServerGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ServerGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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" },
    },
});
Copy
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"),
	},
})
Copy
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());
Copy
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",
    })
Copy
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",
    },
});
Copy
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
Copy

ServerGroup Resource Properties

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

Inputs

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

The ServerGroup resource accepts the following input properties:

VpcId
This property is required.
Changes to this property will trigger replacement.
string

The VPC ID.

NOTE: If ServerGroupType is set to Instance, only servers in the specified VPC can be added to the server group.

ConnectionDrainConfig Pulumi.AliCloud.Gwlb.Inputs.ServerGroupConnectionDrainConfig
Connected graceful interrupt configuration. See connection_drain_config below.
DryRun bool
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
HealthCheckConfig Pulumi.AliCloud.Gwlb.Inputs.ServerGroupHealthCheckConfig
Health check configurations. See health_check_config below.
Protocol Changes to this property will trigger replacement. string
The backend protocol. Valid values:

  • GENEVE(default)
ResourceGroupId string
The ID of the resource group.
Scheduler string
The scheduling algorithm. Valid values:

  • 5TCH (default): specifies consistent hashing that is based on the following factors: source IP address, destination IP address, source port, protocol, and destination port. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 3TCH: specifies consistent hashing that is based on the following factors: source IP address, destination IP address, and protocol. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 2TCH: specifies consistent hashing that is based on the following factors: source IP address and destination IP address. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
ServerGroupName string

The server group name.

The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

ServerGroupType Changes to this property will trigger replacement. string
The type of server group. Valid values:

  • Instance (default): allows you to specify servers of the Ecs, Eni, or Eci type.
  • Ip: allows you to add servers of by specifying IP addresses.
Servers List<Pulumi.AliCloud.Gwlb.Inputs.ServerGroupServer>

The backend servers that you want to remove.

NOTE: You can remove at most 200 backend servers in each call. See servers below.

Tags Dictionary<string, string>

The tag keys.

You can specify at most 20 tags in each call.

VpcId
This property is required.
Changes to this property will trigger replacement.
string

The VPC ID.

NOTE: If ServerGroupType is set to Instance, only servers in the specified VPC can be added to the server group.

ConnectionDrainConfig ServerGroupConnectionDrainConfigArgs
Connected graceful interrupt configuration. See connection_drain_config below.
DryRun bool
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
HealthCheckConfig ServerGroupHealthCheckConfigArgs
Health check configurations. See health_check_config below.
Protocol Changes to this property will trigger replacement. string
The backend protocol. Valid values:

  • GENEVE(default)
ResourceGroupId string
The ID of the resource group.
Scheduler string
The scheduling algorithm. Valid values:

  • 5TCH (default): specifies consistent hashing that is based on the following factors: source IP address, destination IP address, source port, protocol, and destination port. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 3TCH: specifies consistent hashing that is based on the following factors: source IP address, destination IP address, and protocol. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 2TCH: specifies consistent hashing that is based on the following factors: source IP address and destination IP address. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
ServerGroupName string

The server group name.

The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

ServerGroupType Changes to this property will trigger replacement. string
The type of server group. Valid values:

  • Instance (default): allows you to specify servers of the Ecs, Eni, or Eci type.
  • Ip: allows you to add servers of by specifying IP addresses.
Servers []ServerGroupServerArgs

The backend servers that you want to remove.

NOTE: You can remove at most 200 backend servers in each call. See servers below.

Tags map[string]string

The tag keys.

You can specify at most 20 tags in each call.

vpcId
This property is required.
Changes to this property will trigger replacement.
String

The VPC ID.

NOTE: If ServerGroupType is set to Instance, only servers in the specified VPC can be added to the server group.

connectionDrainConfig ServerGroupConnectionDrainConfig
Connected graceful interrupt configuration. See connection_drain_config below.
dryRun Boolean
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
healthCheckConfig ServerGroupHealthCheckConfig
Health check configurations. See health_check_config below.
protocol Changes to this property will trigger replacement. String
The backend protocol. Valid values:

  • GENEVE(default)
resourceGroupId String
The ID of the resource group.
scheduler String
The scheduling algorithm. Valid values:

  • 5TCH (default): specifies consistent hashing that is based on the following factors: source IP address, destination IP address, source port, protocol, and destination port. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 3TCH: specifies consistent hashing that is based on the following factors: source IP address, destination IP address, and protocol. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 2TCH: specifies consistent hashing that is based on the following factors: source IP address and destination IP address. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
serverGroupName String

The server group name.

The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

serverGroupType Changes to this property will trigger replacement. String
The type of server group. Valid values:

  • Instance (default): allows you to specify servers of the Ecs, Eni, or Eci type.
  • Ip: allows you to add servers of by specifying IP addresses.
servers List<ServerGroupServer>

The backend servers that you want to remove.

NOTE: You can remove at most 200 backend servers in each call. See servers below.

tags Map<String,String>

The tag keys.

You can specify at most 20 tags in each call.

vpcId
This property is required.
Changes to this property will trigger replacement.
string

The VPC ID.

NOTE: If ServerGroupType is set to Instance, only servers in the specified VPC can be added to the server group.

connectionDrainConfig ServerGroupConnectionDrainConfig
Connected graceful interrupt configuration. See connection_drain_config below.
dryRun boolean
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
healthCheckConfig ServerGroupHealthCheckConfig
Health check configurations. See health_check_config below.
protocol Changes to this property will trigger replacement. string
The backend protocol. Valid values:

  • GENEVE(default)
resourceGroupId string
The ID of the resource group.
scheduler string
The scheduling algorithm. Valid values:

  • 5TCH (default): specifies consistent hashing that is based on the following factors: source IP address, destination IP address, source port, protocol, and destination port. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 3TCH: specifies consistent hashing that is based on the following factors: source IP address, destination IP address, and protocol. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 2TCH: specifies consistent hashing that is based on the following factors: source IP address and destination IP address. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
serverGroupName string

The server group name.

The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

serverGroupType Changes to this property will trigger replacement. string
The type of server group. Valid values:

  • Instance (default): allows you to specify servers of the Ecs, Eni, or Eci type.
  • Ip: allows you to add servers of by specifying IP addresses.
servers ServerGroupServer[]

The backend servers that you want to remove.

NOTE: You can remove at most 200 backend servers in each call. See servers below.

tags {[key: string]: string}

The tag keys.

You can specify at most 20 tags in each call.

vpc_id
This property is required.
Changes to this property will trigger replacement.
str

The VPC ID.

NOTE: If ServerGroupType is set to Instance, only servers in the specified VPC can be added to the server group.

connection_drain_config ServerGroupConnectionDrainConfigArgs
Connected graceful interrupt configuration. See connection_drain_config below.
dry_run bool
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
health_check_config ServerGroupHealthCheckConfigArgs
Health check configurations. See health_check_config below.
protocol Changes to this property will trigger replacement. str
The backend protocol. Valid values:

  • GENEVE(default)
resource_group_id str
The ID of the resource group.
scheduler str
The scheduling algorithm. Valid values:

  • 5TCH (default): specifies consistent hashing that is based on the following factors: source IP address, destination IP address, source port, protocol, and destination port. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 3TCH: specifies consistent hashing that is based on the following factors: source IP address, destination IP address, and protocol. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 2TCH: specifies consistent hashing that is based on the following factors: source IP address and destination IP address. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
server_group_name str

The server group name.

The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

server_group_type Changes to this property will trigger replacement. str
The type of server group. Valid values:

  • Instance (default): allows you to specify servers of the Ecs, Eni, or Eci type.
  • Ip: allows you to add servers of by specifying IP addresses.
servers Sequence[ServerGroupServerArgs]

The backend servers that you want to remove.

NOTE: You can remove at most 200 backend servers in each call. See servers below.

tags Mapping[str, str]

The tag keys.

You can specify at most 20 tags in each call.

vpcId
This property is required.
Changes to this property will trigger replacement.
String

The VPC ID.

NOTE: If ServerGroupType is set to Instance, only servers in the specified VPC can be added to the server group.

connectionDrainConfig Property Map
Connected graceful interrupt configuration. See connection_drain_config below.
dryRun Boolean
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
healthCheckConfig Property Map
Health check configurations. See health_check_config below.
protocol Changes to this property will trigger replacement. String
The backend protocol. Valid values:

  • GENEVE(default)
resourceGroupId String
The ID of the resource group.
scheduler String
The scheduling algorithm. Valid values:

  • 5TCH (default): specifies consistent hashing that is based on the following factors: source IP address, destination IP address, source port, protocol, and destination port. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 3TCH: specifies consistent hashing that is based on the following factors: source IP address, destination IP address, and protocol. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 2TCH: specifies consistent hashing that is based on the following factors: source IP address and destination IP address. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
serverGroupName String

The server group name.

The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

serverGroupType Changes to this property will trigger replacement. String
The type of server group. Valid values:

  • Instance (default): allows you to specify servers of the Ecs, Eni, or Eci type.
  • Ip: allows you to add servers of by specifying IP addresses.
servers List<Property Map>

The backend servers that you want to remove.

NOTE: You can remove at most 200 backend servers in each call. See servers below.

tags Map<String>

The tag keys.

You can specify at most 20 tags in each call.

Outputs

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

CreateTime string
The time when the resource was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
Id string
The provider-assigned unique ID for this managed resource.
Status string
Indicates the status of the backend server.
CreateTime string
The time when the resource was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
Id string
The provider-assigned unique ID for this managed resource.
Status string
Indicates the status of the backend server.
createTime String
The time when the resource was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
id String
The provider-assigned unique ID for this managed resource.
status String
Indicates the status of the backend server.
createTime string
The time when the resource was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
id string
The provider-assigned unique ID for this managed resource.
status string
Indicates the status of the backend server.
create_time str
The time when the resource was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
id str
The provider-assigned unique ID for this managed resource.
status str
Indicates the status of the backend server.
createTime String
The time when the resource was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
id String
The provider-assigned unique ID for this managed resource.
status String
Indicates the status of the backend server.

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) -> ServerGroup
func GetServerGroup(ctx *Context, name string, id IDInput, state *ServerGroupState, opts ...ResourceOption) (*ServerGroup, error)
public static ServerGroup Get(string name, Input<string> id, ServerGroupState? state, CustomResourceOptions? opts = null)
public static ServerGroup get(String name, Output<String> id, ServerGroupState state, CustomResourceOptions options)
resources:  _:    type: alicloud:gwlb:ServerGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ConnectionDrainConfig Pulumi.AliCloud.Gwlb.Inputs.ServerGroupConnectionDrainConfig
Connected graceful interrupt configuration. See connection_drain_config below.
CreateTime string
The time when the resource was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
DryRun bool
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
HealthCheckConfig Pulumi.AliCloud.Gwlb.Inputs.ServerGroupHealthCheckConfig
Health check configurations. See health_check_config below.
Protocol Changes to this property will trigger replacement. string
The backend protocol. Valid values:

  • GENEVE(default)
ResourceGroupId string
The ID of the resource group.
Scheduler string
The scheduling algorithm. Valid values:

  • 5TCH (default): specifies consistent hashing that is based on the following factors: source IP address, destination IP address, source port, protocol, and destination port. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 3TCH: specifies consistent hashing that is based on the following factors: source IP address, destination IP address, and protocol. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 2TCH: specifies consistent hashing that is based on the following factors: source IP address and destination IP address. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
ServerGroupName string

The server group name.

The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

ServerGroupType Changes to this property will trigger replacement. string
The type of server group. Valid values:

  • Instance (default): allows you to specify servers of the Ecs, Eni, or Eci type.
  • Ip: allows you to add servers of by specifying IP addresses.
Servers List<Pulumi.AliCloud.Gwlb.Inputs.ServerGroupServer>

The backend servers that you want to remove.

NOTE: You can remove at most 200 backend servers in each call. See servers below.

Status string
Indicates the status of the backend server.
Tags Dictionary<string, string>

The tag keys.

You can specify at most 20 tags in each call.

VpcId Changes to this property will trigger replacement. string

The VPC ID.

NOTE: If ServerGroupType is set to Instance, only servers in the specified VPC can be added to the server group.

ConnectionDrainConfig ServerGroupConnectionDrainConfigArgs
Connected graceful interrupt configuration. See connection_drain_config below.
CreateTime string
The time when the resource was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
DryRun bool
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
HealthCheckConfig ServerGroupHealthCheckConfigArgs
Health check configurations. See health_check_config below.
Protocol Changes to this property will trigger replacement. string
The backend protocol. Valid values:

  • GENEVE(default)
ResourceGroupId string
The ID of the resource group.
Scheduler string
The scheduling algorithm. Valid values:

  • 5TCH (default): specifies consistent hashing that is based on the following factors: source IP address, destination IP address, source port, protocol, and destination port. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 3TCH: specifies consistent hashing that is based on the following factors: source IP address, destination IP address, and protocol. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 2TCH: specifies consistent hashing that is based on the following factors: source IP address and destination IP address. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
ServerGroupName string

The server group name.

The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

ServerGroupType Changes to this property will trigger replacement. string
The type of server group. Valid values:

  • Instance (default): allows you to specify servers of the Ecs, Eni, or Eci type.
  • Ip: allows you to add servers of by specifying IP addresses.
Servers []ServerGroupServerArgs

The backend servers that you want to remove.

NOTE: You can remove at most 200 backend servers in each call. See servers below.

Status string
Indicates the status of the backend server.
Tags map[string]string

The tag keys.

You can specify at most 20 tags in each call.

VpcId Changes to this property will trigger replacement. string

The VPC ID.

NOTE: If ServerGroupType is set to Instance, only servers in the specified VPC can be added to the server group.

connectionDrainConfig ServerGroupConnectionDrainConfig
Connected graceful interrupt configuration. See connection_drain_config below.
createTime String
The time when the resource was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
dryRun Boolean
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
healthCheckConfig ServerGroupHealthCheckConfig
Health check configurations. See health_check_config below.
protocol Changes to this property will trigger replacement. String
The backend protocol. Valid values:

  • GENEVE(default)
resourceGroupId String
The ID of the resource group.
scheduler String
The scheduling algorithm. Valid values:

  • 5TCH (default): specifies consistent hashing that is based on the following factors: source IP address, destination IP address, source port, protocol, and destination port. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 3TCH: specifies consistent hashing that is based on the following factors: source IP address, destination IP address, and protocol. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 2TCH: specifies consistent hashing that is based on the following factors: source IP address and destination IP address. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
serverGroupName String

The server group name.

The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

serverGroupType Changes to this property will trigger replacement. String
The type of server group. Valid values:

  • Instance (default): allows you to specify servers of the Ecs, Eni, or Eci type.
  • Ip: allows you to add servers of by specifying IP addresses.
servers List<ServerGroupServer>

The backend servers that you want to remove.

NOTE: You can remove at most 200 backend servers in each call. See servers below.

status String
Indicates the status of the backend server.
tags Map<String,String>

The tag keys.

You can specify at most 20 tags in each call.

vpcId Changes to this property will trigger replacement. String

The VPC ID.

NOTE: If ServerGroupType is set to Instance, only servers in the specified VPC can be added to the server group.

connectionDrainConfig ServerGroupConnectionDrainConfig
Connected graceful interrupt configuration. See connection_drain_config below.
createTime string
The time when the resource was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
dryRun boolean
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
healthCheckConfig ServerGroupHealthCheckConfig
Health check configurations. See health_check_config below.
protocol Changes to this property will trigger replacement. string
The backend protocol. Valid values:

  • GENEVE(default)
resourceGroupId string
The ID of the resource group.
scheduler string
The scheduling algorithm. Valid values:

  • 5TCH (default): specifies consistent hashing that is based on the following factors: source IP address, destination IP address, source port, protocol, and destination port. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 3TCH: specifies consistent hashing that is based on the following factors: source IP address, destination IP address, and protocol. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 2TCH: specifies consistent hashing that is based on the following factors: source IP address and destination IP address. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
serverGroupName string

The server group name.

The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

serverGroupType Changes to this property will trigger replacement. string
The type of server group. Valid values:

  • Instance (default): allows you to specify servers of the Ecs, Eni, or Eci type.
  • Ip: allows you to add servers of by specifying IP addresses.
servers ServerGroupServer[]

The backend servers that you want to remove.

NOTE: You can remove at most 200 backend servers in each call. See servers below.

status string
Indicates the status of the backend server.
tags {[key: string]: string}

The tag keys.

You can specify at most 20 tags in each call.

vpcId Changes to this property will trigger replacement. string

The VPC ID.

NOTE: If ServerGroupType is set to Instance, only servers in the specified VPC can be added to the server group.

connection_drain_config ServerGroupConnectionDrainConfigArgs
Connected graceful interrupt configuration. See connection_drain_config below.
create_time str
The time when the resource was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
dry_run bool
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
health_check_config ServerGroupHealthCheckConfigArgs
Health check configurations. See health_check_config below.
protocol Changes to this property will trigger replacement. str
The backend protocol. Valid values:

  • GENEVE(default)
resource_group_id str
The ID of the resource group.
scheduler str
The scheduling algorithm. Valid values:

  • 5TCH (default): specifies consistent hashing that is based on the following factors: source IP address, destination IP address, source port, protocol, and destination port. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 3TCH: specifies consistent hashing that is based on the following factors: source IP address, destination IP address, and protocol. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 2TCH: specifies consistent hashing that is based on the following factors: source IP address and destination IP address. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
server_group_name str

The server group name.

The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

server_group_type Changes to this property will trigger replacement. str
The type of server group. Valid values:

  • Instance (default): allows you to specify servers of the Ecs, Eni, or Eci type.
  • Ip: allows you to add servers of by specifying IP addresses.
servers Sequence[ServerGroupServerArgs]

The backend servers that you want to remove.

NOTE: You can remove at most 200 backend servers in each call. See servers below.

status str
Indicates the status of the backend server.
tags Mapping[str, str]

The tag keys.

You can specify at most 20 tags in each call.

vpc_id Changes to this property will trigger replacement. str

The VPC ID.

NOTE: If ServerGroupType is set to Instance, only servers in the specified VPC can be added to the server group.

connectionDrainConfig Property Map
Connected graceful interrupt configuration. See connection_drain_config below.
createTime String
The time when the resource was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
dryRun Boolean
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
healthCheckConfig Property Map
Health check configurations. See health_check_config below.
protocol Changes to this property will trigger replacement. String
The backend protocol. Valid values:

  • GENEVE(default)
resourceGroupId String
The ID of the resource group.
scheduler String
The scheduling algorithm. Valid values:

  • 5TCH (default): specifies consistent hashing that is based on the following factors: source IP address, destination IP address, source port, protocol, and destination port. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 3TCH: specifies consistent hashing that is based on the following factors: source IP address, destination IP address, and protocol. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
  • 2TCH: specifies consistent hashing that is based on the following factors: source IP address and destination IP address. Requests that contain the same information based on the preceding factors are forwarded to the same backend server.
serverGroupName String

The server group name.

The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

serverGroupType Changes to this property will trigger replacement. String
The type of server group. Valid values:

  • Instance (default): allows you to specify servers of the Ecs, Eni, or Eci type.
  • Ip: allows you to add servers of by specifying IP addresses.
servers List<Property Map>

The backend servers that you want to remove.

NOTE: You can remove at most 200 backend servers in each call. See servers below.

status String
Indicates the status of the backend server.
tags Map<String>

The tag keys.

You can specify at most 20 tags in each call.

vpcId Changes to this property will trigger replacement. String

The VPC ID.

NOTE: If ServerGroupType is set to Instance, only servers in the specified VPC can be added to the server group.

Supporting Types

ServerGroupConnectionDrainConfig
, ServerGroupConnectionDrainConfigArgs

ConnectionDrainEnabled bool
Indicates whether connection draining is enabled. Valid values:
ConnectionDrainTimeout int

The timeout period of connection draining.

Unit: seconds

Valid values: 1 to 3600.

Default value: 300.

ConnectionDrainEnabled bool
Indicates whether connection draining is enabled. Valid values:
ConnectionDrainTimeout int

The timeout period of connection draining.

Unit: seconds

Valid values: 1 to 3600.

Default value: 300.

connectionDrainEnabled Boolean
Indicates whether connection draining is enabled. Valid values:
connectionDrainTimeout Integer

The timeout period of connection draining.

Unit: seconds

Valid values: 1 to 3600.

Default value: 300.

connectionDrainEnabled boolean
Indicates whether connection draining is enabled. Valid values:
connectionDrainTimeout number

The timeout period of connection draining.

Unit: seconds

Valid values: 1 to 3600.

Default value: 300.

connection_drain_enabled bool
Indicates whether connection draining is enabled. Valid values:
connection_drain_timeout int

The timeout period of connection draining.

Unit: seconds

Valid values: 1 to 3600.

Default value: 300.

connectionDrainEnabled Boolean
Indicates whether connection draining is enabled. Valid values:
connectionDrainTimeout Number

The timeout period of connection draining.

Unit: seconds

Valid values: 1 to 3600.

Default value: 300.

ServerGroupHealthCheckConfig
, ServerGroupHealthCheckConfigArgs

HealthCheckConnectPort int

The backend server port that is used for health checks.

Valid values: 1 to 65535.

Default value: 80.

HealthCheckConnectTimeout int

The maximum timeout period of a health check response.

Unit: seconds

Valid values: 1 to 300.

Default value: 5.

HealthCheckDomain string
The domain name that you want to use for health checks. Valid values:

  • $SERVER_IP (default): the private IP address of a backend server.
HealthCheckEnabled bool
Specifies whether to enable the health check feature. Valid values:
HealthCheckHttpCodes List<string>
The HTTP status codes that the system returns for health checks.
HealthCheckInterval int

The interval at which health checks are performed.

Unit: seconds

Valid values: 1 to 50.

Default value: 10.

HealthCheckPath string

The URL that is used for health checks.

The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( ) * [ ] @ $ ^ : ' , + =

The URL must start with a forward slash (/).

NOTE: This parameter takes effect only if you set HealthCheckProtocol to HTTP.

HealthCheckProtocol string
The protocol that is used for health checks. Valid values:

  • TCP: TCP health checks send TCP SYN packets to a backend server to check whether the port of the backend server is reachable.
  • HTTP: HTTP health checks simulate a process that uses a web browser to access resources by sending HEAD or GET requests to an instance. These requests are used to check whether the instance is healthy.
HealthyThreshold int

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. In this case, the health status changes from fail to success.

Valid values: 2 to 10.

Default value: 2.

UnhealthyThreshold int

The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status changes from success to fail.

Valid values: 2 to 10.

Default value: 2.

HealthCheckConnectPort int

The backend server port that is used for health checks.

Valid values: 1 to 65535.

Default value: 80.

HealthCheckConnectTimeout int

The maximum timeout period of a health check response.

Unit: seconds

Valid values: 1 to 300.

Default value: 5.

HealthCheckDomain string
The domain name that you want to use for health checks. Valid values:

  • $SERVER_IP (default): the private IP address of a backend server.
HealthCheckEnabled bool
Specifies whether to enable the health check feature. Valid values:
HealthCheckHttpCodes []string
The HTTP status codes that the system returns for health checks.
HealthCheckInterval int

The interval at which health checks are performed.

Unit: seconds

Valid values: 1 to 50.

Default value: 10.

HealthCheckPath string

The URL that is used for health checks.

The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( ) * [ ] @ $ ^ : ' , + =

The URL must start with a forward slash (/).

NOTE: This parameter takes effect only if you set HealthCheckProtocol to HTTP.

HealthCheckProtocol string
The protocol that is used for health checks. Valid values:

  • TCP: TCP health checks send TCP SYN packets to a backend server to check whether the port of the backend server is reachable.
  • HTTP: HTTP health checks simulate a process that uses a web browser to access resources by sending HEAD or GET requests to an instance. These requests are used to check whether the instance is healthy.
HealthyThreshold int

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. In this case, the health status changes from fail to success.

Valid values: 2 to 10.

Default value: 2.

UnhealthyThreshold int

The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status changes from success to fail.

Valid values: 2 to 10.

Default value: 2.

healthCheckConnectPort Integer

The backend server port that is used for health checks.

Valid values: 1 to 65535.

Default value: 80.

healthCheckConnectTimeout Integer

The maximum timeout period of a health check response.

Unit: seconds

Valid values: 1 to 300.

Default value: 5.

healthCheckDomain String
The domain name that you want to use for health checks. Valid values:

  • $SERVER_IP (default): the private IP address of a backend server.
healthCheckEnabled Boolean
Specifies whether to enable the health check feature. Valid values:
healthCheckHttpCodes List<String>
The HTTP status codes that the system returns for health checks.
healthCheckInterval Integer

The interval at which health checks are performed.

Unit: seconds

Valid values: 1 to 50.

Default value: 10.

healthCheckPath String

The URL that is used for health checks.

The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( ) * [ ] @ $ ^ : ' , + =

The URL must start with a forward slash (/).

NOTE: This parameter takes effect only if you set HealthCheckProtocol to HTTP.

healthCheckProtocol String
The protocol that is used for health checks. Valid values:

  • TCP: TCP health checks send TCP SYN packets to a backend server to check whether the port of the backend server is reachable.
  • HTTP: HTTP health checks simulate a process that uses a web browser to access resources by sending HEAD or GET requests to an instance. These requests are used to check whether the instance is healthy.
healthyThreshold Integer

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. In this case, the health status changes from fail to success.

Valid values: 2 to 10.

Default value: 2.

unhealthyThreshold Integer

The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status changes from success to fail.

Valid values: 2 to 10.

Default value: 2.

healthCheckConnectPort number

The backend server port that is used for health checks.

Valid values: 1 to 65535.

Default value: 80.

healthCheckConnectTimeout number

The maximum timeout period of a health check response.

Unit: seconds

Valid values: 1 to 300.

Default value: 5.

healthCheckDomain string
The domain name that you want to use for health checks. Valid values:

  • $SERVER_IP (default): the private IP address of a backend server.
healthCheckEnabled boolean
Specifies whether to enable the health check feature. Valid values:
healthCheckHttpCodes string[]
The HTTP status codes that the system returns for health checks.
healthCheckInterval number

The interval at which health checks are performed.

Unit: seconds

Valid values: 1 to 50.

Default value: 10.

healthCheckPath string

The URL that is used for health checks.

The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( ) * [ ] @ $ ^ : ' , + =

The URL must start with a forward slash (/).

NOTE: This parameter takes effect only if you set HealthCheckProtocol to HTTP.

healthCheckProtocol string
The protocol that is used for health checks. Valid values:

  • TCP: TCP health checks send TCP SYN packets to a backend server to check whether the port of the backend server is reachable.
  • HTTP: HTTP health checks simulate a process that uses a web browser to access resources by sending HEAD or GET requests to an instance. These requests are used to check whether the instance is healthy.
healthyThreshold number

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. In this case, the health status changes from fail to success.

Valid values: 2 to 10.

Default value: 2.

unhealthyThreshold number

The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status changes from success to fail.

Valid values: 2 to 10.

Default value: 2.

health_check_connect_port int

The backend server port that is used for health checks.

Valid values: 1 to 65535.

Default value: 80.

health_check_connect_timeout int

The maximum timeout period of a health check response.

Unit: seconds

Valid values: 1 to 300.

Default value: 5.

health_check_domain str
The domain name that you want to use for health checks. Valid values:

  • $SERVER_IP (default): the private IP address of a backend server.
health_check_enabled bool
Specifies whether to enable the health check feature. Valid values:
health_check_http_codes Sequence[str]
The HTTP status codes that the system returns for health checks.
health_check_interval int

The interval at which health checks are performed.

Unit: seconds

Valid values: 1 to 50.

Default value: 10.

health_check_path str

The URL that is used for health checks.

The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( ) * [ ] @ $ ^ : ' , + =

The URL must start with a forward slash (/).

NOTE: This parameter takes effect only if you set HealthCheckProtocol to HTTP.

health_check_protocol str
The protocol that is used for health checks. Valid values:

  • TCP: TCP health checks send TCP SYN packets to a backend server to check whether the port of the backend server is reachable.
  • HTTP: HTTP health checks simulate a process that uses a web browser to access resources by sending HEAD or GET requests to an instance. These requests are used to check whether the instance is healthy.
healthy_threshold int

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. In this case, the health status changes from fail to success.

Valid values: 2 to 10.

Default value: 2.

unhealthy_threshold int

The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status changes from success to fail.

Valid values: 2 to 10.

Default value: 2.

healthCheckConnectPort Number

The backend server port that is used for health checks.

Valid values: 1 to 65535.

Default value: 80.

healthCheckConnectTimeout Number

The maximum timeout period of a health check response.

Unit: seconds

Valid values: 1 to 300.

Default value: 5.

healthCheckDomain String
The domain name that you want to use for health checks. Valid values:

  • $SERVER_IP (default): the private IP address of a backend server.
healthCheckEnabled Boolean
Specifies whether to enable the health check feature. Valid values:
healthCheckHttpCodes List<String>
The HTTP status codes that the system returns for health checks.
healthCheckInterval Number

The interval at which health checks are performed.

Unit: seconds

Valid values: 1 to 50.

Default value: 10.

healthCheckPath String

The URL that is used for health checks.

The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( ) * [ ] @ $ ^ : ' , + =

The URL must start with a forward slash (/).

NOTE: This parameter takes effect only if you set HealthCheckProtocol to HTTP.

healthCheckProtocol String
The protocol that is used for health checks. Valid values:

  • TCP: TCP health checks send TCP SYN packets to a backend server to check whether the port of the backend server is reachable.
  • HTTP: HTTP health checks simulate a process that uses a web browser to access resources by sending HEAD or GET requests to an instance. These requests are used to check whether the instance is healthy.
healthyThreshold Number

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. In this case, the health status changes from fail to success.

Valid values: 2 to 10.

Default value: 2.

unhealthyThreshold Number

The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status changes from success to fail.

Valid values: 2 to 10.

Default value: 2.

ServerGroupServer
, ServerGroupServerArgs

ServerId This property is required. string
The backend server ID.

  • If the server group is of the Instance type, set this parameter to the IDs of servers of the Ecs, Eni, or Eci type.
  • If the server group is of the Ip type, set ServerId to IP addresses.
ServerType This property is required. string
The type of the backend server. Valid values:

  • Ecs: Elastic Compute Service (ECS) instance
  • Eni: elastic network interface (ENI)
  • Eci: elastic container instance
  • Ip: IP address
Port int
(Optional, Computed, Int) The port that is used by the backend server.
ServerGroupId string
The server group ID.
ServerIp string
The IP address of the backend server.
Status string
Indicates the status of the backend server.
ServerId This property is required. string
The backend server ID.

  • If the server group is of the Instance type, set this parameter to the IDs of servers of the Ecs, Eni, or Eci type.
  • If the server group is of the Ip type, set ServerId to IP addresses.
ServerType This property is required. string
The type of the backend server. Valid values:

  • Ecs: Elastic Compute Service (ECS) instance
  • Eni: elastic network interface (ENI)
  • Eci: elastic container instance
  • Ip: IP address
Port int
(Optional, Computed, Int) The port that is used by the backend server.
ServerGroupId string
The server group ID.
ServerIp string
The IP address of the backend server.
Status string
Indicates the status of the backend server.
serverId This property is required. String
The backend server ID.

  • If the server group is of the Instance type, set this parameter to the IDs of servers of the Ecs, Eni, or Eci type.
  • If the server group is of the Ip type, set ServerId to IP addresses.
serverType This property is required. String
The type of the backend server. Valid values:

  • Ecs: Elastic Compute Service (ECS) instance
  • Eni: elastic network interface (ENI)
  • Eci: elastic container instance
  • Ip: IP address
port Integer
(Optional, Computed, Int) The port that is used by the backend server.
serverGroupId String
The server group ID.
serverIp String
The IP address of the backend server.
status String
Indicates the status of the backend server.
serverId This property is required. string
The backend server ID.

  • If the server group is of the Instance type, set this parameter to the IDs of servers of the Ecs, Eni, or Eci type.
  • If the server group is of the Ip type, set ServerId to IP addresses.
serverType This property is required. string
The type of the backend server. Valid values:

  • Ecs: Elastic Compute Service (ECS) instance
  • Eni: elastic network interface (ENI)
  • Eci: elastic container instance
  • Ip: IP address
port number
(Optional, Computed, Int) The port that is used by the backend server.
serverGroupId string
The server group ID.
serverIp string
The IP address of the backend server.
status string
Indicates the status of the backend server.
server_id This property is required. str
The backend server ID.

  • If the server group is of the Instance type, set this parameter to the IDs of servers of the Ecs, Eni, or Eci type.
  • If the server group is of the Ip type, set ServerId to IP addresses.
server_type This property is required. str
The type of the backend server. Valid values:

  • Ecs: Elastic Compute Service (ECS) instance
  • Eni: elastic network interface (ENI)
  • Eci: elastic container instance
  • Ip: IP address
port int
(Optional, Computed, Int) The port that is used by the backend server.
server_group_id str
The server group ID.
server_ip str
The IP address of the backend server.
status str
Indicates the status of the backend server.
serverId This property is required. String
The backend server ID.

  • If the server group is of the Instance type, set this parameter to the IDs of servers of the Ecs, Eni, or Eci type.
  • If the server group is of the Ip type, set ServerId to IP addresses.
serverType This property is required. String
The type of the backend server. Valid values:

  • Ecs: Elastic Compute Service (ECS) instance
  • Eni: elastic network interface (ENI)
  • Eci: elastic container instance
  • Ip: IP address
port Number
(Optional, Computed, Int) The port that is used by the backend server.
serverGroupId String
The server group ID.
serverIp String
The IP address of the backend server.
status String
Indicates the status of the backend server.

Import

GWLB Server Group can be imported using the id, e.g.

$ pulumi import alicloud:gwlb/serverGroup:ServerGroup example <id>
Copy

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 alicloud Terraform Provider.