Interface ICfnEndpointGroupProps
Properties for defining a CfnEndpointGroup.
Namespace: Amazon.CDK.AWS.GlobalAccelerator
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnEndpointGroupPropsSyntax (vb)
Public Interface ICfnEndpointGroupPropsRemarks
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
AttachmentArn = "attachmentArn",
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.
object? EndpointConfigurations { get; }Property Value
Remarks
EndpointGroupRegion
The AWS Regions where the endpoint group is located.
string EndpointGroupRegion { get; }Property Value
Remarks
HealthCheckIntervalSeconds
The time—10 seconds or 30 seconds—between health checks for each endpoint.
double? HealthCheckIntervalSeconds { get; }Property Value
Remarks
The default value is 30.
Default: - 30
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.
string? HealthCheckPath { get; }Property Value
Remarks
The default is slash (/).
Default: - "/"
HealthCheckPort
The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
double? HealthCheckPort { get; }Property Value
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.
Default: - -1
HealthCheckProtocol
The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
string? HealthCheckProtocol { get; }Property Value
Remarks
The default value is TCP.
Default: - "TCP"
ListenerArn
The Amazon Resource Name (ARN) of the listener.
string ListenerArn { get; }Property Value
Remarks
PortOverrides
Allows you to override the destination ports used to route traffic to an endpoint.
object? PortOverrides { get; }Property Value
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.
double? ThresholdCount { get; }Property Value
Remarks
The default value is 3.
Default: - 3
TrafficDialPercentage
The percentage of traffic to send to an AWS Regions .
double? TrafficDialPercentage { get; }Property Value
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.
Default: - 100