Package software.amazon.awscdk.services.globalaccelerator

Interface CfnEndpointGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpointGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:07.759Z")
@Stability(Stable)
public interface CfnEndpointGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEndpointGroup.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.globalaccelerator.*;
 CfnEndpointGroupProps cfnEndpointGroupProps = CfnEndpointGroupProps.builder()
         .endpointGroupRegion("endpointGroupRegion")
         .listenerArn("listenerArn")
         // the properties below are optional
         .endpointConfigurations(List.of(EndpointConfigurationProperty.builder()
                 .endpointId("endpointId")
                 // the properties below are optional
                 .attachmentArn("attachmentArn")
                 .clientIpPreservationEnabled(false)
                 .weight(123)
                 .build()))
         .healthCheckIntervalSeconds(123)
         .healthCheckPath("healthCheckPath")
         .healthCheckPort(123)
         .healthCheckProtocol("healthCheckProtocol")
         .portOverrides(List.of(PortOverrideProperty.builder()
                 .endpointPort(123)
                 .listenerPort(123)
                 .build()))
         .thresholdCount(123)
         .trafficDialPercentage(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEndpointGroupProps.Builder	A builder for CfnEndpointGroupProps
static final class	CfnEndpointGroupProps.Jsii$Proxy	An implementation for CfnEndpointGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnEndpointGroupProps.Builder	builder()
default Object	getEndpointConfigurations()	The list of endpoint objects.
String	getEndpointGroupRegion()	The AWS Regions where the endpoint group is located.
default Number	getHealthCheckIntervalSeconds()	The time—10 seconds or 30 seconds—between health checks for each endpoint.
default String	getHealthCheckPath()	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.
default Number	getHealthCheckPort()	The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
default String	getHealthCheckProtocol()	The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
String	getListenerArn()	The Amazon Resource Name (ARN) of the listener.
default Object	getPortOverrides()	Allows you to override the destination ports used to route traffic to an endpoint.
default Number	getThresholdCount()	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.
default Number	getTrafficDialPercentage()	The percentage of traffic to send to an AWS Regions .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpointGroupRegion

@Stability(Stable)
@NotNull
String getEndpointGroupRegion()

The AWS Regions where the endpoint group is located.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-endpointgroupregion

getListenerArn

@Stability(Stable)
@NotNull
String getListenerArn()

The Amazon Resource Name (ARN) of the listener.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-listenerarn

getEndpointConfigurations

@Stability(Stable)
@Nullable
default Object getEndpointConfigurations()

The list of endpoint objects.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-endpointconfigurations

getHealthCheckIntervalSeconds

@Stability(Stable)
@Nullable
default Number getHealthCheckIntervalSeconds()

The time—10 seconds or 30 seconds—between health checks for each endpoint.

The default value is 30.

Default: - 30

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckintervalseconds

getHealthCheckPath

@Stability(Stable)
@Nullable
default String getHealthCheckPath()

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.

The default is slash (/).

Default: - "/"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckpath

getHealthCheckPort

@Stability(Stable)
@Nullable
default Number getHealthCheckPort()

The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckport

getHealthCheckProtocol

@Stability(Stable)
@Nullable
default String getHealthCheckProtocol()

The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

The default value is TCP.

Default: - "TCP"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckprotocol

getPortOverrides

@Stability(Stable)
@Nullable
default Object getPortOverrides()

Allows you to override the destination ports used to route traffic to an endpoint.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-portoverrides

getThresholdCount

@Stability(Stable)
@Nullable
default Number getThresholdCount()

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.

Default: - 3

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-thresholdcount

getTrafficDialPercentage

@Stability(Stable)
@Nullable
default Number getTrafficDialPercentage()

The percentage of traffic to send to an AWS Regions .

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-trafficdialpercentage

builder

@Stability(Stable)
static CfnEndpointGroupProps.Builder builder()

Returns:

a CfnEndpointGroupProps.Builder of CfnEndpointGroupProps