Class EndpointGroupOptions

Basic options for creating a new EndpointGroup.

Inheritance

object

EndpointGroupOptions

Implements

IEndpointGroupOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.GlobalAccelerator

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class EndpointGroupOptions : IEndpointGroupOptions

Syntax (vb)

Public Class EndpointGroupOptions Implements IEndpointGroupOptions

Remarks

ExampleMetadata: infused

Examples

ApplicationLoadBalancer alb;
            Listener listener;


            listener.AddEndpointGroup("Group", new EndpointGroupOptions {
                Endpoints = new [] {
                    new ApplicationLoadBalancerEndpoint(alb, new ApplicationLoadBalancerEndpointOptions {
                        Weight = 128,
                        PreserveClientIp = true
                    }) }
            });

Synopsis

Constructors

EndpointGroupOptions()

Basic options for creating a new EndpointGroup.

Properties

EndpointGroupName	Name of the endpoint group.
Endpoints	Initial list of endpoints for this group.
HealthCheckInterval	The time between health checks for each endpoint.
HealthCheckPath	The ping path for health checks (if the protocol is HTTP(S)).
HealthCheckPort	The port used to perform health checks.
HealthCheckProtocol	The protocol used to perform health checks.
HealthCheckThreshold	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.
PortOverrides	Override the destination ports used to route traffic to an endpoint.
Region	The AWS Region where the endpoint group is located.
TrafficDialPercentage	The percentage of traffic to send to this AWS Region.

Constructors

EndpointGroupOptions()

Basic options for creating a new EndpointGroup.

public EndpointGroupOptions()

Remarks

ExampleMetadata: infused

Examples

ApplicationLoadBalancer alb;
            Listener listener;


            listener.AddEndpointGroup("Group", new EndpointGroupOptions {
                Endpoints = new [] {
                    new ApplicationLoadBalancerEndpoint(alb, new ApplicationLoadBalancerEndpointOptions {
                        Weight = 128,
                        PreserveClientIp = true
                    }) }
            });

Properties

EndpointGroupName

Name of the endpoint group.

public string? EndpointGroupName { get; set; }

Property Value

string

Remarks

Default: - logical ID of the resource

Endpoints

Initial list of endpoints for this group.

public IEndpoint[]? Endpoints { get; set; }

Property Value

IEndpoint[]

Remarks

Default: - Group is initially empty

HealthCheckInterval

The time between health checks for each endpoint.

public Duration? HealthCheckInterval { get; set; }

Property Value

Duration

Remarks

Must be either 10 or 30 seconds.

Default: Duration.seconds(30)

HealthCheckPath

The ping path for health checks (if the protocol is HTTP(S)).

public string? HealthCheckPath { get; set; }

Property Value

string

Remarks

Default: '/'

HealthCheckPort

The port used to perform health checks.

public double? HealthCheckPort { get; set; }

Property Value

double?

Remarks

Default: - The listener's port

HealthCheckProtocol

The protocol used to perform health checks.

public HealthCheckProtocol? HealthCheckProtocol { get; set; }

Property Value

HealthCheckProtocol?

Remarks

Default: HealthCheckProtocol.TCP

HealthCheckThreshold

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.

public double? HealthCheckThreshold { get; set; }

Property Value

double?

Remarks

Default: 3

PortOverrides

Override the destination ports used to route traffic to an endpoint.

public IPortOverride[]? PortOverrides { get; set; }

Property Value

IPortOverride[]

Remarks

Unless overridden, the port used to hit the endpoint will be the same as the port that traffic arrives on at the listener.

Default: - No overrides

Region

The AWS Region where the endpoint group is located.

public string? Region { get; set; }

Property Value

string

Remarks

Default: - region of the first endpoint in this group, or the stack region if that region can't be determined

TrafficDialPercentage

The percentage of traffic to send to this AWS Region.

public double? TrafficDialPercentage { get; set; }

Property Value

double?

Remarks

The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing. Additional traffic is distributed to other endpoint groups for this listener.

Default: 100

Implements

IEndpointGroupOptions