EndpointGroup

Provides a Global Accelerator endpoint group.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.GlobalAccelerator.EndpointGroup("example", new Aws.GlobalAccelerator.EndpointGroupArgs
        {
            EndpointConfigurations = 
            {
                new Aws.GlobalAccelerator.Inputs.EndpointGroupEndpointConfigurationArgs
                {
                    EndpointId = aws_lb.Example.Arn,
                    Weight = 100,
                },
            },
            ListenerArn = aws_globalaccelerator_listener.Example.Id,
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := globalaccelerator.NewEndpointGroup(ctx, "example", &globalaccelerator.EndpointGroupArgs{
            EndpointConfigurations: globalaccelerator.EndpointGroupEndpointConfigurationArray{
                &globalaccelerator.EndpointGroupEndpointConfigurationArgs{
                    EndpointId: pulumi.String(aws_lb.Example.Arn),
                    Weight:     pulumi.Int(100),
                },
            },
            ListenerArn: pulumi.String(aws_globalaccelerator_listener.Example.Id),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.globalaccelerator.EndpointGroup("example",
    endpoint_configurations=[{
        "endpoint_id": aws_lb["example"]["arn"],
        "weight": 100,
    }],
    listener_arn=aws_globalaccelerator_listener["example"]["id"])

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

const example = new aws.globalaccelerator.EndpointGroup("example", {
    endpointConfigurations: [{
        endpointId: aws_lb_example.arn,
        weight: 100,
    }],
    listenerArn: aws_globalaccelerator_listener_example.id,
});

Create a EndpointGroup Resource

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

def EndpointGroup(resource_name, opts=None, endpoint_configurations=None, endpoint_group_region=None, health_check_interval_seconds=None, health_check_path=None, health_check_port=None, health_check_protocol=None, listener_arn=None, threshold_count=None, traffic_dial_percentage=None, __props__=None);

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

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

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.
opts ResourceOptions: A bag of options that control this 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.

EndpointGroup Resource Properties

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

Inputs

The EndpointGroup resource accepts the following input properties:

ListenerArn string: The Amazon Resource Name (ARN) of the listener.
EndpointConfigurations List<EndpointGroupEndpointConfigurationArgs>: The list of endpoint objects. Fields documented below.
EndpointGroupRegion 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 (/).
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.
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.
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 string: The Amazon Resource Name (ARN) of the listener.
EndpointConfigurations []EndpointGroupEndpointConfiguration: The list of endpoint objects. Fields documented below.
EndpointGroupRegion 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 (/).
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.
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.
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 string: The Amazon Resource Name (ARN) of the listener.
endpointConfigurations EndpointGroupEndpointConfiguration[]: The list of endpoint objects. Fields documented below.
endpointGroupRegion 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 (/).
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.
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.
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 str: The Amazon Resource Name (ARN) of the listener.
endpoint_configurations List[EndpointGroupEndpointConfiguration]: The list of endpoint objects. Fields documented below.
endpoint_group_region str: The name of the AWS Region where the endpoint group is located.
health_check_interval_seconds float: 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 (/).
health_check_port float: 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.
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.
threshold_count float: 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.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, endpoint_configurations=None, endpoint_group_region=None, health_check_interval_seconds=None, health_check_path=None, health_check_port=None, health_check_protocol=None, listener_arn=None, threshold_count=None, traffic_dial_percentage=None, __props__=None);

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)

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.

The following state arguments are supported:

EndpointConfigurations List<EndpointGroupEndpointConfigurationArgs>: The list of endpoint objects. Fields documented below.
EndpointGroupRegion 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 (/).
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.
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 string: The Amazon Resource Name (ARN) of the listener.
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.

EndpointConfigurations []EndpointGroupEndpointConfiguration: The list of endpoint objects. Fields documented below.
EndpointGroupRegion 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 (/).
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.
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 string: The Amazon Resource Name (ARN) of the listener.
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.

endpointConfigurations EndpointGroupEndpointConfiguration[]: The list of endpoint objects. Fields documented below.
endpointGroupRegion 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 (/).
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.
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 string: The Amazon Resource Name (ARN) of the listener.
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.

endpoint_configurations List[EndpointGroupEndpointConfiguration]: The list of endpoint objects. Fields documented below.
endpoint_group_region str: The name of the AWS Region where the endpoint group is located.
health_check_interval_seconds float: 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 (/).
health_check_port float: 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.
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 str: The Amazon Resource Name (ARN) of the listener.
threshold_count float: 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.

Supporting Types

EndpointGroupEndpointConfiguration

See the input and output API doc for this type.

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.

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.

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.

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 float: 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.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud