pulumi-aws-kotlin/com.pulumi.aws.globalaccelerator.kotlin/EndpointGroupArgs

EndpointGroupArgs

data class EndpointGroupArgs(val endpointConfigurations: Output<List<EndpointGroupEndpointConfigurationArgs>>? = null, val endpointGroupRegion: Output<String>? = null, val healthCheckIntervalSeconds: Output<Int>? = null, val healthCheckPath: Output<String>? = null, val healthCheckPort: Output<Int>? = null, val healthCheckProtocol: Output<String>? = null, val listenerArn: Output<String>? = null, val portOverrides: Output<List<EndpointGroupPortOverrideArgs>>? = null, val thresholdCount: Output<Int>? = null, val trafficDialPercentage: Output<Double>? = null) : ConvertibleToJava<EndpointGroupArgs>

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.id,
    endpointConfigurations: [{
        endpointId: exampleAwsLb.arn,
        weight: 100,
    }],
});

import pulumi
import pulumi_aws as aws
example = aws.globalaccelerator.EndpointGroup("example",
    listener_arn=example_aws_globalaccelerator_listener["id"],
    endpoint_configurations=[aws.globalaccelerator.EndpointGroupEndpointConfigurationArgs(
        endpoint_id=example_aws_lb["arn"],
        weight=100,
    )])

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.Id,
        EndpointConfigurations = new[]
        {
            new Aws.GlobalAccelerator.Inputs.EndpointGroupEndpointConfigurationArgs
            {
                EndpointId = exampleAwsLb.Arn,
                Weight = 100,
            },
        },
    });
});

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.Id),
			EndpointConfigurations: globalaccelerator.EndpointGroupEndpointConfigurationArray{
				&globalaccelerator.EndpointGroupEndpointConfigurationArgs{
					EndpointId: pulumi.Any(exampleAwsLb.Arn),
					Weight:     pulumi.Int(100),
				},
			},
		})
		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.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.id())
            .endpointConfigurations(EndpointGroupEndpointConfigurationArgs.builder()
                .endpointId(exampleAwsLb.arn())
                .weight(100)
                .build())
            .build());
    }
}

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

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

Constructors

EndpointGroupArgs

fun EndpointGroupArgs(endpointConfigurations: Output<List<EndpointGroupEndpointConfigurationArgs>>? = null, endpointGroupRegion: Output<String>? = null, healthCheckIntervalSeconds: Output<Int>? = null, healthCheckPath: Output<String>? = null, healthCheckPort: Output<Int>? = null, healthCheckProtocol: Output<String>? = null, listenerArn: Output<String>? = null, portOverrides: Output<List<EndpointGroupPortOverrideArgs>>? = null, thresholdCount: Output<Int>? = null, trafficDialPercentage: Output<Double>? = null)

Functions

toJava

open override fun toJava(): EndpointGroupArgs

Properties

endpointConfigurations

val endpointConfigurations: Output<List<EndpointGroupEndpointConfigurationArgs>>? = null

The list of endpoint objects. Fields documented below.

endpointGroupRegion

val endpointGroupRegion: Output<String>? = null

The name of the AWS Region where the endpoint group is located.

healthCheckIntervalSeconds

val healthCheckIntervalSeconds: Output<Int>? = null

The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

healthCheckPath

val healthCheckPath: Output<String>? = null

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

val healthCheckPort: Output<Int>? = null

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

val healthCheckProtocol: Output<String>? = null

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

val listenerArn: Output<String>? = null

The Amazon Resource Name (ARN) of the listener.

portOverrides

val portOverrides: Output<List<EndpointGroupPortOverrideArgs>>? = null

Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. Fields documented below.

thresholdCount

val thresholdCount: Output<Int>? = null

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

val trafficDialPercentage: Output<Double>? = null

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.