Alibaba Cloud v3.76.0, Apr 8 25

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.ga.EndpointGroup

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

Example Usage

Basic Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const region = config.get("region") || "cn-hangzhou";
const _default = new alicloud.ga.Accelerator("default", {
    duration: 1,
    autoUseCoupon: true,
    spec: "1",
});
const defaultBandwidthPackage = new alicloud.ga.BandwidthPackage("default", {
    bandwidth: 100,
    type: "Basic",
    bandwidthType: "Basic",
    paymentType: "PayAsYouGo",
    billingType: "PayBy95",
    ratio: 30,
});
const defaultBandwidthPackageAttachment = new alicloud.ga.BandwidthPackageAttachment("default", {
    acceleratorId: _default.id,
    bandwidthPackageId: defaultBandwidthPackage.id,
});
const defaultListener = new alicloud.ga.Listener("default", {
    acceleratorId: defaultBandwidthPackageAttachment.acceleratorId,
    portRanges: [{
        fromPort: 60,
        toPort: 70,
    }],
    clientAffinity: "SOURCE_IP",
    protocol: "UDP",
    name: "terraform-example",
});
const defaultEipAddress: alicloud.ecs.EipAddress[] = [];
for (const range = {value: 0}; range.value < 2; range.value++) {
    defaultEipAddress.push(new alicloud.ecs.EipAddress(`default-${range.value}`, {
        bandwidth: "10",
        internetChargeType: "PayByBandwidth",
        addressName: "terraform-example",
    }));
}
const defaultEndpointGroup = new alicloud.ga.EndpointGroup("default", {
    acceleratorId: _default.id,
    endpointConfigurations: [
        {
            endpoint: defaultEipAddress[0].ipAddress,
            type: "PublicIp",
            weight: 20,
        },
        {
            endpoint: defaultEipAddress[1].ipAddress,
            type: "PublicIp",
            weight: 20,
        },
    ],
    endpointGroupRegion: region,
    listenerId: defaultListener.id,
});

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
region = config.get("region")
if region is None:
    region = "cn-hangzhou"
default = alicloud.ga.Accelerator("default",
    duration=1,
    auto_use_coupon=True,
    spec="1")
default_bandwidth_package = alicloud.ga.BandwidthPackage("default",
    bandwidth=100,
    type="Basic",
    bandwidth_type="Basic",
    payment_type="PayAsYouGo",
    billing_type="PayBy95",
    ratio=30)
default_bandwidth_package_attachment = alicloud.ga.BandwidthPackageAttachment("default",
    accelerator_id=default.id,
    bandwidth_package_id=default_bandwidth_package.id)
default_listener = alicloud.ga.Listener("default",
    accelerator_id=default_bandwidth_package_attachment.accelerator_id,
    port_ranges=[{
        "from_port": 60,
        "to_port": 70,
    }],
    client_affinity="SOURCE_IP",
    protocol="UDP",
    name="terraform-example")
default_eip_address = []
for range in [{"value": i} for i in range(0, 2)]:
    default_eip_address.append(alicloud.ecs.EipAddress(f"default-{range['value']}",
        bandwidth="10",
        internet_charge_type="PayByBandwidth",
        address_name="terraform-example"))
