Interface ICfnEndpointGroupProps
Properties for defining a CfnEndpointGroup
.
Namespace: Amazon.CDK.AWS.GlobalAccelerator
Assembly: Amazon.CDK.AWS.GlobalAccelerator.dll
Syntax (csharp)
public interface ICfnEndpointGroupProps
Syntax (vb)
Public Interface ICfnEndpointGroupProps
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;
var cfnEndpointGroupProps = new CfnEndpointGroupProps {
EndpointGroupRegion = "endpointGroupRegion",
ListenerArn = "listenerArn",
// the properties below are optional
EndpointConfigurations = new [] { new EndpointConfigurationProperty {
EndpointId = "endpointId",
// the properties below are optional
ClientIpPreservationEnabled = false,
Weight = 123
} },
HealthCheckIntervalSeconds = 123,
HealthCheckPath = "healthCheckPath",
HealthCheckPort = 123,
HealthCheckProtocol = "healthCheckProtocol",
PortOverrides = new [] { new PortOverrideProperty {
EndpointPort = 123,
ListenerPort = 123
} },
ThresholdCount = 123,
TrafficDialPercentage = 123
};
Synopsis
Properties
EndpointConfigurations | The list of endpoint objects. |
EndpointGroupRegion | The AWS Regions where the endpoint group is located. |
HealthCheckIntervalSeconds | The time—10 seconds or 30 seconds—between health checks for each endpoint. |
HealthCheckPath | If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. |
HealthCheckPort | The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. |
HealthCheckProtocol | The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. |
ListenerArn | The Amazon Resource Name (ARN) of the listener. |
PortOverrides | Allows you to override the destination ports used to route traffic to an endpoint. |
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. |
TrafficDialPercentage | The percentage of traffic to send to an AWS Regions . |
Properties
EndpointConfigurations
The list of endpoint objects.
virtual object EndpointConfigurations { get; }
Property Value
System.Object
Remarks
EndpointGroupRegion
The AWS Regions where the endpoint group is located.
string EndpointGroupRegion { get; }
Property Value
System.String
Remarks
HealthCheckIntervalSeconds
The time—10 seconds or 30 seconds—between health checks for each endpoint.
virtual Nullable<double> HealthCheckIntervalSeconds { get; }
Property Value
System.Nullable<System.Double>
Remarks
HealthCheckPath
If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks.
virtual string HealthCheckPath { get; }
Property Value
System.String
Remarks
HealthCheckPort
The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
virtual Nullable<double> HealthCheckPort { get; }
Property Value
System.Nullable<System.Double>
Remarks
The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.
HealthCheckProtocol
The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
virtual string HealthCheckProtocol { get; }
Property Value
System.String
Remarks
ListenerArn
The Amazon Resource Name (ARN) of the listener.
string ListenerArn { get; }
Property Value
System.String
Remarks
PortOverrides
Allows you to override the destination ports used to route traffic to an endpoint.
virtual object PortOverrides { get; }
Property Value
System.Object
Remarks
Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.
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.
virtual Nullable<double> ThresholdCount { get; }
Property Value
System.Nullable<System.Double>
Remarks
TrafficDialPercentage
The percentage of traffic to send to an AWS Regions .
virtual Nullable<double> TrafficDialPercentage { get; }
Property Value
System.Nullable<System.Double>
Remarks
Additional traffic is distributed to other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.