alicloud.ga.EndpointGroup
Provides a Global Accelerator (GA) Endpoint Group resource.
For information about Global Accelerator (GA) Endpoint Group and how to use it, see What is Endpoint Group.
NOTE: Available in v1.113.0+.
NOTE: Listeners that use different protocols support different types of endpoint groups:
- For a TCP or UDP listener, you can create only one default endpoint group.
- For an HTTP or HTTPS listener, you can create one default endpoint group and one virtual endpoint group. By default, you can create only one virtual endpoint group.
- A default endpoint group refers to the endpoint group that you configure when you create an HTTP or HTTPS listener.
- A virtual endpoint group refers to the endpoint group that you can create on the Endpoint Group page after you create a listener.
- After you create a virtual endpoint group for an HTTP or HTTPS listener, you can create a forwarding rule and associate the forwarding rule with the virtual endpoint group. Then, the HTTP or HTTPS listener forwards requests with different destination domain names or paths to the default or virtual endpoint group based on the forwarding rule. This way, you can use one Global Accelerator (GA) instance to accelerate access to multiple domain names or paths. For more information about how to create a forwarding rule, see Manage forwarding rules.
Example Usage
Basic Usage
using System.Collections.Generic;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var exampleAccelerator = new AliCloud.Ga.Accelerator("exampleAccelerator", new()
{
Duration = 1,
AutoUseCoupon = true,
Spec = "1",
});
var deBandwidthPackage = new AliCloud.Ga.BandwidthPackage("deBandwidthPackage", new()
{
Bandwidth = 100,
Type = "Basic",
BandwidthType = "Basic",
PaymentType = "PayAsYouGo",
BillingType = "PayBy95",
Ratio = 30,
});
var deBandwidthPackageAttachment = new AliCloud.Ga.BandwidthPackageAttachment("deBandwidthPackageAttachment", new()
{
AcceleratorId = exampleAccelerator.Id,
BandwidthPackageId = deBandwidthPackage.Id,
});
var exampleListener = new AliCloud.Ga.Listener("exampleListener", new()
{
AcceleratorId = exampleAccelerator.Id,
PortRanges = new[]
{
new AliCloud.Ga.Inputs.ListenerPortRangeArgs
{
FromPort = 60,
ToPort = 70,
},
},
}, new CustomResourceOptions
{
DependsOn = new[]
{
deBandwidthPackageAttachment,
},
});
var exampleEipAddress = new AliCloud.Ecs.EipAddress("exampleEipAddress", new()
{
Bandwidth = "10",
InternetChargeType = "PayByBandwidth",
});
var exampleEndpointGroup = new AliCloud.Ga.EndpointGroup("exampleEndpointGroup", new()
{
AcceleratorId = exampleAccelerator.Id,
EndpointConfigurations = new[]
{
new AliCloud.Ga.Inputs.EndpointGroupEndpointConfigurationArgs
{
Endpoint = exampleEipAddress.IpAddress,
Type = "PublicIp",
Weight = 20,
},
},
EndpointGroupRegion = "cn-hangzhou",
ListenerId = exampleListener.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"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleAccelerator, err := ga.NewAccelerator(ctx, "exampleAccelerator", &ga.AcceleratorArgs{
Duration: pulumi.Int(1),
AutoUseCoupon: pulumi.Bool(true),
Spec: pulumi.String("1"),
})
if err != nil {
return err
}
deBandwidthPackage, err := ga.NewBandwidthPackage(ctx, "deBandwidthPackage", &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
}
deBandwidthPackageAttachment, err := ga.NewBandwidthPackageAttachment(ctx, "deBandwidthPackageAttachment", &ga.BandwidthPackageAttachmentArgs{
AcceleratorId: exampleAccelerator.ID(),
BandwidthPackageId: deBandwidthPackage.ID(),
})
if err != nil {
return err
}
exampleListener, err := ga.NewListener(ctx, "exampleListener", &ga.ListenerArgs{
AcceleratorId: exampleAccelerator.ID(),
PortRanges: ga.ListenerPortRangeArray{
&ga.ListenerPortRangeArgs{
FromPort: pulumi.Int(60),
ToPort: pulumi.Int(70),
},
},
}, pulumi.DependsOn([]pulumi.Resource{
deBandwidthPackageAttachment,
}))
if err != nil {
return err
}
exampleEipAddress, err := ecs.NewEipAddress(ctx, "exampleEipAddress", &ecs.EipAddressArgs{
Bandwidth: pulumi.String("10"),
InternetChargeType: pulumi.String("PayByBandwidth"),
})
if err != nil {
return err
}
_, err = ga.NewEndpointGroup(ctx, "exampleEndpointGroup", &ga.EndpointGroupArgs{
AcceleratorId: exampleAccelerator.ID(),
EndpointConfigurations: ga.EndpointGroupEndpointConfigurationArray{
&ga.EndpointGroupEndpointConfigurationArgs{
Endpoint: exampleEipAddress.IpAddress,
Type: pulumi.String("PublicIp"),
Weight: pulumi.Int(20),
},
},
EndpointGroupRegion: pulumi.String("cn-hangzhou"),
ListenerId: exampleListener.ID(),
})
if err != nil {
return err
}
return nil
})
}
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.resources.CustomResourceOptions;
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) {
var exampleAccelerator = new Accelerator("exampleAccelerator", AcceleratorArgs.builder()
.duration(1)
.autoUseCoupon(true)
.spec("1")
.build());
var deBandwidthPackage = new BandwidthPackage("deBandwidthPackage", BandwidthPackageArgs.builder()
.bandwidth("100")
.type("Basic")
.bandwidthType("Basic")
.paymentType("PayAsYouGo")
.billingType("PayBy95")
.ratio(30)
.build());
var deBandwidthPackageAttachment = new BandwidthPackageAttachment("deBandwidthPackageAttachment", BandwidthPackageAttachmentArgs.builder()
.acceleratorId(exampleAccelerator.id())
.bandwidthPackageId(deBandwidthPackage.id())
.build());
var exampleListener = new Listener("exampleListener", ListenerArgs.builder()
.acceleratorId(exampleAccelerator.id())
.portRanges(ListenerPortRangeArgs.builder()
.fromPort(60)
.toPort(70)
.build())
.build(), CustomResourceOptions.builder()
.dependsOn(deBandwidthPackageAttachment)
.build());
var exampleEipAddress = new EipAddress("exampleEipAddress", EipAddressArgs.builder()
.bandwidth("10")
.internetChargeType("PayByBandwidth")
.build());
var exampleEndpointGroup = new EndpointGroup("exampleEndpointGroup", EndpointGroupArgs.builder()
.acceleratorId(exampleAccelerator.id())
.endpointConfigurations(EndpointGroupEndpointConfigurationArgs.builder()
.endpoint(exampleEipAddress.ipAddress())
.type("PublicIp")
.weight("20")
.build())
.endpointGroupRegion("cn-hangzhou")
.listenerId(exampleListener.id())
.build());
}
}
import pulumi
import pulumi_alicloud as alicloud
example_accelerator = alicloud.ga.Accelerator("exampleAccelerator",
duration=1,
auto_use_coupon=True,
spec="1")
de_bandwidth_package = alicloud.ga.BandwidthPackage("deBandwidthPackage",
bandwidth=100,
type="Basic",
bandwidth_type="Basic",
payment_type="PayAsYouGo",
billing_type="PayBy95",
ratio=30)
de_bandwidth_package_attachment = alicloud.ga.BandwidthPackageAttachment("deBandwidthPackageAttachment",
accelerator_id=example_accelerator.id,
bandwidth_package_id=de_bandwidth_package.id)
example_listener = alicloud.ga.Listener("exampleListener",
accelerator_id=example_accelerator.id,
port_ranges=[alicloud.ga.ListenerPortRangeArgs(
from_port=60,
to_port=70,
)],
opts=pulumi.ResourceOptions(depends_on=[de_bandwidth_package_attachment]))
example_eip_address = alicloud.ecs.EipAddress("exampleEipAddress",
bandwidth="10",
internet_charge_type="PayByBandwidth")
example_endpoint_group = alicloud.ga.EndpointGroup("exampleEndpointGroup",
accelerator_id=example_accelerator.id,
endpoint_configurations=[alicloud.ga.EndpointGroupEndpointConfigurationArgs(
endpoint=example_eip_address.ip_address,
type="PublicIp",
weight=20,
)],
endpoint_group_region="cn-hangzhou",
listener_id=example_listener.id)
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const exampleAccelerator = new alicloud.ga.Accelerator("exampleAccelerator", {
duration: 1,
autoUseCoupon: true,
spec: "1",
});
const deBandwidthPackage = new alicloud.ga.BandwidthPackage("deBandwidthPackage", {
bandwidth: 100,
type: "Basic",
bandwidthType: "Basic",
paymentType: "PayAsYouGo",
billingType: "PayBy95",
ratio: 30,
});
const deBandwidthPackageAttachment = new alicloud.ga.BandwidthPackageAttachment("deBandwidthPackageAttachment", {
acceleratorId: exampleAccelerator.id,
bandwidthPackageId: deBandwidthPackage.id,
});
const exampleListener = new alicloud.ga.Listener("exampleListener", {
acceleratorId: exampleAccelerator.id,
portRanges: [{
fromPort: 60,
toPort: 70,
}],
}, {
dependsOn: [deBandwidthPackageAttachment],
});
const exampleEipAddress = new alicloud.ecs.EipAddress("exampleEipAddress", {
bandwidth: "10",
internetChargeType: "PayByBandwidth",
});
const exampleEndpointGroup = new alicloud.ga.EndpointGroup("exampleEndpointGroup", {
acceleratorId: exampleAccelerator.id,
endpointConfigurations: [{
endpoint: exampleEipAddress.ipAddress,
type: "PublicIp",
weight: 20,
}],
endpointGroupRegion: "cn-hangzhou",
listenerId: exampleListener.id,
});
resources:
exampleAccelerator:
type: alicloud:ga:Accelerator
properties:
duration: 1
autoUseCoupon: true
spec: '1'
deBandwidthPackage:
type: alicloud:ga:BandwidthPackage
properties:
bandwidth: '100'
type: Basic
bandwidthType: Basic
paymentType: PayAsYouGo
billingType: PayBy95
ratio: 30
deBandwidthPackageAttachment:
type: alicloud:ga:BandwidthPackageAttachment
properties:
acceleratorId: ${exampleAccelerator.id}
bandwidthPackageId: ${deBandwidthPackage.id}
exampleListener:
type: alicloud:ga:Listener
properties:
acceleratorId: ${exampleAccelerator.id}
portRanges:
- fromPort: 60
toPort: 70
options:
dependson:
- ${deBandwidthPackageAttachment}
exampleEipAddress:
type: alicloud:ecs:EipAddress
properties:
bandwidth: '10'
internetChargeType: PayByBandwidth
exampleEndpointGroup:
type: alicloud:ga:EndpointGroup
properties:
acceleratorId: ${exampleAccelerator.id}
endpointConfigurations:
- endpoint: ${exampleEipAddress.ipAddress}
type: PublicIp
weight: '20'
endpointGroupRegion: cn-hangzhou
listenerId: ${exampleListener.id}
Create EndpointGroup Resource
new EndpointGroup(name: string, args: EndpointGroupArgs, opts?: CustomResourceOptions);
@overload
def EndpointGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
accelerator_id: Optional[str] = None,
description: Optional[str] = None,
endpoint_configurations: Optional[Sequence[EndpointGroupEndpointConfigurationArgs]] = None,
endpoint_group_region: Optional[str] = None,
endpoint_group_type: Optional[str] = None,
endpoint_request_protocol: Optional[str] = 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,
threshold_count: Optional[int] = None,
traffic_percentage: Optional[int] = None)
@overload
def EndpointGroup(resource_name: str,
args: EndpointGroupArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
The EndpointGroup resource accepts the following input properties:
- Accelerator
Id string The ID of the Global Accelerator instance to which the endpoint group will be added.
- Endpoint
Configurations List<Pulumi.Ali Cloud. Ga. Inputs. Endpoint Group Endpoint Configuration Args> The endpointConfigurations of the endpoint group. See the following
Block endpoint_configurations
.- Endpoint
Group stringRegion The ID of the region where the endpoint group is deployed.
- Listener
Id string The ID of the listener that is associated with the endpoint group.
- Description string
The description of the endpoint group.
- Endpoint
Group stringType The endpoint group type. Valid values:
default
,virtual
. Default value isdefault
.- Endpoint
Request stringProtocol The endpoint request protocol. Valid value:
HTTP
,HTTPS
.- Health
Check intInterval Seconds The interval between two consecutive health checks. Unit: seconds.
- Health
Check stringPath The path specified as the destination of the targets for health checks.
- Health
Check intPort The port that is used for health checks.
- Health
Check stringProtocol The protocol that is used to connect to the targets for health checks. Valid values:
http
,https
,tcp
.- Name string
The name of the endpoint group.
- Port
Overrides Pulumi.Ali Cloud. Ga. Inputs. Endpoint Group Port Overrides Args Mapping between listening port and forwarding port of boarding point. See the following
Block port_overrides
.- Threshold
Count int The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value is
3
.- Traffic
Percentage int The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.
- Accelerator
Id string The ID of the Global Accelerator instance to which the endpoint group will be added.
- Endpoint
Configurations []EndpointGroup Endpoint Configuration Args The endpointConfigurations of the endpoint group. See the following
Block endpoint_configurations
.- Endpoint
Group stringRegion The ID of the region where the endpoint group is deployed.
- Listener
Id string The ID of the listener that is associated with the endpoint group.
- Description string
The description of the endpoint group.
- Endpoint
Group stringType The endpoint group type. Valid values:
default
,virtual
. Default value isdefault
.- Endpoint
Request stringProtocol The endpoint request protocol. Valid value:
HTTP
,HTTPS
.- Health
Check intInterval Seconds The interval between two consecutive health checks. Unit: seconds.
- Health
Check stringPath The path specified as the destination of the targets for health checks.
- Health
Check intPort The port that is used for health checks.
- Health
Check stringProtocol The protocol that is used to connect to the targets for health checks. Valid values:
http
,https
,tcp
.- Name string
The name of the endpoint group.
- Port
Overrides EndpointGroup Port Overrides Args Mapping between listening port and forwarding port of boarding point. See the following
Block port_overrides
.- Threshold
Count int The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value is
3
.- Traffic
Percentage int The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.
- accelerator
Id String The ID of the Global Accelerator instance to which the endpoint group will be added.
- endpoint
Configurations List<EndpointGroup Endpoint Configuration Args> The endpointConfigurations of the endpoint group. See the following
Block endpoint_configurations
.- endpoint
Group StringRegion The ID of the region where the endpoint group is deployed.
- listener
Id String The ID of the listener that is associated with the endpoint group.
- description String
The description of the endpoint group.
- endpoint
Group StringType The endpoint group type. Valid values:
default
,virtual
. Default value isdefault
.- endpoint
Request StringProtocol The endpoint request protocol. Valid value:
HTTP
,HTTPS
.- health
Check IntegerInterval Seconds The interval between two consecutive health checks. Unit: seconds.
- health
Check StringPath The path specified as the destination of the targets for health checks.
- health
Check IntegerPort The port that is used for health checks.
- health
Check StringProtocol The protocol that is used to connect to the targets for health checks. Valid values:
http
,https
,tcp
.- name String
The name of the endpoint group.
- port
Overrides EndpointGroup Port Overrides Args Mapping between listening port and forwarding port of boarding point. See the following
Block port_overrides
.- threshold
Count Integer The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value is
3
.- traffic
Percentage Integer The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.
- accelerator
Id string The ID of the Global Accelerator instance to which the endpoint group will be added.
- endpoint
Configurations EndpointGroup Endpoint Configuration Args[] The endpointConfigurations of the endpoint group. See the following
Block endpoint_configurations
.- endpoint
Group stringRegion The ID of the region where the endpoint group is deployed.
- listener
Id string The ID of the listener that is associated with the endpoint group.
- description string
The description of the endpoint group.
- endpoint
Group stringType The endpoint group type. Valid values:
default
,virtual
. Default value isdefault
.- endpoint
Request stringProtocol The endpoint request protocol. Valid value:
HTTP
,HTTPS
.- health
Check numberInterval Seconds The interval between two consecutive health checks. Unit: seconds.
- health
Check stringPath The path specified as the destination of the targets for health checks.
- health
Check numberPort The port that is used for health checks.
- health
Check stringProtocol The protocol that is used to connect to the targets for health checks. Valid values:
http
,https
,tcp
.- name string
The name of the endpoint group.
- port
Overrides EndpointGroup Port Overrides Args Mapping between listening port and forwarding port of boarding point. See the following
Block port_overrides
.- threshold
Count number The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value is
3
.- traffic
Percentage 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[EndpointGroup Endpoint Configuration Args] The endpointConfigurations of the endpoint group. See the following
Block endpoint_configurations
.- endpoint_
group_ strregion 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_ strtype The endpoint group type. Valid values:
default
,virtual
. Default value isdefault
.- endpoint_
request_ strprotocol The endpoint request protocol. Valid value:
HTTP
,HTTPS
.- health_
check_ intinterval_ seconds The interval between two consecutive health checks. Unit: seconds.
- health_
check_ strpath The path specified as the destination of the targets for health checks.
- health_
check_ intport The port that is used for health checks.
- health_
check_ strprotocol The protocol that is used to connect to the targets for health checks. Valid values:
http
,https
,tcp
.- name str
The name of the endpoint group.
- port_
overrides EndpointGroup Port Overrides Args Mapping between listening port and forwarding port of boarding point. See the following
Block port_overrides
.- threshold_
count int The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value is
3
.- traffic_
percentage int The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.
- accelerator
Id String The ID of the Global Accelerator instance to which the endpoint group will be added.
- endpoint
Configurations List<Property Map> The endpointConfigurations of the endpoint group. See the following
Block endpoint_configurations
.- endpoint
Group StringRegion The ID of the region where the endpoint group is deployed.
- listener
Id String The ID of the listener that is associated with the endpoint group.
- description String
The description of the endpoint group.
- endpoint
Group StringType The endpoint group type. Valid values:
default
,virtual
. Default value isdefault
.- endpoint
Request StringProtocol The endpoint request protocol. Valid value:
HTTP
,HTTPS
.- health
Check NumberInterval Seconds The interval between two consecutive health checks. Unit: seconds.
- health
Check StringPath The path specified as the destination of the targets for health checks.
- health
Check NumberPort The port that is used for health checks.
- health
Check StringProtocol The protocol that is used to connect to the targets for health checks. Valid values:
http
,https
,tcp
.- name String
The name of the endpoint group.
- port
Overrides Property Map Mapping between listening port and forwarding port of boarding point. See the following
Block port_overrides
.- threshold
Count Number The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value is
3
.- traffic
Percentage 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:
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.
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_region: Optional[str] = None,
endpoint_group_type: Optional[str] = None,
endpoint_request_protocol: Optional[str] = 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,
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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Accelerator
Id string The ID of the Global Accelerator instance to which the endpoint group will be added.
- Description string
The description of the endpoint group.
- Endpoint
Configurations List<Pulumi.Ali Cloud. Ga. Inputs. Endpoint Group Endpoint Configuration Args> The endpointConfigurations of the endpoint group. See the following
Block endpoint_configurations
.- Endpoint
Group stringRegion The ID of the region where the endpoint group is deployed.
- Endpoint
Group stringType The endpoint group type. Valid values:
default
,virtual
. Default value isdefault
.- Endpoint
Request stringProtocol The endpoint request protocol. Valid value:
HTTP
,HTTPS
.- Health
Check intInterval Seconds The interval between two consecutive health checks. Unit: seconds.
- Health
Check stringPath The path specified as the destination of the targets for health checks.
- Health
Check intPort The port that is used for health checks.
- Health
Check stringProtocol The protocol that is used to connect to the targets for health checks. Valid values:
http
,https
,tcp
.- Listener
Id string The ID of the listener that is associated with the endpoint group.
- Name string
The name of the endpoint group.
- Port
Overrides Pulumi.Ali Cloud. Ga. Inputs. Endpoint Group Port Overrides Args Mapping between listening port and forwarding port of boarding point. See the following
Block port_overrides
.- Status string
The status of the endpoint group.
- Threshold
Count int The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value is
3
.- Traffic
Percentage int The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.
- Accelerator
Id string The ID of the Global Accelerator instance to which the endpoint group will be added.
- Description string
The description of the endpoint group.
- Endpoint
Configurations []EndpointGroup Endpoint Configuration Args The endpointConfigurations of the endpoint group. See the following
Block endpoint_configurations
.- Endpoint
Group stringRegion The ID of the region where the endpoint group is deployed.
- Endpoint
Group stringType The endpoint group type. Valid values:
default
,virtual
. Default value isdefault
.- Endpoint
Request stringProtocol The endpoint request protocol. Valid value:
HTTP
,HTTPS
.- Health
Check intInterval Seconds The interval between two consecutive health checks. Unit: seconds.
- Health
Check stringPath The path specified as the destination of the targets for health checks.
- Health
Check intPort The port that is used for health checks.
- Health
Check stringProtocol The protocol that is used to connect to the targets for health checks. Valid values:
http
,https
,tcp
.- Listener
Id string The ID of the listener that is associated with the endpoint group.
- Name string
The name of the endpoint group.
- Port
Overrides EndpointGroup Port Overrides Args Mapping between listening port and forwarding port of boarding point. See the following
Block port_overrides
.- Status string
The status of the endpoint group.
- Threshold
Count int The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value is
3
.- Traffic
Percentage int The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.
- accelerator
Id String The ID of the Global Accelerator instance to which the endpoint group will be added.
- description String
The description of the endpoint group.
- endpoint
Configurations List<EndpointGroup Endpoint Configuration Args> The endpointConfigurations of the endpoint group. See the following
Block endpoint_configurations
.- endpoint
Group StringRegion The ID of the region where the endpoint group is deployed.
- endpoint
Group StringType The endpoint group type. Valid values:
default
,virtual
. Default value isdefault
.- endpoint
Request StringProtocol The endpoint request protocol. Valid value:
HTTP
,HTTPS
.- health
Check IntegerInterval Seconds The interval between two consecutive health checks. Unit: seconds.
- health
Check StringPath The path specified as the destination of the targets for health checks.
- health
Check IntegerPort The port that is used for health checks.
- health
Check StringProtocol The protocol that is used to connect to the targets for health checks. Valid values:
http
,https
,tcp
.- listener
Id String The ID of the listener that is associated with the endpoint group.
- name String
The name of the endpoint group.
- port
Overrides EndpointGroup Port Overrides Args Mapping between listening port and forwarding port of boarding point. See the following
Block port_overrides
.- status String
The status of the endpoint group.
- threshold
Count Integer The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value is
3
.- traffic
Percentage Integer The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.
- accelerator
Id string The ID of the Global Accelerator instance to which the endpoint group will be added.
- description string
The description of the endpoint group.
- endpoint
Configurations EndpointGroup Endpoint Configuration Args[] The endpointConfigurations of the endpoint group. See the following
Block endpoint_configurations
.- endpoint
Group stringRegion The ID of the region where the endpoint group is deployed.
- endpoint
Group stringType The endpoint group type. Valid values:
default
,virtual
. Default value isdefault
.- endpoint
Request stringProtocol The endpoint request protocol. Valid value:
HTTP
,HTTPS
.- health
Check numberInterval Seconds The interval between two consecutive health checks. Unit: seconds.
- health
Check stringPath The path specified as the destination of the targets for health checks.
- health
Check numberPort The port that is used for health checks.
- health
Check stringProtocol The protocol that is used to connect to the targets for health checks. Valid values:
http
,https
,tcp
.- listener
Id string The ID of the listener that is associated with the endpoint group.
- name string
The name of the endpoint group.
- port
Overrides EndpointGroup Port Overrides Args Mapping between listening port and forwarding port of boarding point. See the following
Block port_overrides
.- status string
The status of the endpoint group.
- threshold
Count number The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value is
3
.- traffic
Percentage 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[EndpointGroup Endpoint Configuration Args] The endpointConfigurations of the endpoint group. See the following
Block endpoint_configurations
.- endpoint_
group_ strregion The ID of the region where the endpoint group is deployed.
- endpoint_
group_ strtype The endpoint group type. Valid values:
default
,virtual
. Default value isdefault
.- endpoint_
request_ strprotocol The endpoint request protocol. Valid value:
HTTP
,HTTPS
.- health_
check_ intinterval_ seconds The interval between two consecutive health checks. Unit: seconds.
- health_
check_ strpath The path specified as the destination of the targets for health checks.
- health_
check_ intport The port that is used for health checks.
- health_
check_ strprotocol The protocol that is used to connect to the targets for health checks. Valid values:
http
,https
,tcp
.- 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 EndpointGroup Port Overrides Args Mapping between listening port and forwarding port of boarding point. See the following
Block port_overrides
.- status str
The status of the endpoint group.
- threshold_
count int The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value is
3
.- traffic_
percentage int The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.
- accelerator
Id String The ID of the Global Accelerator instance to which the endpoint group will be added.
- description String
The description of the endpoint group.
- endpoint
Configurations List<Property Map> The endpointConfigurations of the endpoint group. See the following
Block endpoint_configurations
.- endpoint
Group StringRegion The ID of the region where the endpoint group is deployed.
- endpoint
Group StringType The endpoint group type. Valid values:
default
,virtual
. Default value isdefault
.- endpoint
Request StringProtocol The endpoint request protocol. Valid value:
HTTP
,HTTPS
.- health
Check NumberInterval Seconds The interval between two consecutive health checks. Unit: seconds.
- health
Check StringPath The path specified as the destination of the targets for health checks.
- health
Check NumberPort The port that is used for health checks.
- health
Check StringProtocol The protocol that is used to connect to the targets for health checks. Valid values:
http
,https
,tcp
.- listener
Id String The ID of the listener that is associated with the endpoint group.
- name String
The name of the endpoint group.
- port
Overrides Property Map Mapping between listening port and forwarding port of boarding point. See the following
Block port_overrides
.- status String
The status of the endpoint group.
- threshold
Count Number The number of consecutive failed heath checks that must occur before the endpoint is deemed unhealthy. Default value is
3
.- traffic
Percentage Number The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.
Supporting Types
EndpointGroupEndpointConfiguration
- 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 Alibaba Cloud Elastic Compute Service (ECS) instance,SLB
: an Alibaba Cloud Server Load Balancer (SLB) instance.- Weight int
The weight of Endpoint N in the endpoint group. Valid value is 0 to 255.
- Enable
Clientip boolPreservation Indicates whether client IP addresses are reserved. Valid values:
true
: Client IP addresses are reserved,false
: Client IP addresses are not reserved. Default value isfalse
.
- 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 Alibaba Cloud Elastic Compute Service (ECS) instance,SLB
: an Alibaba Cloud Server Load Balancer (SLB) instance.- Weight int
The weight of Endpoint N in the endpoint group. Valid value is 0 to 255.
- Enable
Clientip boolPreservation Indicates whether client IP addresses are reserved. Valid values:
true
: Client IP addresses are reserved,false
: Client IP addresses are not reserved. Default value isfalse
.
- 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 Alibaba Cloud Elastic Compute Service (ECS) instance,SLB
: an Alibaba Cloud Server Load Balancer (SLB) instance.- weight Integer
The weight of Endpoint N in the endpoint group. Valid value is 0 to 255.
- enable
Clientip BooleanPreservation Indicates whether client IP addresses are reserved. Valid values:
true
: Client IP addresses are reserved,false
: Client IP addresses are not reserved. Default value isfalse
.
- 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 Alibaba Cloud Elastic Compute Service (ECS) instance,SLB
: an Alibaba Cloud Server Load Balancer (SLB) instance.- weight number
The weight of Endpoint N in the endpoint group. Valid value is 0 to 255.
- enable
Clientip booleanPreservation Indicates whether client IP addresses are reserved. Valid values:
true
: Client IP addresses are reserved,false
: Client IP addresses are not reserved. Default value isfalse
.
- 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 Alibaba Cloud Elastic Compute Service (ECS) instance,SLB
: an Alibaba Cloud Server Load Balancer (SLB) instance.- weight int
The weight of Endpoint N in the endpoint group. Valid value is 0 to 255.
- enable_
clientip_ boolpreservation Indicates whether client IP addresses are reserved. Valid values:
true
: Client IP addresses are reserved,false
: Client IP addresses are not reserved. Default value isfalse
.
- 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 Alibaba Cloud Elastic Compute Service (ECS) instance,SLB
: an Alibaba Cloud Server Load Balancer (SLB) instance.- weight Number
The weight of Endpoint N in the endpoint group. Valid value is 0 to 255.
- enable
Clientip BooleanPreservation Indicates whether client IP addresses are reserved. Valid values:
true
: Client IP addresses are reserved,false
: Client IP addresses are not reserved. Default value isfalse
.
EndpointGroupPortOverrides
- Endpoint
Port int Forwarding port.
- Listener
Port int Listener port.
- Endpoint
Port int Forwarding port.
- Listener
Port int Listener port.
- endpoint
Port Integer Forwarding port.
- listener
Port Integer Listener port.
- endpoint
Port number Forwarding port.
- listener
Port number Listener port.
- endpoint_
port int Forwarding port.
- listener_
port int Listener port.
- endpoint
Port Number Forwarding port.
- listener
Port Number Listener port.
Import
Ga Endpoint Group can be imported using the id, e.g.
$ pulumi import alicloud:ga/endpointGroup:EndpointGroup example <id>
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
alicloud
Terraform Provider.