default_endpoint_group = alicloud.ga.EndpointGroup("default",
    accelerator_id=default.id,
    endpoint_configurations=[
        {
            "endpoint": default_eip_address[0].ip_address,
            "type": "PublicIp",
            "weight": 20,
        },
        {
            "endpoint": default_eip_address[1].ip_address,
            "type": "PublicIp",
            "weight": 20,
        },
    ],
    endpoint_group_region=region,
    listener_id=default_listener.id)

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ga"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		region := "cn-hangzhou"
		if param := cfg.Get("region"); param != "" {
			region = param
		}
		_default, err := ga.NewAccelerator(ctx, "default", &ga.AcceleratorArgs{
			Duration:      pulumi.Int(1),
			AutoUseCoupon: pulumi.Bool(true),
			Spec:          pulumi.String("1"),
		})
		if err != nil {
			return err
		}
		defaultBandwidthPackage, err := ga.NewBandwidthPackage(ctx, "default", &ga.BandwidthPackageArgs{
			Bandwidth:     pulumi.Int(100),
			Type:          pulumi.String("Basic"),
			BandwidthType: pulumi.String("Basic"),
			PaymentType:   pulumi.String("PayAsYouGo"),
			BillingType:   pulumi.String("PayBy95"),
			Ratio:         pulumi.Int(30),
		})
		if err != nil {
			return err
		}
		defaultBandwidthPackageAttachment, err := ga.NewBandwidthPackageAttachment(ctx, "default", &ga.BandwidthPackageAttachmentArgs{
			AcceleratorId:      _default.ID(),
			BandwidthPackageId: defaultBandwidthPackage.ID(),
		})
		if err != nil {
			return err
		}
		defaultListener, err := ga.NewListener(ctx, "default", &ga.ListenerArgs{
			AcceleratorId: defaultBandwidthPackageAttachment.AcceleratorId,
			PortRanges: ga.ListenerPortRangeArray{
				&ga.ListenerPortRangeArgs{
					FromPort: pulumi.Int(60),
					ToPort:   pulumi.Int(70),
				},
			},
			ClientAffinity: pulumi.String("SOURCE_IP"),
			Protocol:       pulumi.String("UDP"),
			Name:           pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		var defaultEipAddress []*ecs.EipAddress
		for index := 0; index < 2; index++ {
			key0 := index
			_ := index
			__res, err := ecs.NewEipAddress(ctx, fmt.Sprintf("default-%v", key0), &ecs.EipAddressArgs{
				Bandwidth:          pulumi.String("10"),
				InternetChargeType: pulumi.String("PayByBandwidth"),
				AddressName:        pulumi.String("terraform-example"),
			})
			if err != nil {
				return err
			}
			defaultEipAddress = append(defaultEipAddress, __res)
		}
		_, err = ga.NewEndpointGroup(ctx, "default", &ga.EndpointGroupArgs{
			AcceleratorId: _default.ID(),
			EndpointConfigurations: ga.EndpointGroupEndpointConfigurationArray{
				&ga.EndpointGroupEndpointConfigurationArgs{
					Endpoint: defaultEipAddress[0].IpAddress,
					Type:     pulumi.String("PublicIp"),
					Weight:   pulumi.Int(20),
				},
				&ga.EndpointGroupEndpointConfigurationArgs{
					Endpoint: defaultEipAddress[1].IpAddress,
					Type:     pulumi.String("PublicIp"),
					Weight:   pulumi.Int(20),
				},
			},
			EndpointGroupRegion: pulumi.String(region),
			ListenerId:          defaultListener.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var region = config.Get("region") ?? "cn-hangzhou";
    var @default = new AliCloud.Ga.Accelerator("default", new()
    {
        Duration = 1,
        AutoUseCoupon = true,
        Spec = "1",
    });

    var defaultBandwidthPackage = new AliCloud.Ga.BandwidthPackage("default", new()
    {
        Bandwidth = 100,
        Type = "Basic",
        BandwidthType = "Basic",
        PaymentType = "PayAsYouGo",
        BillingType = "PayBy95",
        Ratio = 30,
    });

    var defaultBandwidthPackageAttachment = new AliCloud.Ga.BandwidthPackageAttachment("default", new()
    {
        AcceleratorId = @default.Id,
        BandwidthPackageId = defaultBandwidthPackage.Id,
    });

    var defaultListener = new AliCloud.Ga.Listener("default", new()
    {
        AcceleratorId = defaultBandwidthPackageAttachment.AcceleratorId,
        PortRanges = new[]
        {
            new AliCloud.Ga.Inputs.ListenerPortRangeArgs
            {
                FromPort = 60,
                ToPort = 70,
            },
        },
        ClientAffinity = "SOURCE_IP",
        Protocol = "UDP",
        Name = "terraform-example",
    });

    var defaultEipAddress = new List<AliCloud.Ecs.EipAddress>();
    for (var rangeIndex = 0; rangeIndex < 2; rangeIndex++)
    {
        var range = new { Value = rangeIndex };
        defaultEipAddress.Add(new AliCloud.Ecs.EipAddress($"default-{range.Value}", new()
        {
            Bandwidth = "10",
            InternetChargeType = "PayByBandwidth",
            AddressName = "terraform-example",
        }));
    }
    var defaultEndpointGroup = new AliCloud.Ga.EndpointGroup("default", new()
    {
        AcceleratorId = @default.Id,
        EndpointConfigurations = new[]
        {
            new AliCloud.Ga.Inputs.EndpointGroupEndpointConfigurationArgs
            {
                Endpoint = defaultEipAddress[0].IpAddress,
                Type = "PublicIp",
                Weight = 20,
            },
            new AliCloud.Ga.Inputs.EndpointGroupEndpointConfigurationArgs
            {
                Endpoint = defaultEipAddress[1].IpAddress,
                Type = "PublicIp",
                Weight = 20,
            },
        },
        EndpointGroupRegion = region,
        ListenerId = defaultListener.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.ga.Accelerator;
import com.pulumi.alicloud.ga.AcceleratorArgs;
import com.pulumi.alicloud.ga.BandwidthPackage;
import com.pulumi.alicloud.ga.BandwidthPackageArgs;
import com.pulumi.alicloud.ga.BandwidthPackageAttachment;
import com.pulumi.alicloud.ga.BandwidthPackageAttachmentArgs;
import com.pulumi.alicloud.ga.Listener;
import com.pulumi.alicloud.ga.ListenerArgs;
import com.pulumi.alicloud.ga.inputs.ListenerPortRangeArgs;
import com.pulumi.alicloud.ecs.EipAddress;
import com.pulumi.alicloud.ecs.EipAddressArgs;
import com.pulumi.alicloud.ga.EndpointGroup;
import com.pulumi.alicloud.ga.EndpointGroupArgs;
import com.pulumi.alicloud.ga.inputs.EndpointGroupEndpointConfigurationArgs;
import com.pulumi.codegen.internal.KeyedValue;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var region = config.get("region").orElse("cn-hangzhou");
        var default_ = new Accelerator("default", AcceleratorArgs.builder()
            .duration(1)
            .autoUseCoupon(true)
            .spec("1")
            .build());

        var defaultBandwidthPackage = new BandwidthPackage("defaultBandwidthPackage", BandwidthPackageArgs.builder()
            .bandwidth(100)
            .type("Basic")
            .bandwidthType("Basic")
            .paymentType("PayAsYouGo")
            .billingType("PayBy95")
            .ratio(30)
            .build());

        var defaultBandwidthPackageAttachment = new BandwidthPackageAttachment("defaultBandwidthPackageAttachment", BandwidthPackageAttachmentArgs.builder()
            .acceleratorId(default_.id())
            .bandwidthPackageId(defaultBandwidthPackage.id())
            .build());

        var defaultListener = new Listener("defaultListener", ListenerArgs.builder()
            .acceleratorId(defaultBandwidthPackageAttachment.acceleratorId())
            .portRanges(ListenerPortRangeArgs.builder()
                .fromPort(60)
                .toPort(70)
                .build())
            .clientAffinity("SOURCE_IP")
            .protocol("UDP")
            .name("terraform-example")
            .build());

        for (var i = 0; i < 2; i++) {
            new EipAddress("defaultEipAddress-" + i, EipAddressArgs.builder()
                .bandwidth("10")
                .internetChargeType("PayByBandwidth")
                .addressName("terraform-example")
                .build());

        
}
        var defaultEndpointGroup = new EndpointGroup("defaultEndpointGroup", EndpointGroupArgs.builder()
            .acceleratorId(default_.id())
            .endpointConfigurations(            
                EndpointGroupEndpointConfigurationArgs.builder()
                    .endpoint(defaultEipAddress[0].ipAddress())
                    .type("PublicIp")
                    .weight("20")
                    .build(),
                EndpointGroupEndpointConfigurationArgs.builder()
                    .endpoint(defaultEipAddress[1].ipAddress())
                    .type("PublicIp")
                    .weight("20")
                    .build())
            .endpointGroupRegion(region)
            .listenerId(defaultListener.id())
            .build());

    }
}

configuration:
  region:
    type: string
    default: cn-hangzhou
resources:
  default:
    type: alicloud:ga:Accelerator
    properties:
      duration: 1
      autoUseCoupon: true
      spec: '1'
  defaultBandwidthPackage:
    type: alicloud:ga:BandwidthPackage
    name: default
    properties:
      bandwidth: 100
      type: Basic
      bandwidthType: Basic
      paymentType: PayAsYouGo
      billingType: PayBy95
      ratio: 30
  defaultBandwidthPackageAttachment:
    type: alicloud:ga:BandwidthPackageAttachment
    name: default
    properties:
      acceleratorId: ${default.id}
      bandwidthPackageId: ${defaultBandwidthPackage.id}
  defaultListener:
    type: alicloud:ga:Listener
    name: default
    properties:
      acceleratorId: ${defaultBandwidthPackageAttachment.acceleratorId}
      portRanges:
        - fromPort: 60
          toPort: 70
      clientAffinity: SOURCE_IP
      protocol: UDP
      name: terraform-example
  defaultEipAddress:
    type: alicloud:ecs:EipAddress
    name: default
    properties:
      bandwidth: '10'
      internetChargeType: PayByBandwidth
      addressName: terraform-example
    options: {}
  defaultEndpointGroup:
    type: alicloud:ga:EndpointGroup
    name: default
    properties:
      acceleratorId: ${default.id}
      endpointConfigurations:
        - endpoint: ${defaultEipAddress[0].ipAddress}
          type: PublicIp
          weight: '20'
        - endpoint: ${defaultEipAddress[1].ipAddress}
          type: PublicIp
          weight: '20'
      endpointGroupRegion: ${region}
      listenerId: ${defaultListener.id}

Create EndpointGroup Resource

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

new EndpointGroup(name: string, args: EndpointGroupArgs, opts?: CustomResourceOptions);

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

@overload
def EndpointGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  accelerator_id: Optional[str] = None,
                  listener_id: Optional[str] = None,
                  endpoint_configurations: Optional[Sequence[EndpointGroupEndpointConfigurationArgs]] = None,
                  endpoint_group_region: Optional[str] = None,
                  endpoint_group_type: Optional[str] = None,
                  health_check_protocol: Optional[str] = None,
                  endpoint_request_protocol: Optional[str] = None,
                  health_check_enabled: Optional[bool] = None,
                  health_check_interval_seconds: Optional[int] = None,
                  health_check_path: Optional[str] = None,
                  health_check_port: Optional[int] = None,
                  endpoint_protocol_version: Optional[str] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None,
                  port_overrides: Optional[EndpointGroupPortOverridesArgs] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  threshold_count: Optional[int] = None,
                  traffic_percentage: Optional[int] = None)

func NewEndpointGroup(ctx *Context, name string, args EndpointGroupArgs, opts ...ResourceOption) (*EndpointGroup, error)

public EndpointGroup(string name, EndpointGroupArgs args, CustomResourceOptions? opts = null)

public EndpointGroup(String name, EndpointGroupArgs args)
public EndpointGroup(String name, EndpointGroupArgs args, CustomResourceOptions options)

type: alicloud:ga:EndpointGroup
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 EndpointGroupArgs: 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 EndpointGroupArgs: 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 EndpointGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EndpointGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EndpointGroupArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var endpointGroupResource = new AliCloud.Ga.EndpointGroup("endpointGroupResource", new()
{
    AcceleratorId = "string",
    ListenerId = "string",
    EndpointConfigurations = new[]
    {
        new AliCloud.Ga.Inputs.EndpointGroupEndpointConfigurationArgs
        {
            Endpoint = "string",
            Type = "string",
            Weight = 0,
            EnableClientipPreservation = false,
            EnableProxyProtocol = false,
            SubAddress = "string",
        },
    },
    EndpointGroupRegion = "string",
    EndpointGroupType = "string",
    HealthCheckProtocol = "string",
    EndpointRequestProtocol = "string",
    HealthCheckEnabled = false,
    HealthCheckIntervalSeconds = 0,
    HealthCheckPath = "string",
    HealthCheckPort = 0,
    EndpointProtocolVersion = "string",
    Description = "string",
    Name = "string",
    PortOverrides = new AliCloud.Ga.Inputs.EndpointGroupPortOverridesArgs
    {
        EndpointPort = 0,
        ListenerPort = 0,
    },
    Tags = 
    {
        { "string", "string" },
    },
    ThresholdCount = 0,
    TrafficPercentage = 0,
});

example, err := ga.NewEndpointGroup(ctx, "endpointGroupResource", &ga.EndpointGroupArgs{
	AcceleratorId: pulumi.String("string"),
	ListenerId:    pulumi.String("string"),
	EndpointConfigurations: ga.EndpointGroupEndpointConfigurationArray{
		&ga.EndpointGroupEndpointConfigurationArgs{
			Endpoint:                   pulumi.String("string"),
			Type:                       pulumi.String("string"),
			Weight:                     pulumi.Int(0),
			EnableClientipPreservation: pulumi.Bool(false),
			EnableProxyProtocol:        pulumi.Bool(false),
			SubAddress:                 pulumi.String("string"),
		},
	},
	EndpointGroupRegion:        pulumi.String("string"),
	EndpointGroupType:          pulumi.String("string"),
	HealthCheckProtocol:        pulumi.String("string"),
	EndpointRequestProtocol:    pulumi.String("string"),
	HealthCheckEnabled:         pulumi.Bool(false),
	HealthCheckIntervalSeconds: pulumi.Int(0),
	HealthCheckPath:            pulumi.String("string"),
	HealthCheckPort:            pulumi.Int(0),
	EndpointProtocolVersion:    pulumi.String("string"),
	Description:                pulumi.String("string"),
	Name:                       pulumi.String("string"),
	PortOverrides: &ga.EndpointGroupPortOverridesArgs{
		EndpointPort: pulumi.Int(0),
		ListenerPort: pulumi.Int(0),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ThresholdCount:    pulumi.Int(0),
	TrafficPercentage: pulumi.Int(0),
})

var endpointGroupResource = new EndpointGroup("endpointGroupResource", EndpointGroupArgs.builder()
    .acceleratorId("string")
    .listenerId("string")
    .endpointConfigurations(EndpointGroupEndpointConfigurationArgs.builder()
        .endpoint("string")
        .type("string")
        .weight(0)
        .enableClientipPreservation(false)
        .enableProxyProtocol(false)
        .subAddress("string")
        .build())
    .endpointGroupRegion("string")
    .endpointGroupType("string")
    .healthCheckProtocol("string")
    .endpointRequestProtocol("string")
    .healthCheckEnabled(false)
    .healthCheckIntervalSeconds(0)
    .healthCheckPath("string")
    .healthCheckPort(0)
    .endpointProtocolVersion("string")
    .description("string")
    .name("string")
    .portOverrides(EndpointGroupPortOverridesArgs.builder()
        .endpointPort(0)
        .listenerPort(0)
        .build())
    .tags(Map.of("string", "string"))
    .thresholdCount(0)
    .trafficPercentage(0)
    .build());

endpoint_group_resource = alicloud.ga.EndpointGroup("endpointGroupResource",
    accelerator_id="string",
    listener_id="string",
    endpoint_configurations=[{
        "endpoint": "string",
        "type": "string",
        "weight": 0,
        "enable_clientip_preservation": False,
        "enable_proxy_protocol": False,
        "sub_address": "string",
    }],
    endpoint_group_region="string",
    endpoint_group_type="string",
    health_check_protocol="string",
    endpoint_request_protocol="string",
    health_check_enabled=False,
    health_check_interval_seconds=0,
    health_check_path="string",
    health_check_port=0,
    endpoint_protocol_version="string",
    description="string",
    name="string",
    port_overrides={
        "endpoint_port": 0,
        "listener_port": 0,
    },
    tags={
        "string": "string",
    },
    threshold_count=0,
    traffic_percentage=0)

const endpointGroupResource = new alicloud.ga.EndpointGroup("endpointGroupResource", {
    acceleratorId: "string",
    listenerId: "string",
    endpointConfigurations: [{
        endpoint: "string",
        type: "string",
        weight: 0,
        enableClientipPreservation: false,
        enableProxyProtocol: false,
        subAddress: "string",
    }],
    endpointGroupRegion: "string",
    endpointGroupType: "string",
    healthCheckProtocol: "string",
    endpointRequestProtocol: "string",
    healthCheckEnabled: false,
    healthCheckIntervalSeconds: 0,
    healthCheckPath: "string",
    healthCheckPort: 0,
    endpointProtocolVersion: "string",
    description: "string",
    name: "string",
    portOverrides: {
        endpointPort: 0,
        listenerPort: 0,
    },
    tags: {
        string: "string",
    },
    thresholdCount: 0,
    trafficPercentage: 0,
});

type: alicloud:ga:EndpointGroup
properties:
    acceleratorId: string
    description: string
    endpointConfigurations:
        - enableClientipPreservation: false
          enableProxyProtocol: false
          endpoint: string
          subAddress: string
          type: string
          weight: 0
    endpointGroupRegion: string
    endpointGroupType: string
    endpointProtocolVersion: string
    endpointRequestProtocol: string
    healthCheckEnabled: false
    healthCheckIntervalSeconds: 0
    healthCheckPath: string
    healthCheckPort: 0
    healthCheckProtocol: string
    listenerId: string
    name: string
    portOverrides:
        endpointPort: 0
        listenerPort: 0
    tags:
        string: string
    thresholdCount: 0
    trafficPercentage: 0

EndpointGroup 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 EndpointGroup resource accepts the following input properties:

AcceleratorId string

The ID of the Global Accelerator instance to which the endpoint group will be added.

EndpointConfigurations List<Pulumi.AliCloud.Ga.Inputs.EndpointGroupEndpointConfiguration>

The endpointConfigurations of the endpoint group. See endpoint_configurations below.

EndpointGroupRegion string

The ID of the region where the endpoint group is deployed.

ListenerId string

The ID of the listener that is associated with the endpoint group.

Description string

The description of the endpoint group.

EndpointGroupType string

The endpoint group type. Default value: default. Valid values: default, virtual.

NOTE: Currently, only HTTP or HTTPS protocol listener can directly create a virtual Endpoint Group. If it is TCP protocol listener, and you want to create a virtual Endpoint Group, please ensure that the default Endpoint Group has been created.

EndpointProtocolVersion string

The backend service protocol of the endpoint that is associated with the intelligent routing listener. Valid values: HTTP1.1, HTTP2.

NOTE: endpoint_protocol_version is valid only when endpoint_request_protocol is set to HTTPS.

EndpointRequestProtocol string

The protocol that is used by the backend server. Valid values: HTTP, HTTPS.

NOTE: endpoint_request_protocol can be specified only if the listener that is associated with the endpoint group uses HTTP or HTTPS. For the listener of HTTP protocol, endpoint_request_protocol can only be set to HTTP.

HealthCheckEnabled bool

Specifies whether to enable the health check feature. Valid values:

HealthCheckIntervalSeconds int

The interval between two consecutive health checks. Unit: seconds.

HealthCheckPath string

The path specified as the destination of the targets for health checks.

HealthCheckPort int

The port that is used for health checks.

HealthCheckProtocol string

The protocol that is used to connect to the targets for health checks. Valid values:

TCP or tcp: TCP protocol.
HTTP or http: HTTP protocol.
HTTPS or https: HTTPS protocol.

NOTE: From version 1.223.0, health_check_protocol can be set to TCP, HTTP, HTTPS.

Name string

The name of the endpoint group.

PortOverrides Pulumi.AliCloud.Ga.Inputs.EndpointGroupPortOverrides

Mapping between listening port and forwarding port of boarding point. See port_overrides below.

NOTE: Port mapping is only supported when creating terminal node group for listening instance of HTTP or HTTPS protocol. The listening port in the port map must be consistent with the listening port of the current listening instance.

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

ThresholdCount int

The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value: 3.

TrafficPercentage int

The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

AcceleratorId string

The ID of the Global Accelerator instance to which the endpoint group will be added.

EndpointConfigurations []EndpointGroupEndpointConfigurationArgs

The endpointConfigurations of the endpoint group. See endpoint_configurations below.

EndpointGroupRegion string

The ID of the region where the endpoint group is deployed.

ListenerId string

The ID of the listener that is associated with the endpoint group.

Description string

The description of the endpoint group.

EndpointGroupType string

The endpoint group type. Default value: default. Valid values: default, virtual.

NOTE: Currently, only HTTP or HTTPS protocol listener can directly create a virtual Endpoint Group. If it is TCP protocol listener, and you want to create a virtual Endpoint Group, please ensure that the default Endpoint Group has been created.

EndpointProtocolVersion string

The backend service protocol of the endpoint that is associated with the intelligent routing listener. Valid values: HTTP1.1, HTTP2.

NOTE: endpoint_protocol_version is valid only when endpoint_request_protocol is set to HTTPS.

EndpointRequestProtocol string

The protocol that is used by the backend server. Valid values: HTTP, HTTPS.

NOTE: endpoint_request_protocol can be specified only if the listener that is associated with the endpoint group uses HTTP or HTTPS. For the listener of HTTP protocol, endpoint_request_protocol can only be set to HTTP.

HealthCheckEnabled bool

Specifies whether to enable the health check feature. Valid values:

HealthCheckIntervalSeconds int

The interval between two consecutive health checks. Unit: seconds.

HealthCheckPath string

The path specified as the destination of the targets for health checks.

HealthCheckPort int

The port that is used for health checks.

HealthCheckProtocol string

The protocol that is used to connect to the targets for health checks. Valid values:

TCP or tcp: TCP protocol.
HTTP or http: HTTP protocol.
HTTPS or https: HTTPS protocol.

NOTE: From version 1.223.0, health_check_protocol can be set to TCP, HTTP, HTTPS.

Name string

The name of the endpoint group.

PortOverrides EndpointGroupPortOverridesArgs

Mapping between listening port and forwarding port of boarding point. See port_overrides below.

NOTE: Port mapping is only supported when creating terminal node group for listening instance of HTTP or HTTPS protocol. The listening port in the port map must be consistent with the listening port of the current listening instance.

Tags map[string]string

A mapping of tags to assign to the resource.

ThresholdCount int

The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value: 3.

TrafficPercentage int

The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

acceleratorId String

The ID of the Global Accelerator instance to which the endpoint group will be added.

endpointConfigurations List<EndpointGroupEndpointConfiguration>

The endpointConfigurations of the endpoint group. See endpoint_configurations below.

endpointGroupRegion String

The ID of the region where the endpoint group is deployed.

listenerId String

The ID of the listener that is associated with the endpoint group.

description String

The description of the endpoint group.

endpointGroupType String

The endpoint group type. Default value: default. Valid values: default, virtual.

NOTE: Currently, only HTTP or HTTPS protocol listener can directly create a virtual Endpoint Group. If it is TCP protocol listener, and you want to create a virtual Endpoint Group, please ensure that the default Endpoint Group has been created.

endpointProtocolVersion String

The backend service protocol of the endpoint that is associated with the intelligent routing listener. Valid values: HTTP1.1, HTTP2.

NOTE: endpoint_protocol_version is valid only when endpoint_request_protocol is set to HTTPS.

endpointRequestProtocol String

The protocol that is used by the backend server. Valid values: HTTP, HTTPS.

NOTE: endpoint_request_protocol can be specified only if the listener that is associated with the endpoint group uses HTTP or HTTPS. For the listener of HTTP protocol, endpoint_request_protocol can only be set to HTTP.

healthCheckEnabled Boolean

Specifies whether to enable the health check feature. Valid values:

healthCheckIntervalSeconds Integer

The interval between two consecutive health checks. Unit: seconds.

healthCheckPath String

The path specified as the destination of the targets for health checks.

healthCheckPort Integer

The port that is used for health checks.

healthCheckProtocol String

The protocol that is used to connect to the targets for health checks. Valid values:

TCP or tcp: TCP protocol.
HTTP or http: HTTP protocol.
HTTPS or https: HTTPS protocol.

NOTE: From version 1.223.0, health_check_protocol can be set to TCP, HTTP, HTTPS.

name String

The name of the endpoint group.

portOverrides EndpointGroupPortOverrides

Mapping between listening port and forwarding port of boarding point. See port_overrides below.

NOTE: Port mapping is only supported when creating terminal node group for listening instance of HTTP or HTTPS protocol. The listening port in the port map must be consistent with the listening port of the current listening instance.

tags Map<String,String>

A mapping of tags to assign to the resource.

thresholdCount Integer

The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value: 3.

trafficPercentage Integer

The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

acceleratorId string

The ID of the Global Accelerator instance to which the endpoint group will be added.

endpointConfigurations EndpointGroupEndpointConfiguration[]

The endpointConfigurations of the endpoint group. See endpoint_configurations below.

endpointGroupRegion string

The ID of the region where the endpoint group is deployed.

listenerId string

The ID of the listener that is associated with the endpoint group.

description string

The description of the endpoint group.

endpointGroupType string

The endpoint group type. Default value: default. Valid values: default, virtual.

NOTE: Currently, only HTTP or HTTPS protocol listener can directly create a virtual Endpoint Group. If it is TCP protocol listener, and you want to create a virtual Endpoint Group, please ensure that the default Endpoint Group has been created.

endpointProtocolVersion string

The backend service protocol of the endpoint that is associated with the intelligent routing listener. Valid values: HTTP1.1, HTTP2.

NOTE: endpoint_protocol_version is valid only when endpoint_request_protocol is set to HTTPS.

endpointRequestProtocol string

The protocol that is used by the backend server. Valid values: HTTP, HTTPS.

NOTE: endpoint_request_protocol can be specified only if the listener that is associated with the endpoint group uses HTTP or HTTPS. For the listener of HTTP protocol, endpoint_request_protocol can only be set to HTTP.

healthCheckEnabled boolean

Specifies whether to enable the health check feature. Valid values:

healthCheckIntervalSeconds number

The interval between two consecutive health checks. Unit: seconds.

healthCheckPath string

The path specified as the destination of the targets for health checks.

healthCheckPort number

The port that is used for health checks.

healthCheckProtocol string

The protocol that is used to connect to the targets for health checks. Valid values:

TCP or tcp: TCP protocol.
HTTP or http: HTTP protocol.
HTTPS or https: HTTPS protocol.

NOTE: From version 1.223.0, health_check_protocol can be set to TCP, HTTP, HTTPS.

name string

The name of the endpoint group.

portOverrides EndpointGroupPortOverrides

Mapping between listening port and forwarding port of boarding point. See port_overrides below.

NOTE: Port mapping is only supported when creating terminal node group for listening instance of HTTP or HTTPS protocol. The listening port in the port map must be consistent with the listening port of the current listening instance.

tags {[key: string]: string}

A mapping of tags to assign to the resource.

thresholdCount number

The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value: 3.

trafficPercentage number

The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

accelerator_id str

The ID of the Global Accelerator instance to which the endpoint group will be added.

endpoint_configurations Sequence[EndpointGroupEndpointConfigurationArgs]

The endpointConfigurations of the endpoint group. See endpoint_configurations below.

endpoint_group_region str

The ID of the region where the endpoint group is deployed.

listener_id str

The ID of the listener that is associated with the endpoint group.

description str

The description of the endpoint group.

endpoint_group_type str

The endpoint group type. Default value: default. Valid values: default, virtual.

NOTE: Currently, only HTTP or HTTPS protocol listener can directly create a virtual Endpoint Group. If it is TCP protocol listener, and you want to create a virtual Endpoint Group, please ensure that the default Endpoint Group has been created.

endpoint_protocol_version str

The backend service protocol of the endpoint that is associated with the intelligent routing listener. Valid values: HTTP1.1, HTTP2.

NOTE: endpoint_protocol_version is valid only when endpoint_request_protocol is set to HTTPS.

endpoint_request_protocol str

The protocol that is used by the backend server. Valid values: HTTP, HTTPS.

NOTE: endpoint_request_protocol can be specified only if the listener that is associated with the endpoint group uses HTTP or HTTPS. For the listener of HTTP protocol, endpoint_request_protocol can only be set to HTTP.

health_check_enabled bool

Specifies whether to enable the health check feature. Valid values:

health_check_interval_seconds int

The interval between two consecutive health checks. Unit: seconds.

health_check_path str

The path specified as the destination of the targets for health checks.

health_check_port int

The port that is used for health checks.

health_check_protocol str

The protocol that is used to connect to the targets for health checks. Valid values:

TCP or tcp: TCP protocol.
HTTP or http: HTTP protocol.
HTTPS or https: HTTPS protocol.

NOTE: From version 1.223.0, health_check_protocol can be set to TCP, HTTP, HTTPS.

name str

The name of the endpoint group.

port_overrides EndpointGroupPortOverridesArgs

Mapping between listening port and forwarding port of boarding point. See port_overrides below.

NOTE: Port mapping is only supported when creating terminal node group for listening instance of HTTP or HTTPS protocol. The listening port in the port map must be consistent with the listening port of the current listening instance.

tags Mapping[str, str]

A mapping of tags to assign to the resource.

threshold_count int

The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value: 3.

traffic_percentage int

The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

acceleratorId String

The ID of the Global Accelerator instance to which the endpoint group will be added.

endpointConfigurations List<Property Map>

The endpointConfigurations of the endpoint group. See endpoint_configurations below.

endpointGroupRegion String

The ID of the region where the endpoint group is deployed.

listenerId String

The ID of the listener that is associated with the endpoint group.

description String

The description of the endpoint group.

endpointGroupType String

The endpoint group type. Default value: default. Valid values: default, virtual.

NOTE: Currently, only HTTP or HTTPS protocol listener can directly create a virtual Endpoint Group. If it is TCP protocol listener, and you want to create a virtual Endpoint Group, please ensure that the default Endpoint Group has been created.

endpointProtocolVersion String

The backend service protocol of the endpoint that is associated with the intelligent routing listener. Valid values: HTTP1.1, HTTP2.

NOTE: endpoint_protocol_version is valid only when endpoint_request_protocol is set to HTTPS.

endpointRequestProtocol String

The protocol that is used by the backend server. Valid values: HTTP, HTTPS.

NOTE: endpoint_request_protocol can be specified only if the listener that is associated with the endpoint group uses HTTP or HTTPS. For the listener of HTTP protocol, endpoint_request_protocol can only be set to HTTP.

healthCheckEnabled Boolean

Specifies whether to enable the health check feature. Valid values:

healthCheckIntervalSeconds Number

The interval between two consecutive health checks. Unit: seconds.

healthCheckPath String

The path specified as the destination of the targets for health checks.

healthCheckPort Number

The port that is used for health checks.

healthCheckProtocol String

The protocol that is used to connect to the targets for health checks. Valid values:

TCP or tcp: TCP protocol.
HTTP or http: HTTP protocol.
HTTPS or https: HTTPS protocol.

NOTE: From version 1.223.0, health_check_protocol can be set to TCP, HTTP, HTTPS.

name String

The name of the endpoint group.

portOverrides Property Map

Mapping between listening port and forwarding port of boarding point. See port_overrides below.

NOTE: Port mapping is only supported when creating terminal node group for listening instance of HTTP or HTTPS protocol. The listening port in the port map must be consistent with the listening port of the current listening instance.

tags Map<String>

A mapping of tags to assign to the resource.

thresholdCount Number

The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value: 3.

trafficPercentage Number

The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

Outputs

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

EndpointGroupIpLists List<string>: (Available since v1.213.0) The active endpoint IP addresses of the endpoint group. endpoint_group_ip_list will change with the growth of network traffic. You can run pulumi up to query the latest CIDR blocks and IP addresses.
Id string: The provider-assigned unique ID for this managed resource.
Status string: The status of the endpoint group.

EndpointGroupIpLists []string: (Available since v1.213.0) The active endpoint IP addresses of the endpoint group. endpoint_group_ip_list will change with the growth of network traffic. You can run pulumi up to query the latest CIDR blocks and IP addresses.
Id string: The provider-assigned unique ID for this managed resource.
Status string: The status of the endpoint group.

endpointGroupIpLists List<String>: (Available since v1.213.0) The active endpoint IP addresses of the endpoint group. endpoint_group_ip_list will change with the growth of network traffic. You can run pulumi up to query the latest CIDR blocks and IP addresses.
id String: The provider-assigned unique ID for this managed resource.
status String: The status of the endpoint group.

endpointGroupIpLists string[]: (Available since v1.213.0) The active endpoint IP addresses of the endpoint group. endpoint_group_ip_list will change with the growth of network traffic. You can run pulumi up to query the latest CIDR blocks and IP addresses.
id string: The provider-assigned unique ID for this managed resource.
status string: The status of the endpoint group.

endpoint_group_ip_lists Sequence[str]: (Available since v1.213.0) The active endpoint IP addresses of the endpoint group. endpoint_group_ip_list will change with the growth of network traffic. You can run pulumi up to query the latest CIDR blocks and IP addresses.
id str: The provider-assigned unique ID for this managed resource.
status str: The status of the endpoint group.

endpointGroupIpLists List<String>: (Available since v1.213.0) The active endpoint IP addresses of the endpoint group. endpoint_group_ip_list will change with the growth of network traffic. You can run pulumi up to query the latest CIDR blocks and IP addresses.
id String: The provider-assigned unique ID for this managed resource.
status String: The status of the endpoint group.

Look up Existing EndpointGroup Resource

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

TypeScript
Python
Go
C#
Java
YAML

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accelerator_id: Optional[str] = None,
        description: Optional[str] = None,
        endpoint_configurations: Optional[Sequence[EndpointGroupEndpointConfigurationArgs]] = None,
        endpoint_group_ip_lists: Optional[Sequence[str]] = None,
        endpoint_group_region: Optional[str] = None,
        endpoint_group_type: Optional[str] = None,
        endpoint_protocol_version: Optional[str] = None,
        endpoint_request_protocol: Optional[str] = None,
        health_check_enabled: Optional[bool] = None,
        health_check_interval_seconds: Optional[int] = None,
        health_check_path: Optional[str] = None,
        health_check_port: Optional[int] = None,
        health_check_protocol: Optional[str] = None,
        listener_id: Optional[str] = None,
        name: Optional[str] = None,
        port_overrides: Optional[EndpointGroupPortOverridesArgs] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        threshold_count: Optional[int] = None,
        traffic_percentage: Optional[int] = None) -> EndpointGroup

func GetEndpointGroup(ctx *Context, name string, id IDInput, state *EndpointGroupState, opts ...ResourceOption) (*EndpointGroup, error)

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

public static EndpointGroup get(String name, Output<String> id, EndpointGroupState state, CustomResourceOptions options)

resources:  _:    type: alicloud:ga:EndpointGroup    get:      id: ${id}

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

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

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

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

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

The following state arguments are supported:

AcceleratorId string

The ID of the Global Accelerator instance to which the endpoint group will be added.

Description string

The description of the endpoint group.

EndpointConfigurations List<Pulumi.AliCloud.Ga.Inputs.EndpointGroupEndpointConfiguration>

The endpointConfigurations of the endpoint group. See endpoint_configurations below.

EndpointGroupIpLists List<string>

(Available since v1.213.0) The active endpoint IP addresses of the endpoint group. endpoint_group_ip_list will change with the growth of network traffic. You can run pulumi up to query the latest CIDR blocks and IP addresses.

EndpointGroupRegion string

The ID of the region where the endpoint group is deployed.

EndpointGroupType string

The endpoint group type. Default value: default. Valid values: default, virtual.

NOTE: Currently, only HTTP or HTTPS protocol listener can directly create a virtual Endpoint Group. If it is TCP protocol listener, and you want to create a virtual Endpoint Group, please ensure that the default Endpoint Group has been created.

EndpointProtocolVersion string

The backend service protocol of the endpoint that is associated with the intelligent routing listener. Valid values: HTTP1.1, HTTP2.

NOTE: endpoint_protocol_version is valid only when endpoint_request_protocol is set to HTTPS.

EndpointRequestProtocol string

The protocol that is used by the backend server. Valid values: HTTP, HTTPS.

NOTE: endpoint_request_protocol can be specified only if the listener that is associated with the endpoint group uses HTTP or HTTPS. For the listener of HTTP protocol, endpoint_request_protocol can only be set to HTTP.

HealthCheckEnabled bool

Specifies whether to enable the health check feature. Valid values:

HealthCheckIntervalSeconds int

The interval between two consecutive health checks. Unit: seconds.

HealthCheckPath string

The path specified as the destination of the targets for health checks.

HealthCheckPort int

The port that is used for health checks.

HealthCheckProtocol string

The protocol that is used to connect to the targets for health checks. Valid values:

TCP or tcp: TCP protocol.
HTTP or http: HTTP protocol.
HTTPS or https: HTTPS protocol.

NOTE: From version 1.223.0, health_check_protocol can be set to TCP, HTTP, HTTPS.

ListenerId string

The ID of the listener that is associated with the endpoint group.

Name string

The name of the endpoint group.

PortOverrides Pulumi.AliCloud.Ga.Inputs.EndpointGroupPortOverrides

Mapping between listening port and forwarding port of boarding point. See port_overrides below.

NOTE: Port mapping is only supported when creating terminal node group for listening instance of HTTP or HTTPS protocol. The listening port in the port map must be consistent with the listening port of the current listening instance.

Status string

The status of the endpoint group.

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

ThresholdCount int

The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value: 3.

TrafficPercentage int

The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

AcceleratorId string

The ID of the Global Accelerator instance to which the endpoint group will be added.

Description string

The description of the endpoint group.

EndpointConfigurations []EndpointGroupEndpointConfigurationArgs

The endpointConfigurations of the endpoint group. See endpoint_configurations below.

EndpointGroupIpLists []string

EndpointGroupRegion string

The ID of the region where the endpoint group is deployed.

EndpointGroupType string

The endpoint group type. Default value: default. Valid values: default, virtual.

NOTE: Currently, only HTTP or HTTPS protocol listener can directly create a virtual Endpoint Group. If it is TCP protocol listener, and you want to create a virtual Endpoint Group, please ensure that the default Endpoint Group has been created.

EndpointProtocolVersion string

The backend service protocol of the endpoint that is associated with the intelligent routing listener. Valid values: HTTP1.1, HTTP2.

NOTE: endpoint_protocol_version is valid only when endpoint_request_protocol is set to HTTPS.

EndpointRequestProtocol string

The protocol that is used by the backend server. Valid values: HTTP, HTTPS.

NOTE: endpoint_request_protocol can be specified only if the listener that is associated with the endpoint group uses HTTP or HTTPS. For the listener of HTTP protocol, endpoint_request_protocol can only be set to HTTP.

HealthCheckEnabled bool

Specifies whether to enable the health check feature. Valid values:

HealthCheckIntervalSeconds int

The interval between two consecutive health checks. Unit: seconds.

HealthCheckPath string

The path specified as the destination of the targets for health checks.

HealthCheckPort int

The port that is used for health checks.

HealthCheckProtocol string

The protocol that is used to connect to the targets for health checks. Valid values:

TCP or tcp: TCP protocol.
HTTP or http: HTTP protocol.
HTTPS or https: HTTPS protocol.

NOTE: From version 1.223.0, health_check_protocol can be set to TCP, HTTP, HTTPS.

ListenerId string

The ID of the listener that is associated with the endpoint group.

Name string

The name of the endpoint group.

PortOverrides EndpointGroupPortOverridesArgs

Mapping between listening port and forwarding port of boarding point. See port_overrides below.

NOTE: Port mapping is only supported when creating terminal node group for listening instance of HTTP or HTTPS protocol. The listening port in the port map must be consistent with the listening port of the current listening instance.

Status string

The status of the endpoint group.

Tags map[string]string

A mapping of tags to assign to the resource.

ThresholdCount int

The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value: 3.

TrafficPercentage int

The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

acceleratorId String

The ID of the Global Accelerator instance to which the endpoint group will be added.

description String

The description of the endpoint group.

endpointConfigurations List<EndpointGroupEndpointConfiguration>

The endpointConfigurations of the endpoint group. See endpoint_configurations below.

endpointGroupIpLists List<String>

endpointGroupRegion String

The ID of the region where the endpoint group is deployed.

endpointGroupType String

The endpoint group type. Default value: default. Valid values: default, virtual.

NOTE: Currently, only HTTP or HTTPS protocol listener can directly create a virtual Endpoint Group. If it is TCP protocol listener, and you want to create a virtual Endpoint Group, please ensure that the default Endpoint Group has been created.

endpointProtocolVersion String

The backend service protocol of the endpoint that is associated with the intelligent routing listener. Valid values: HTTP1.1, HTTP2.

NOTE: endpoint_protocol_version is valid only when endpoint_request_protocol is set to HTTPS.

endpointRequestProtocol String

The protocol that is used by the backend server. Valid values: HTTP, HTTPS.

NOTE: endpoint_request_protocol can be specified only if the listener that is associated with the endpoint group uses HTTP or HTTPS. For the listener of HTTP protocol, endpoint_request_protocol can only be set to HTTP.

healthCheckEnabled Boolean

Specifies whether to enable the health check feature. Valid values:

healthCheckIntervalSeconds Integer

The interval between two consecutive health checks. Unit: seconds.

healthCheckPath String

The path specified as the destination of the targets for health checks.

healthCheckPort Integer

The port that is used for health checks.

healthCheckProtocol String

The protocol that is used to connect to the targets for health checks. Valid values:

TCP or tcp: TCP protocol.
HTTP or http: HTTP protocol.
HTTPS or https: HTTPS protocol.

NOTE: From version 1.223.0, health_check_protocol can be set to TCP, HTTP, HTTPS.

listenerId String

The ID of the listener that is associated with the endpoint group.

name String

The name of the endpoint group.

portOverrides EndpointGroupPortOverrides

Mapping between listening port and forwarding port of boarding point. See port_overrides below.

NOTE: Port mapping is only supported when creating terminal node group for listening instance of HTTP or HTTPS protocol. The listening port in the port map must be consistent with the listening port of the current listening instance.

status String

The status of the endpoint group.

tags Map<String,String>

A mapping of tags to assign to the resource.

thresholdCount Integer

The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value: 3.

trafficPercentage Integer

The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

acceleratorId string

The ID of the Global Accelerator instance to which the endpoint group will be added.

description string

The description of the endpoint group.

endpointConfigurations EndpointGroupEndpointConfiguration[]

The endpointConfigurations of the endpoint group. See endpoint_configurations below.

endpointGroupIpLists string[]

endpointGroupRegion string

The ID of the region where the endpoint group is deployed.

endpointGroupType string

The endpoint group type. Default value: default. Valid values: default, virtual.

NOTE: Currently, only HTTP or HTTPS protocol listener can directly create a virtual Endpoint Group. If it is TCP protocol listener, and you want to create a virtual Endpoint Group, please ensure that the default Endpoint Group has been created.

endpointProtocolVersion string

The backend service protocol of the endpoint that is associated with the intelligent routing listener. Valid values: HTTP1.1, HTTP2.

NOTE: endpoint_protocol_version is valid only when endpoint_request_protocol is set to HTTPS.

endpointRequestProtocol string

The protocol that is used by the backend server. Valid values: HTTP, HTTPS.

NOTE: endpoint_request_protocol can be specified only if the listener that is associated with the endpoint group uses HTTP or HTTPS. For the listener of HTTP protocol, endpoint_request_protocol can only be set to HTTP.

healthCheckEnabled boolean

Specifies whether to enable the health check feature. Valid values:

healthCheckIntervalSeconds number

The interval between two consecutive health checks. Unit: seconds.

healthCheckPath string

The path specified as the destination of the targets for health checks.

healthCheckPort number

The port that is used for health checks.

healthCheckProtocol string

The protocol that is used to connect to the targets for health checks. Valid values:

TCP or tcp: TCP protocol.
HTTP or http: HTTP protocol.
HTTPS or https: HTTPS protocol.

NOTE: From version 1.223.0, health_check_protocol can be set to TCP, HTTP, HTTPS.

listenerId string

The ID of the listener that is associated with the endpoint group.

name string

The name of the endpoint group.

portOverrides EndpointGroupPortOverrides

Mapping between listening port and forwarding port of boarding point. See port_overrides below.

NOTE: Port mapping is only supported when creating terminal node group for listening instance of HTTP or HTTPS protocol. The listening port in the port map must be consistent with the listening port of the current listening instance.

status string

The status of the endpoint group.

tags {[key: string]: string}

A mapping of tags to assign to the resource.

thresholdCount number

The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value: 3.

trafficPercentage number

The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

accelerator_id str

The ID of the Global Accelerator instance to which the endpoint group will be added.

description str

The description of the endpoint group.

endpoint_configurations Sequence[EndpointGroupEndpointConfigurationArgs]

The endpointConfigurations of the endpoint group. See endpoint_configurations below.

endpoint_group_ip_lists Sequence[str]

endpoint_group_region str

The ID of the region where the endpoint group is deployed.

endpoint_group_type str

The endpoint group type. Default value: default. Valid values: default, virtual.

NOTE: Currently, only HTTP or HTTPS protocol listener can directly create a virtual Endpoint Group. If it is TCP protocol listener, and you want to create a virtual Endpoint Group, please ensure that the default Endpoint Group has been created.

endpoint_protocol_version str

The backend service protocol of the endpoint that is associated with the intelligent routing listener. Valid values: HTTP1.1, HTTP2.

NOTE: endpoint_protocol_version is valid only when endpoint_request_protocol is set to HTTPS.

endpoint_request_protocol str

The protocol that is used by the backend server. Valid values: HTTP, HTTPS.

NOTE: endpoint_request_protocol can be specified only if the listener that is associated with the endpoint group uses HTTP or HTTPS. For the listener of HTTP protocol, endpoint_request_protocol can only be set to HTTP.

health_check_enabled bool

Specifies whether to enable the health check feature. Valid values:

health_check_interval_seconds int

The interval between two consecutive health checks. Unit: seconds.

health_check_path str

The path specified as the destination of the targets for health checks.

health_check_port int

The port that is used for health checks.

health_check_protocol str

The protocol that is used to connect to the targets for health checks. Valid values:

TCP or tcp: TCP protocol.
HTTP or http: HTTP protocol.
HTTPS or https: HTTPS protocol.

NOTE: From version 1.223.0, health_check_protocol can be set to TCP, HTTP, HTTPS.

listener_id str

The ID of the listener that is associated with the endpoint group.

name str

The name of the endpoint group.

port_overrides EndpointGroupPortOverridesArgs

Mapping between listening port and forwarding port of boarding point. See port_overrides below.

NOTE: Port mapping is only supported when creating terminal node group for listening instance of HTTP or HTTPS protocol. The listening port in the port map must be consistent with the listening port of the current listening instance.

status str

The status of the endpoint group.

tags Mapping[str, str]

A mapping of tags to assign to the resource.

threshold_count int

The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value: 3.

traffic_percentage int

The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

acceleratorId String

The ID of the Global Accelerator instance to which the endpoint group will be added.

description String

The description of the endpoint group.

endpointConfigurations List<Property Map>

The endpointConfigurations of the endpoint group. See endpoint_configurations below.

endpointGroupIpLists List<String>

endpointGroupRegion String

The ID of the region where the endpoint group is deployed.

endpointGroupType String

The endpoint group type. Default value: default. Valid values: default, virtual.

NOTE: Currently, only HTTP or HTTPS protocol listener can directly create a virtual Endpoint Group. If it is TCP protocol listener, and you want to create a virtual Endpoint Group, please ensure that the default Endpoint Group has been created.

endpointProtocolVersion String

The backend service protocol of the endpoint that is associated with the intelligent routing listener. Valid values: HTTP1.1, HTTP2.

NOTE: endpoint_protocol_version is valid only when endpoint_request_protocol is set to HTTPS.

endpointRequestProtocol String

The protocol that is used by the backend server. Valid values: HTTP, HTTPS.

NOTE: endpoint_request_protocol can be specified only if the listener that is associated with the endpoint group uses HTTP or HTTPS. For the listener of HTTP protocol, endpoint_request_protocol can only be set to HTTP.

healthCheckEnabled Boolean

Specifies whether to enable the health check feature. Valid values:

healthCheckIntervalSeconds Number

The interval between two consecutive health checks. Unit: seconds.

healthCheckPath String

The path specified as the destination of the targets for health checks.

healthCheckPort Number

The port that is used for health checks.

healthCheckProtocol String

The protocol that is used to connect to the targets for health checks. Valid values:

TCP or tcp: TCP protocol.
HTTP or http: HTTP protocol.
HTTPS or https: HTTPS protocol.

NOTE: From version 1.223.0, health_check_protocol can be set to TCP, HTTP, HTTPS.

listenerId String

The ID of the listener that is associated with the endpoint group.

name String

The name of the endpoint group.

portOverrides Property Map

Mapping between listening port and forwarding port of boarding point. See port_overrides below.

NOTE: Port mapping is only supported when creating terminal node group for listening instance of HTTP or HTTPS protocol. The listening port in the port map must be consistent with the listening port of the current listening instance.

status String

The status of the endpoint group.

tags Map<String>

A mapping of tags to assign to the resource.

thresholdCount Number

The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value: 3.

trafficPercentage Number

The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

Supporting Types

EndpointGroupEndpointConfiguration
, EndpointGroupEndpointConfigurationArgs

Endpoint string

The IP address or domain name of Endpoint N in the endpoint group.

Type string

The type of Endpoint N in the endpoint group. Valid values:

Domain: A custom domain name.
Ip: A custom IP address.
PublicIp: An Alibaba Cloud public IP address.
ECS: An Elastic Compute Service (ECS) instance.
SLB: A Classic Load Balancer (CLB) instance.
ALB: An Application Load Balancer (ALB) instance.
NLB: A Network Load Balancer (NLB) instance.
ENI: An Elastic Network Interface (ENI).
OSS: An Object Storage Service (OSS) bucket.

NOTE: From version 1.232.0, type can be set to ALB, NLB, ENI, OSS.

Weight int

The weight of Endpoint N in the endpoint group. Valid values: 0 to 255.

NOTE: If the weight of a terminal node is set to 0, global acceleration will terminate the distribution of traffic to the terminal node. Please be careful.

EnableClientipPreservation bool

Indicates whether client IP addresses are reserved. Default Value: false. Valid values:

EnableProxyProtocol bool

Specifies whether to preserve client IP addresses by using the ProxyProtocol module. Default Value: false. Valid values:

SubAddress string

The private IP address of the ENI.

NOTE: sub_address is valid only when type is set to ENI.

Endpoint string

The IP address or domain name of Endpoint N in the endpoint group.

Type string

The type of Endpoint N in the endpoint group. Valid values:

Domain: A custom domain name.
Ip: A custom IP address.
PublicIp: An Alibaba Cloud public IP address.
ECS: An Elastic Compute Service (ECS) instance.
SLB: A Classic Load Balancer (CLB) instance.
ALB: An Application Load Balancer (ALB) instance.
NLB: A Network Load Balancer (NLB) instance.
ENI: An Elastic Network Interface (ENI).
OSS: An Object Storage Service (OSS) bucket.

NOTE: From version 1.232.0, type can be set to ALB, NLB, ENI, OSS.

Weight int

The weight of Endpoint N in the endpoint group. Valid values: 0 to 255.

NOTE: If the weight of a terminal node is set to 0, global acceleration will terminate the distribution of traffic to the terminal node. Please be careful.

EnableClientipPreservation bool

Indicates whether client IP addresses are reserved. Default Value: false. Valid values:

EnableProxyProtocol bool

Specifies whether to preserve client IP addresses by using the ProxyProtocol module. Default Value: false. Valid values:

SubAddress string

The private IP address of the ENI.

NOTE: sub_address is valid only when type is set to ENI.

endpoint String

The IP address or domain name of Endpoint N in the endpoint group.

type String

The type of Endpoint N in the endpoint group. Valid values:

Domain: A custom domain name.
Ip: A custom IP address.
PublicIp: An Alibaba Cloud public IP address.
ECS: An Elastic Compute Service (ECS) instance.
SLB: A Classic Load Balancer (CLB) instance.
ALB: An Application Load Balancer (ALB) instance.
NLB: A Network Load Balancer (NLB) instance.
ENI: An Elastic Network Interface (ENI).
OSS: An Object Storage Service (OSS) bucket.

NOTE: From version 1.232.0, type can be set to ALB, NLB, ENI, OSS.

weight Integer

The weight of Endpoint N in the endpoint group. Valid values: 0 to 255.

NOTE: If the weight of a terminal node is set to 0, global acceleration will terminate the distribution of traffic to the terminal node. Please be careful.

enableClientipPreservation Boolean

Indicates whether client IP addresses are reserved. Default Value: false. Valid values:

enableProxyProtocol Boolean

Specifies whether to preserve client IP addresses by using the ProxyProtocol module. Default Value: false. Valid values:

subAddress String

The private IP address of the ENI.

NOTE: sub_address is valid only when type is set to ENI.

endpoint string

The IP address or domain name of Endpoint N in the endpoint group.

type string

The type of Endpoint N in the endpoint group. Valid values:

Domain: A custom domain name.
Ip: A custom IP address.
PublicIp: An Alibaba Cloud public IP address.
ECS: An Elastic Compute Service (ECS) instance.
SLB: A Classic Load Balancer (CLB) instance.
ALB: An Application Load Balancer (ALB) instance.
NLB: A Network Load Balancer (NLB) instance.
ENI: An Elastic Network Interface (ENI).
OSS: An Object Storage Service (OSS) bucket.

NOTE: From version 1.232.0, type can be set to ALB, NLB, ENI, OSS.

weight number

The weight of Endpoint N in the endpoint group. Valid values: 0 to 255.

NOTE: If the weight of a terminal node is set to 0, global acceleration will terminate the distribution of traffic to the terminal node. Please be careful.

enableClientipPreservation boolean

Indicates whether client IP addresses are reserved. Default Value: false. Valid values:

enableProxyProtocol boolean

Specifies whether to preserve client IP addresses by using the ProxyProtocol module. Default Value: false. Valid values:

subAddress string

The private IP address of the ENI.

NOTE: sub_address is valid only when type is set to ENI.

endpoint str

The IP address or domain name of Endpoint N in the endpoint group.

type str

The type of Endpoint N in the endpoint group. Valid values:

Domain: A custom domain name.
Ip: A custom IP address.
PublicIp: An Alibaba Cloud public IP address.
ECS: An Elastic Compute Service (ECS) instance.
SLB: A Classic Load Balancer (CLB) instance.
ALB: An Application Load Balancer (ALB) instance.
NLB: A Network Load Balancer (NLB) instance.
ENI: An Elastic Network Interface (ENI).
OSS: An Object Storage Service (OSS) bucket.

NOTE: From version 1.232.0, type can be set to ALB, NLB, ENI, OSS.

weight int

The weight of Endpoint N in the endpoint group. Valid values: 0 to 255.

NOTE: If the weight of a terminal node is set to 0, global acceleration will terminate the distribution of traffic to the terminal node. Please be careful.

enable_clientip_preservation bool

Indicates whether client IP addresses are reserved. Default Value: false. Valid values:

enable_proxy_protocol bool

Specifies whether to preserve client IP addresses by using the ProxyProtocol module. Default Value: false. Valid values:

sub_address str

The private IP address of the ENI.

NOTE: sub_address is valid only when type is set to ENI.

endpoint String

The IP address or domain name of Endpoint N in the endpoint group.

type String

The type of Endpoint N in the endpoint group. Valid values:

Domain: A custom domain name.
Ip: A custom IP address.
PublicIp: An Alibaba Cloud public IP address.
ECS: An Elastic Compute Service (ECS) instance.
SLB: A Classic Load Balancer (CLB) instance.
ALB: An Application Load Balancer (ALB) instance.
NLB: A Network Load Balancer (NLB) instance.
ENI: An Elastic Network Interface (ENI).
OSS: An Object Storage Service (OSS) bucket.

NOTE: From version 1.232.0, type can be set to ALB, NLB, ENI, OSS.

weight Number

The weight of Endpoint N in the endpoint group. Valid values: 0 to 255.

NOTE: If the weight of a terminal node is set to 0, global acceleration will terminate the distribution of traffic to the terminal node. Please be careful.

enableClientipPreservation Boolean

Indicates whether client IP addresses are reserved. Default Value: false. Valid values:

enableProxyProtocol Boolean

Specifies whether to preserve client IP addresses by using the ProxyProtocol module. Default Value: false. Valid values:

subAddress String

The private IP address of the ENI.

NOTE: sub_address is valid only when type is set to ENI.

EndpointGroupPortOverrides
, EndpointGroupPortOverridesArgs

EndpointPort int: Forwarding port.
ListenerPort int: Listener port.

EndpointPort int: Forwarding port.
ListenerPort int: Listener port.

endpointPort Integer: Forwarding port.
listenerPort Integer: Listener port.

endpointPort number: Forwarding port.
listenerPort number: Listener port.

endpoint_port int: Forwarding port.
listener_port int: Listener port.

endpointPort Number: Forwarding port.
listenerPort Number: Listener port.

Import

Ga Endpoint Group can be imported using the id, e.g.

$ pulumi import alicloud:ga/endpointGroup:EndpointGroup 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 alicloud Terraform Provider.

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-alicloud

alicloud.ga.EndpointGroup

On this page

On this page

Example Usage

Create EndpointGroup Resource

Constructor syntax

Parameters

Constructor example

EndpointGroup Resource Properties

Inputs

Outputs

Look up Existing EndpointGroup Resource

Supporting Types

EndpointGroupEndpointConfiguration
, EndpointGroupEndpointConfigurationArgs

EndpointGroupPortOverrides
, EndpointGroupPortOverridesArgs

Import

Package Details

On this page

On this page

alicloud.ga.EndpointGroup

On this page

On this page

Example Usage

Create EndpointGroup Resource

Constructor syntax

Parameters

Constructor example

EndpointGroup Resource Properties

Inputs

Outputs

Look up Existing EndpointGroup Resource

Supporting Types

EndpointGroupEndpointConfiguration, EndpointGroupEndpointConfigurationArgs

EndpointGroupPortOverrides, EndpointGroupPortOverridesArgs

Import

Package Details

On this page

On this page

EndpointGroupEndpointConfiguration
, EndpointGroupEndpointConfigurationArgs

EndpointGroupPortOverrides
, EndpointGroupPortOverridesArgs