Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. globalaccelerator
  5. EndpointGroup
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.globalaccelerator.EndpointGroup

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Provides a Global Accelerator endpoint group.

Example Usage

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

const example = new aws.globalaccelerator.EndpointGroup("example", {
    listenerArn: exampleAwsGlobalacceleratorListener.arn,
    endpointConfigurations: [{
        endpointId: exampleAwsLb.arn,
        weight: 100,
    }],
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.globalaccelerator.EndpointGroup("example",
    listener_arn=example_aws_globalaccelerator_listener["arn"],
    endpoint_configurations=[{
        "endpoint_id": example_aws_lb["arn"],
        "weight": 100,
    }])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/globalaccelerator"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := globalaccelerator.NewEndpointGroup(ctx, "example", &globalaccelerator.EndpointGroupArgs{
			ListenerArn: pulumi.Any(exampleAwsGlobalacceleratorListener.Arn),
			EndpointConfigurations: globalaccelerator.EndpointGroupEndpointConfigurationArray{
				&globalaccelerator.EndpointGroupEndpointConfigurationArgs{
					EndpointId: pulumi.Any(exampleAwsLb.Arn),
					Weight:     pulumi.Int(100),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.GlobalAccelerator.EndpointGroup("example", new()
    {
        ListenerArn = exampleAwsGlobalacceleratorListener.Arn,
        EndpointConfigurations = new[]
        {
            new Aws.GlobalAccelerator.Inputs.EndpointGroupEndpointConfigurationArgs
            {
                EndpointId = exampleAwsLb.Arn,
                Weight = 100,
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.globalaccelerator.EndpointGroup;
import com.pulumi.aws.globalaccelerator.EndpointGroupArgs;
import com.pulumi.aws.globalaccelerator.inputs.EndpointGroupEndpointConfigurationArgs;
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 example = new EndpointGroup("example", EndpointGroupArgs.builder()
            .listenerArn(exampleAwsGlobalacceleratorListener.arn())
            .endpointConfigurations(EndpointGroupEndpointConfigurationArgs.builder()
                .endpointId(exampleAwsLb.arn())
                .weight(100)
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:globalaccelerator:EndpointGroup
    properties:
      listenerArn: ${exampleAwsGlobalacceleratorListener.arn}
      endpointConfigurations:
        - endpointId: ${exampleAwsLb.arn}
          weight: 100
Copy

Create EndpointGroup Resource

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

Constructor syntax

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,
                  listener_arn: Optional[str] = None,
                  endpoint_configurations: Optional[Sequence[EndpointGroupEndpointConfigurationArgs]] = None,
                  endpoint_group_region: 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,
                  port_overrides: Optional[Sequence[EndpointGroupPortOverrideArgs]] = None,
                  threshold_count: Optional[int] = None,
                  traffic_dial_percentage: Optional[float] = 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: aws:globalaccelerator:EndpointGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

var endpointGroupResource = new Aws.GlobalAccelerator.EndpointGroup("endpointGroupResource", new()
{
    ListenerArn = "string",
    EndpointConfigurations = new[]
    {
        new Aws.GlobalAccelerator.Inputs.EndpointGroupEndpointConfigurationArgs
        {
            AttachmentArn = "string",
            ClientIpPreservationEnabled = false,
            EndpointId = "string",
            Weight = 0,
        },
    },
    EndpointGroupRegion = "string",
    HealthCheckIntervalSeconds = 0,
    HealthCheckPath = "string",
    HealthCheckPort = 0,
    HealthCheckProtocol = "string",
    PortOverrides = new[]
    {
        new Aws.GlobalAccelerator.Inputs.EndpointGroupPortOverrideArgs
        {
            EndpointPort = 0,
            ListenerPort = 0,
        },
    },
    ThresholdCount = 0,
    TrafficDialPercentage = 0,
});
Copy
example, err := globalaccelerator.NewEndpointGroup(ctx, "endpointGroupResource", &globalaccelerator.EndpointGroupArgs{
	ListenerArn: pulumi.String("string"),
	EndpointConfigurations: globalaccelerator.EndpointGroupEndpointConfigurationArray{
		&globalaccelerator.EndpointGroupEndpointConfigurationArgs{
			AttachmentArn:               pulumi.String("string"),
			ClientIpPreservationEnabled: pulumi.Bool(false),
			EndpointId:                  pulumi.String("string"),
			Weight:                      pulumi.Int(0),
		},
	},
	EndpointGroupRegion:        pulumi.String("string"),
	HealthCheckIntervalSeconds: pulumi.Int(0),
	HealthCheckPath:            pulumi.String("string"),
	HealthCheckPort:            pulumi.Int(0),
	HealthCheckProtocol:        pulumi.String("string"),
	PortOverrides: globalaccelerator.EndpointGroupPortOverrideArray{
		&globalaccelerator.EndpointGroupPortOverrideArgs{
			EndpointPort: pulumi.Int(0),
			ListenerPort: pulumi.Int(0),
		},
	},
	ThresholdCount:        pulumi.Int(0),
	TrafficDialPercentage: pulumi.Float64(0),
})
Copy
var endpointGroupResource = new EndpointGroup("endpointGroupResource", EndpointGroupArgs.builder()
    .listenerArn("string")
    .endpointConfigurations(EndpointGroupEndpointConfigurationArgs.builder()
        .attachmentArn("string")
        .clientIpPreservationEnabled(false)
        .endpointId("string")
        .weight(0)
        .build())
    .endpointGroupRegion("string")
    .healthCheckIntervalSeconds(0)
    .healthCheckPath("string")
    .healthCheckPort(0)
    .healthCheckProtocol("string")
    .portOverrides(EndpointGroupPortOverrideArgs.builder()
        .endpointPort(0)
        .listenerPort(0)
        .build())
    .thresholdCount(0)
    .trafficDialPercentage(0)
    .build());
Copy
endpoint_group_resource = aws.globalaccelerator.EndpointGroup("endpointGroupResource",
    listener_arn="string",
    endpoint_configurations=[{
        "attachment_arn": "string",
        "client_ip_preservation_enabled": False,
        "endpoint_id": "string",
        "weight": 0,
    }],
    endpoint_group_region="string",
    health_check_interval_seconds=0,
    health_check_path="string",
    health_check_port=0,
    health_check_protocol="string",
    port_overrides=[{
        "endpoint_port": 0,
        "listener_port": 0,
    }],
    threshold_count=0,
    traffic_dial_percentage=0)
Copy
const endpointGroupResource = new aws.globalaccelerator.EndpointGroup("endpointGroupResource", {
    listenerArn: "string",
    endpointConfigurations: [{
        attachmentArn: "string",
        clientIpPreservationEnabled: false,
        endpointId: "string",
        weight: 0,
    }],
    endpointGroupRegion: "string",
    healthCheckIntervalSeconds: 0,
    healthCheckPath: "string",
    healthCheckPort: 0,
    healthCheckProtocol: "string",
    portOverrides: [{
        endpointPort: 0,
        listenerPort: 0,
    }],
    thresholdCount: 0,
    trafficDialPercentage: 0,
});
Copy
type: aws:globalaccelerator:EndpointGroup
properties:
    endpointConfigurations:
        - attachmentArn: string
          clientIpPreservationEnabled: false
          endpointId: string
          weight: 0
    endpointGroupRegion: string
    healthCheckIntervalSeconds: 0
    healthCheckPath: string
    healthCheckPort: 0
    healthCheckProtocol: string
    listenerArn: string
    portOverrides:
        - endpointPort: 0
          listenerPort: 0
    thresholdCount: 0
    trafficDialPercentage: 0
Copy

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:

ListenerArn
This property is required.
Changes to this property will trigger replacement.
string
The Amazon Resource Name (ARN) of the listener.
EndpointConfigurations List<EndpointGroupEndpointConfiguration>
The list of endpoint objects. Fields documented below.
EndpointGroupRegion Changes to this property will trigger replacement. string
The name of the AWS Region where the endpoint group is located.
HealthCheckIntervalSeconds int
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
HealthCheckPath string
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). the provider will only perform drift detection of its value when present in a configuration.
HealthCheckPort int
The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list. the provider will only perform drift detection of its value when present in a configuration.
HealthCheckProtocol string
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
PortOverrides List<EndpointGroupPortOverride>
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. Fields documented below.
ThresholdCount int
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
TrafficDialPercentage double
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.
ListenerArn
This property is required.
Changes to this property will trigger replacement.
string
The Amazon Resource Name (ARN) of the listener.
EndpointConfigurations []EndpointGroupEndpointConfigurationArgs
The list of endpoint objects. Fields documented below.
EndpointGroupRegion Changes to this property will trigger replacement. string
The name of the AWS Region where the endpoint group is located.
HealthCheckIntervalSeconds int
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
HealthCheckPath string
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). the provider will only perform drift detection of its value when present in a configuration.
HealthCheckPort int
The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list. the provider will only perform drift detection of its value when present in a configuration.
HealthCheckProtocol string
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
PortOverrides []EndpointGroupPortOverrideArgs
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. Fields documented below.
ThresholdCount int
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
TrafficDialPercentage float64
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.
listenerArn
This property is required.
Changes to this property will trigger replacement.
String
The Amazon Resource Name (ARN) of the listener.
endpointConfigurations List<EndpointGroupEndpointConfiguration>
The list of endpoint objects. Fields documented below.
endpointGroupRegion Changes to this property will trigger replacement. String
The name of the AWS Region where the endpoint group is located.
healthCheckIntervalSeconds Integer
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
healthCheckPath String
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). the provider will only perform drift detection of its value when present in a configuration.
healthCheckPort Integer
The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list. the provider will only perform drift detection of its value when present in a configuration.
healthCheckProtocol String
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
portOverrides List<EndpointGroupPortOverride>
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. Fields documented below.
thresholdCount Integer
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
trafficDialPercentage Double
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.
listenerArn
This property is required.
Changes to this property will trigger replacement.
string
The Amazon Resource Name (ARN) of the listener.
endpointConfigurations EndpointGroupEndpointConfiguration[]
The list of endpoint objects. Fields documented below.
endpointGroupRegion Changes to this property will trigger replacement. string
The name of the AWS Region where the endpoint group is located.
healthCheckIntervalSeconds number
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
healthCheckPath string
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). the provider will only perform drift detection of its value when present in a configuration.
healthCheckPort number
The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list. the provider will only perform drift detection of its value when present in a configuration.
healthCheckProtocol string
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
portOverrides EndpointGroupPortOverride[]
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. Fields documented below.
thresholdCount number
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
trafficDialPercentage number
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.
listener_arn
This property is required.
Changes to this property will trigger replacement.
str
The Amazon Resource Name (ARN) of the listener.
endpoint_configurations Sequence[EndpointGroupEndpointConfigurationArgs]
The list of endpoint objects. Fields documented below.
endpoint_group_region Changes to this property will trigger replacement. str
The name of the AWS Region where the endpoint group is located.
health_check_interval_seconds int
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
health_check_path str
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). the provider will only perform drift detection of its value when present in a configuration.
health_check_port int
The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list. the provider will only perform drift detection of its value when present in a configuration.
health_check_protocol str
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
port_overrides Sequence[EndpointGroupPortOverrideArgs]
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. Fields documented below.
threshold_count int
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
traffic_dial_percentage float
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.
listenerArn
This property is required.
Changes to this property will trigger replacement.
String
The Amazon Resource Name (ARN) of the listener.
endpointConfigurations List<Property Map>
The list of endpoint objects. Fields documented below.
endpointGroupRegion Changes to this property will trigger replacement. String
The name of the AWS Region where the endpoint group is located.
healthCheckIntervalSeconds Number
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
healthCheckPath String
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). the provider will only perform drift detection of its value when present in a configuration.
healthCheckPort Number
The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list. the provider will only perform drift detection of its value when present in a configuration.
healthCheckProtocol String
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
portOverrides List<Property Map>
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. Fields documented below.
thresholdCount Number
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
trafficDialPercentage Number
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.

Outputs

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

Arn string
The Amazon Resource Name (ARN) of the endpoint group.
Id string
The provider-assigned unique ID for this managed resource.
Arn string
The Amazon Resource Name (ARN) of the endpoint group.
Id string
The provider-assigned unique ID for this managed resource.
arn String
The Amazon Resource Name (ARN) of the endpoint group.
id String
The provider-assigned unique ID for this managed resource.
arn string
The Amazon Resource Name (ARN) of the endpoint group.
id string
The provider-assigned unique ID for this managed resource.
arn str
The Amazon Resource Name (ARN) of the endpoint group.
id str
The provider-assigned unique ID for this managed resource.
arn String
The Amazon Resource Name (ARN) of the endpoint group.
id String
The provider-assigned unique ID for this managed resource.

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,
        arn: Optional[str] = None,
        endpoint_configurations: Optional[Sequence[EndpointGroupEndpointConfigurationArgs]] = None,
        endpoint_group_region: 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_arn: Optional[str] = None,
        port_overrides: Optional[Sequence[EndpointGroupPortOverrideArgs]] = None,
        threshold_count: Optional[int] = None,
        traffic_dial_percentage: Optional[float] = 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: aws:globalaccelerator:EndpointGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
The Amazon Resource Name (ARN) of the endpoint group.
EndpointConfigurations List<EndpointGroupEndpointConfiguration>
The list of endpoint objects. Fields documented below.
EndpointGroupRegion Changes to this property will trigger replacement. string
The name of the AWS Region where the endpoint group is located.
HealthCheckIntervalSeconds int
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
HealthCheckPath string
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). the provider will only perform drift detection of its value when present in a configuration.
HealthCheckPort int
The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list. the provider will only perform drift detection of its value when present in a configuration.
HealthCheckProtocol string
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
ListenerArn Changes to this property will trigger replacement. string
The Amazon Resource Name (ARN) of the listener.
PortOverrides List<EndpointGroupPortOverride>
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. Fields documented below.
ThresholdCount int
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
TrafficDialPercentage double
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.
Arn string
The Amazon Resource Name (ARN) of the endpoint group.
EndpointConfigurations []EndpointGroupEndpointConfigurationArgs
The list of endpoint objects. Fields documented below.
EndpointGroupRegion Changes to this property will trigger replacement. string
The name of the AWS Region where the endpoint group is located.
HealthCheckIntervalSeconds int
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
HealthCheckPath string
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). the provider will only perform drift detection of its value when present in a configuration.
HealthCheckPort int
The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list. the provider will only perform drift detection of its value when present in a configuration.
HealthCheckProtocol string
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
ListenerArn Changes to this property will trigger replacement. string
The Amazon Resource Name (ARN) of the listener.
PortOverrides []EndpointGroupPortOverrideArgs
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. Fields documented below.
ThresholdCount int
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
TrafficDialPercentage float64
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.
arn String
The Amazon Resource Name (ARN) of the endpoint group.
endpointConfigurations List<EndpointGroupEndpointConfiguration>
The list of endpoint objects. Fields documented below.
endpointGroupRegion Changes to this property will trigger replacement. String
The name of the AWS Region where the endpoint group is located.
healthCheckIntervalSeconds Integer
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
healthCheckPath String
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). the provider will only perform drift detection of its value when present in a configuration.
healthCheckPort Integer
The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list. the provider will only perform drift detection of its value when present in a configuration.
healthCheckProtocol String
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
listenerArn Changes to this property will trigger replacement. String
The Amazon Resource Name (ARN) of the listener.
portOverrides List<EndpointGroupPortOverride>
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. Fields documented below.
thresholdCount Integer
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
trafficDialPercentage Double
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.
arn string
The Amazon Resource Name (ARN) of the endpoint group.
endpointConfigurations EndpointGroupEndpointConfiguration[]
The list of endpoint objects. Fields documented below.
endpointGroupRegion Changes to this property will trigger replacement. string
The name of the AWS Region where the endpoint group is located.
healthCheckIntervalSeconds number
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
healthCheckPath string
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). the provider will only perform drift detection of its value when present in a configuration.
healthCheckPort number
The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list. the provider will only perform drift detection of its value when present in a configuration.
healthCheckProtocol string
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
listenerArn Changes to this property will trigger replacement. string
The Amazon Resource Name (ARN) of the listener.
portOverrides EndpointGroupPortOverride[]
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. Fields documented below.
thresholdCount number
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
trafficDialPercentage number
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.
arn str
The Amazon Resource Name (ARN) of the endpoint group.
endpoint_configurations Sequence[EndpointGroupEndpointConfigurationArgs]
The list of endpoint objects. Fields documented below.
endpoint_group_region Changes to this property will trigger replacement. str
The name of the AWS Region where the endpoint group is located.
health_check_interval_seconds int
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
health_check_path str
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). the provider will only perform drift detection of its value when present in a configuration.
health_check_port int
The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list. the provider will only perform drift detection of its value when present in a configuration.
health_check_protocol str
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
listener_arn Changes to this property will trigger replacement. str
The Amazon Resource Name (ARN) of the listener.
port_overrides Sequence[EndpointGroupPortOverrideArgs]
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. Fields documented below.
threshold_count int
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
traffic_dial_percentage float
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.
arn String
The Amazon Resource Name (ARN) of the endpoint group.
endpointConfigurations List<Property Map>
The list of endpoint objects. Fields documented below.
endpointGroupRegion Changes to this property will trigger replacement. String
The name of the AWS Region where the endpoint group is located.
healthCheckIntervalSeconds Number
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
healthCheckPath String
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). the provider will only perform drift detection of its value when present in a configuration.
healthCheckPort Number
The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list. the provider will only perform drift detection of its value when present in a configuration.
healthCheckProtocol String
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
listenerArn Changes to this property will trigger replacement. String
The Amazon Resource Name (ARN) of the listener.
portOverrides List<Property Map>
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. Fields documented below.
thresholdCount Number
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
trafficDialPercentage Number
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. The default value is 100.

