Class EndpointGroupProps
Property of the EndpointGroup.
Inheritance
Namespace: Amazon.CDK.AWS.GlobalAccelerator
Assembly: Amazon.CDK.AWS.GlobalAccelerator.dll
Syntax (csharp)
public class EndpointGroupProps : Object, IEndpointGroupProps, IEndpointGroupOptions
Syntax (vb)
Public Class EndpointGroupProps
Inherits Object
Implements IEndpointGroupProps, IEndpointGroupOptions
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GlobalAccelerator;
using Amazon.CDK;
IEndpoint endpoint;
Listener listener;
var endpointGroupProps = new EndpointGroupProps {
Listener = listener,
// the properties below are optional
EndpointGroupName = "endpointGroupName",
Endpoints = new [] { endpoint },
HealthCheckInterval = Duration.Minutes(30),
HealthCheckPath = "healthCheckPath",
HealthCheckPort = 123,
HealthCheckProtocol = HealthCheckProtocol.TCP,
HealthCheckThreshold = 123,
PortOverrides = new [] { new PortOverride {
EndpointPort = 123,
ListenerPort = 123
} },
Region = "region",
TrafficDialPercentage = 123
};
Synopsis
Constructors
EndpointGroupProps() |
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. |
Listener | The Amazon Resource Name (ARN) of the listener. |
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
EndpointGroupProps()
public EndpointGroupProps()
Properties
EndpointGroupName
Name of the endpoint group.
public string EndpointGroupName { get; set; }
Property Value
System.String
Remarks
Default: - logical ID of the resource
Endpoints
Initial list of endpoints for this group.
public IEndpoint[] Endpoints { get; set; }
Property Value
Remarks
Default: - Group is initially empty
HealthCheckInterval
The time between health checks for each endpoint.
public Duration HealthCheckInterval { get; set; }
Property Value
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
System.String
Remarks
Default: '/'
HealthCheckPort
The port used to perform health checks.
public Nullable<double> HealthCheckPort { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - The listener's port
HealthCheckProtocol
The protocol used to perform health checks.
public Nullable<HealthCheckProtocol> HealthCheckProtocol { get; set; }
Property Value
System.Nullable<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 Nullable<double> HealthCheckThreshold { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 3
Listener
The Amazon Resource Name (ARN) of the listener.
public IListener Listener { get; set; }
Property Value
PortOverrides
Override the destination ports used to route traffic to an endpoint.
public IPortOverride[] PortOverrides { get; set; }
Property Value
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
System.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 Nullable<double> TrafficDialPercentage { get; set; }
Property Value
System.Nullable<System.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