software.amazon.awscdk.services.globalaccelerator

Interface CfnEndpointGroup.EndpointConfigurationProperty

All Known Implementing Classes:

CfnEndpointGroup.EndpointConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnEndpointGroup

public static interface CfnEndpointGroup.EndpointConfigurationProperty

A complex type for endpoints.

A resource must be valid and active when you add it as an endpoint.

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.*;
 EndpointConfigurationProperty endpointConfigurationProperty = EndpointConfigurationProperty.builder()
         .endpointId("endpointId")
         // the properties below are optional
         .clientIpPreservationEnabled(false)
         .weight(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnEndpointGroup.EndpointConfigurationProperty.Builder	builder()
default java.lang.Object	getClientIpPreservationEnabled() Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint.
java.lang.String	getEndpointId() An ID for the endpoint.
default java.lang.Number	getWeight() The weight associated with the endpoint.

Method Detail

getEndpointId

java.lang.String getEndpointId()

An ID for the endpoint.

If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active when you add it as an endpoint.

An Application Load Balancer can be either internal or internet-facing.

getClientIpPreservationEnabled

default java.lang.Object getClientIpPreservationEnabled()

Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint.

The value is true or false. The default value is true for new accelerators.

If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

For more information, see Preserve Client IP Addresses in the AWS Global Accelerator Developer Guide .

getWeight

default java.lang.Number getWeight()

The weight associated with the endpoint.

When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .

builder

static CfnEndpointGroup.EndpointConfigurationProperty.Builder builder()

Returns:

a CfnEndpointGroup.EndpointConfigurationProperty.Builder of CfnEndpointGroup.EndpointConfigurationProperty