Supporting Types

EndpointGroupEndpointConfiguration
, EndpointGroupEndpointConfigurationArgs

AttachmentArn string
An ARN of an exposed cross-account attachment. See the AWS documentation for more details.
ClientIpPreservationEnabled bool
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. See the AWS documentation for more details. The default value is false. Note: When client IP address preservation is enabled, the Global Accelerator service creates an EC2 Security Group in the VPC named GlobalAccelerator that must be deleted (potentially outside of the provider) before the VPC will successfully delete. If this EC2 Security Group is not deleted, the provider will retry the VPC deletion for a few minutes before reporting a DependencyViolation error. This cannot be resolved by re-running the provider.
EndpointId string
An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.
Weight int
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify.
AttachmentArn string
An ARN of an exposed cross-account attachment. See the AWS documentation for more details.
ClientIpPreservationEnabled bool
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. See the AWS documentation for more details. The default value is false. Note: When client IP address preservation is enabled, the Global Accelerator service creates an EC2 Security Group in the VPC named GlobalAccelerator that must be deleted (potentially outside of the provider) before the VPC will successfully delete. If this EC2 Security Group is not deleted, the provider will retry the VPC deletion for a few minutes before reporting a DependencyViolation error. This cannot be resolved by re-running the provider.
EndpointId string
An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.
Weight int
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify.
attachmentArn String
An ARN of an exposed cross-account attachment. See the AWS documentation for more details.
clientIpPreservationEnabled Boolean
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. See the AWS documentation for more details. The default value is false. Note: When client IP address preservation is enabled, the Global Accelerator service creates an EC2 Security Group in the VPC named GlobalAccelerator that must be deleted (potentially outside of the provider) before the VPC will successfully delete. If this EC2 Security Group is not deleted, the provider will retry the VPC deletion for a few minutes before reporting a DependencyViolation error. This cannot be resolved by re-running the provider.
endpointId String
An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.
weight Integer
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify.
attachmentArn string
An ARN of an exposed cross-account attachment. See the AWS documentation for more details.
clientIpPreservationEnabled boolean
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. See the AWS documentation for more details. The default value is false. Note: When client IP address preservation is enabled, the Global Accelerator service creates an EC2 Security Group in the VPC named GlobalAccelerator that must be deleted (potentially outside of the provider) before the VPC will successfully delete. If this EC2 Security Group is not deleted, the provider will retry the VPC deletion for a few minutes before reporting a DependencyViolation error. This cannot be resolved by re-running the provider.
endpointId string
An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.
weight number
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify.
attachment_arn str
An ARN of an exposed cross-account attachment. See the AWS documentation for more details.
client_ip_preservation_enabled bool
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. See the AWS documentation for more details. The default value is false. Note: When client IP address preservation is enabled, the Global Accelerator service creates an EC2 Security Group in the VPC named GlobalAccelerator that must be deleted (potentially outside of the provider) before the VPC will successfully delete. If this EC2 Security Group is not deleted, the provider will retry the VPC deletion for a few minutes before reporting a DependencyViolation error. This cannot be resolved by re-running the provider.
endpoint_id str
An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.
weight int
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify.
attachmentArn String
An ARN of an exposed cross-account attachment. See the AWS documentation for more details.
clientIpPreservationEnabled Boolean
Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. See the AWS documentation for more details. The default value is false. Note: When client IP address preservation is enabled, the Global Accelerator service creates an EC2 Security Group in the VPC named GlobalAccelerator that must be deleted (potentially outside of the provider) before the VPC will successfully delete. If this EC2 Security Group is not deleted, the provider will retry the VPC deletion for a few minutes before reporting a DependencyViolation error. This cannot be resolved by re-running the provider.
endpointId String
An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.
weight Number
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify.

EndpointGroupPortOverride
, EndpointGroupPortOverrideArgs

EndpointPort This property is required. int
The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.
ListenerPort This property is required. int
The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on.
EndpointPort This property is required. int
The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.
ListenerPort This property is required. int
The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on.
endpointPort This property is required. Integer
The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.
listenerPort This property is required. Integer
The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on.
endpointPort This property is required. number
The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.
listenerPort This property is required. number
The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on.
endpoint_port This property is required. int
The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.
listener_port This property is required. int
The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on.
endpointPort This property is required. Number
The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.
listenerPort This property is required. Number
The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on.

Import

Using pulumi import, import Global Accelerator endpoint groups using the id. For example:

$ pulumi import aws:globalaccelerator/endpointGroup:EndpointGroup example arn:aws:globalaccelerator::111111111111:accelerator/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/listener/xxxxxxx/endpoint-group/xxxxxxxx
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws