Alibaba Cloud

Pulumi Official
Package maintained by Pulumi
v3.22.0 published on Monday, Jun 27, 2022 by Pulumi

getEndpointGroups

This data source provides the Global Accelerator (GA) Endpoint Groups of the current Alibaba Cloud user.

NOTE: Available in v1.113.0+.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(AliCloud.Ga.GetEndpointGroups.InvokeAsync(new AliCloud.Ga.GetEndpointGroupsArgs
        {
            AcceleratorId = "example_value",
            Ids = 
            {
                "example_value",
            },
            NameRegex = "the_resource_name",
        }));
        this.FirstGaEndpointGroupId = example.Apply(example => example.Groups?[0]?.Id);
    }

    [Output("firstGaEndpointGroupId")]
    public Output<string> FirstGaEndpointGroupId { get; set; }
}
package main

import (
	"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 {
		example, err := ga.GetEndpointGroups(ctx, &ga.GetEndpointGroupsArgs{
			AcceleratorId: "example_value",
			Ids: []string{
				"example_value",
			},
			NameRegex: pulumi.StringRef("the_resource_name"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("firstGaEndpointGroupId", example.Groups[0].Id)
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_alicloud as alicloud

example = alicloud.ga.get_endpoint_groups(accelerator_id="example_value",
    ids=["example_value"],
    name_regex="the_resource_name")
pulumi.export("firstGaEndpointGroupId", example.groups[0].id)
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const example = alicloud.ga.getEndpointGroups({
    acceleratorId: "example_value",
    ids: ["example_value"],
    nameRegex: "the_resource_name",
});
export const firstGaEndpointGroupId = example.then(example => example.groups?[0]?.id);

Coming soon!

Using getEndpointGroups

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEndpointGroups(args: GetEndpointGroupsArgs, opts?: InvokeOptions): Promise<GetEndpointGroupsResult>
function getEndpointGroupsOutput(args: GetEndpointGroupsOutputArgs, opts?: InvokeOptions): Output<GetEndpointGroupsResult>
def get_endpoint_groups(accelerator_id: Optional[str] = None,
                        endpoint_group_type: Optional[str] = None,
                        ids: Optional[Sequence[str]] = None,
                        listener_id: Optional[str] = None,
                        name_regex: Optional[str] = None,
                        output_file: Optional[str] = None,
                        status: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetEndpointGroupsResult
def get_endpoint_groups_output(accelerator_id: Optional[pulumi.Input[str]] = None,
                        endpoint_group_type: Optional[pulumi.Input[str]] = None,
                        ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        listener_id: Optional[pulumi.Input[str]] = None,
                        name_regex: Optional[pulumi.Input[str]] = None,
                        output_file: Optional[pulumi.Input[str]] = None,
                        status: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetEndpointGroupsResult]
func GetEndpointGroups(ctx *Context, args *GetEndpointGroupsArgs, opts ...InvokeOption) (*GetEndpointGroupsResult, error)
func GetEndpointGroupsOutput(ctx *Context, args *GetEndpointGroupsOutputArgs, opts ...InvokeOption) GetEndpointGroupsResultOutput

> Note: This function is named GetEndpointGroups in the Go SDK.

public static class GetEndpointGroups 
{
    public static Task<GetEndpointGroupsResult> InvokeAsync(GetEndpointGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointGroupsResult> Invoke(GetEndpointGroupsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEndpointGroupsResult> getEndpointGroups(GetEndpointGroupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: alicloud:ga/getEndpointGroups:getEndpointGroups
  Arguments:
    # Arguments dictionary

The following arguments are supported:

AcceleratorId string

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

EndpointGroupType string

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

Ids List<string>

A list of Endpoint Group IDs.

ListenerId string

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

NameRegex string

A regex string to filter results by Endpoint Group name.

OutputFile string
Status string

The status of the endpoint group.

AcceleratorId string

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

EndpointGroupType string

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

Ids []string

A list of Endpoint Group IDs.

ListenerId string

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

NameRegex string

A regex string to filter results by Endpoint Group name.

OutputFile string
Status string

The status of the endpoint group.

acceleratorId String

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

endpointGroupType String

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

ids List<String>

A list of Endpoint Group IDs.

listenerId String

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

nameRegex String

A regex string to filter results by Endpoint Group name.

outputFile String
status String

The status of the endpoint group.

acceleratorId string

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

endpointGroupType string

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

ids string[]

A list of Endpoint Group IDs.

listenerId string

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

nameRegex string

A regex string to filter results by Endpoint Group name.

outputFile string
status string

The status of the endpoint group.

accelerator_id str

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

endpoint_group_type str

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

ids Sequence[str]

A list of Endpoint Group IDs.

listener_id str

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

name_regex str

A regex string to filter results by Endpoint Group name.

output_file str
status str

The status of the endpoint group.

acceleratorId String

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

endpointGroupType String

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

ids List<String>

A list of Endpoint Group IDs.

listenerId String

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

nameRegex String

A regex string to filter results by Endpoint Group name.

outputFile String
status String

The status of the endpoint group.

getEndpointGroups Result

The following output properties are available:

AcceleratorId string
Groups List<Pulumi.AliCloud.Ga.Outputs.GetEndpointGroupsGroup>
Id string

The provider-assigned unique ID for this managed resource.

Ids List<string>
Names List<string>
EndpointGroupType string
ListenerId string
NameRegex string
OutputFile string
Status string
AcceleratorId string
Groups []GetEndpointGroupsGroup
Id string

The provider-assigned unique ID for this managed resource.

Ids []string
Names []string
EndpointGroupType string
ListenerId string
NameRegex string
OutputFile string
Status string
acceleratorId String
groups List<GetEndpointGroupsGroup>
id String

The provider-assigned unique ID for this managed resource.

ids List<String>
names List<String>
endpointGroupType String
listenerId String
nameRegex String
outputFile String
status String
acceleratorId string
groups GetEndpointGroupsGroup[]
id string

The provider-assigned unique ID for this managed resource.

ids string[]
names string[]
endpointGroupType string
listenerId string
nameRegex string
outputFile string
status string
accelerator_id str
groups Sequence[GetEndpointGroupsGroup]
id str

The provider-assigned unique ID for this managed resource.

ids Sequence[str]
names Sequence[str]
endpoint_group_type str
listener_id str
name_regex str
output_file str
status str
acceleratorId String
groups List<Property Map>
id String

The provider-assigned unique ID for this managed resource.

ids List<String>
names List<String>
endpointGroupType String
listenerId String
nameRegex String
outputFile String
status String

Supporting Types

GetEndpointGroupsGroup

Description string

The description of the endpoint group.

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

The endpointConfigurations of the endpoint group.

EndpointGroupId string

The endpoint_group_id of the Endpoint Group.

EndpointGroupRegion string

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

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.

Id string

The ID of the Endpoint Group.

ListenerId string

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

Name string

The name of the endpoint group.

PortOverrides List<Pulumi.AliCloud.Ga.Inputs.GetEndpointGroupsGroupPortOverride>

Mapping between listening port and forwarding port of boarding point.

Status string

The status of the endpoint group.

ThresholdCount int

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

TrafficPercentage int

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

Description string

The description of the endpoint group.

EndpointConfigurations []GetEndpointGroupsGroupEndpointConfiguration

The endpointConfigurations of the endpoint group.

EndpointGroupId string

The endpoint_group_id of the Endpoint Group.

EndpointGroupRegion string

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

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.

Id string

The ID of the Endpoint Group.

ListenerId string

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

Name string

The name of the endpoint group.

PortOverrides []GetEndpointGroupsGroupPortOverride

Mapping between listening port and forwarding port of boarding point.

Status string

The status of the endpoint group.

ThresholdCount int

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

TrafficPercentage int

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

description String

The description of the endpoint group.

endpointConfigurations List<GetEndpointGroupsGroupEndpointConfiguration>

The endpointConfigurations of the endpoint group.

endpointGroupId String

The endpoint_group_id of the Endpoint Group.

endpointGroupRegion String

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

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.

id String

The ID of the Endpoint Group.

listenerId String

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

name String

The name of the endpoint group.

portOverrides List<GetEndpointGroupsGroupPortOverride>

Mapping between listening port and forwarding port of boarding point.

status String

The status of the endpoint group.

thresholdCount Integer

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

trafficPercentage Integer

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

description string

The description of the endpoint group.

endpointConfigurations GetEndpointGroupsGroupEndpointConfiguration[]

The endpointConfigurations of the endpoint group.

endpointGroupId string

The endpoint_group_id of the Endpoint Group.

endpointGroupRegion string

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

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.

id string

The ID of the Endpoint Group.

listenerId string

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

name string

The name of the endpoint group.

portOverrides GetEndpointGroupsGroupPortOverride[]

Mapping between listening port and forwarding port of boarding point.

status string

The status of the endpoint group.

thresholdCount number

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

trafficPercentage number

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

description str

The description of the endpoint group.

endpoint_configurations Sequence[GetEndpointGroupsGroupEndpointConfiguration]

The endpointConfigurations of the endpoint group.

endpoint_group_id str

The endpoint_group_id of the Endpoint Group.

endpoint_group_region str

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

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.

id str

The ID of the Endpoint Group.

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 Sequence[GetEndpointGroupsGroupPortOverride]

Mapping between listening port and forwarding port of boarding point.

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.

traffic_percentage int

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

description String

The description of the endpoint group.

endpointConfigurations List<Property Map>

The endpointConfigurations of the endpoint group.

endpointGroupId String

The endpoint_group_id of the Endpoint Group.

endpointGroupRegion String

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

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.

id String

The ID of the Endpoint Group.

listenerId String

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

name String

The name of the endpoint group.

portOverrides List<Property Map>

Mapping between listening port and forwarding port of boarding point.

status String

The status of the endpoint group.

thresholdCount Number

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

trafficPercentage Number

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

GetEndpointGroupsGroupEndpointConfiguration

EnableClientipPreservation bool

Indicates whether client IP addresses are reserved.

Endpoint string

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

ProbePort int

Probe Port.

ProbeProtocol string

Probe Protocol.

Type string

The type of Endpoint N in the endpoint group.

Weight int

The weight of Endpoint N in the endpoint group.

EnableClientipPreservation bool

Indicates whether client IP addresses are reserved.

Endpoint string

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

ProbePort int

Probe Port.

ProbeProtocol string

Probe Protocol.

Type string

The type of Endpoint N in the endpoint group.

Weight int

The weight of Endpoint N in the endpoint group.

enableClientipPreservation Boolean

Indicates whether client IP addresses are reserved.

endpoint String

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

probePort Integer

Probe Port.

probeProtocol String

Probe Protocol.

type String

The type of Endpoint N in the endpoint group.

weight Integer

The weight of Endpoint N in the endpoint group.

enableClientipPreservation boolean

Indicates whether client IP addresses are reserved.

endpoint string

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

probePort number

Probe Port.

probeProtocol string

Probe Protocol.

type string

The type of Endpoint N in the endpoint group.

weight number

The weight of Endpoint N in the endpoint group.

enable_clientip_preservation bool

Indicates whether client IP addresses are reserved.

endpoint str

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

probe_port int

Probe Port.

probe_protocol str

Probe Protocol.

type str

The type of Endpoint N in the endpoint group.

weight int

The weight of Endpoint N in the endpoint group.

enableClientipPreservation Boolean

Indicates whether client IP addresses are reserved.

endpoint String

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

probePort Number

Probe Port.

probeProtocol String

Probe Protocol.

type String

The type of Endpoint N in the endpoint group.

weight Number

The weight of Endpoint N in the endpoint group.

GetEndpointGroupsGroupPortOverride

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.

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.