Class 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,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

EndpointGroup

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.GlobalAccelerator

Assembly: Pulumi.Aws.dll

Syntax

public class EndpointGroup : CustomResource

Constructors

EndpointGroup(String, EndpointGroupArgs, CustomResourceOptions)

Create a EndpointGroup resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
EndpointGroupArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

EndpointConfigurations

The list of endpoint objects. Fields documented below.

Declaration

public Output<ImmutableArray<EndpointGroupEndpointConfiguration>> EndpointConfigurations { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<EndpointGroupEndpointConfiguration>>

EndpointGroupRegion

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

Declaration

public Output<string> EndpointGroupRegion { get; }

Property Value

Type	Description
Output<System.String>

HealthCheckIntervalSeconds

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

Declaration

public Output<int?> HealthCheckIntervalSeconds { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

HealthCheckPath

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

Declaration

public Output<string> HealthCheckPath { get; }

Property Value

Type	Description
Output<System.String>

HealthCheckPort

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.

Declaration

public Output<int?> HealthCheckPort { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

HealthCheckProtocol

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.

Declaration

public Output<string> HealthCheckProtocol { get; }

Property Value

Type	Description
Output<System.String>

ListenerArn

The Amazon Resource Name (ARN) of the listener.

Declaration

public Output<string> ListenerArn { get; }

Property Value

Type	Description
Output<System.String>

ThresholdCount

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.

Declaration

public Output<int?> ThresholdCount { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

TrafficDialPercentage

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.

Declaration

public Output<double?> TrafficDialPercentage { get; }

Property Value

Type	Description
Output<System.Nullable<System.Double>>

Methods

Get(String, Input<String>, EndpointGroupState, CustomResourceOptions)

Get an existing EndpointGroup resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static EndpointGroup Get(string name, Input<string> id, EndpointGroupState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
EndpointGroupState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
EndpointGroup