Package software.amazon.awscdk.services.globalaccelerator.endpoints

Class ApplicationLoadBalancerEndpoint.Builder

java.lang.Object

software.amazon.awscdk.services.globalaccelerator.endpoints.ApplicationLoadBalancerEndpoint.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApplicationLoadBalancerEndpoint>

Enclosing class:

ApplicationLoadBalancerEndpoint

@Stability(Stable)
public static final class ApplicationLoadBalancerEndpoint.Builder
extends Object
implements software.amazon.jsii.Builder<ApplicationLoadBalancerEndpoint>

A fluent builder for ApplicationLoadBalancerEndpoint.

Method Summary

Modifier and Type	Method	Description
ApplicationLoadBalancerEndpoint	build()
static ApplicationLoadBalancerEndpoint.Builder	create(IApplicationLoadBalancer loadBalancer)
ApplicationLoadBalancerEndpoint.Builder	preserveClientIp(Boolean preserveClientIp)	Forward the client IP address in an X-Forwarded-For header.
ApplicationLoadBalancerEndpoint.Builder	weight(Number weight)	Endpoint weight across all endpoints in the group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static ApplicationLoadBalancerEndpoint.Builder create(IApplicationLoadBalancer loadBalancer)

Parameters:

loadBalancer - This parameter is required.

Returns:

a new instance of ApplicationLoadBalancerEndpoint.Builder.

preserveClientIp

@Stability(Stable)
public ApplicationLoadBalancerEndpoint.Builder preserveClientIp(Boolean preserveClientIp)

Forward the client IP address in an X-Forwarded-For header.

GlobalAccelerator will create Network Interfaces in your VPC in order to preserve the client IP address.

Client IP address preservation is supported only in specific AWS Regions. See the GlobalAccelerator Developer Guide for a list.

Default: true if available

Parameters:

preserveClientIp - Forward the client IP address in an X-Forwarded-For header. This parameter is required.

Returns:

this

weight

@Stability(Stable)
public ApplicationLoadBalancerEndpoint.Builder weight(Number weight)

Endpoint weight across all endpoints in the group.

Must be a value between 0 and 255.

Default: 128

Parameters:

weight - Endpoint weight across all endpoints in the group. This parameter is required.

Returns:

this

build

@Stability(Stable)
public ApplicationLoadBalancerEndpoint build()

Specified by:

build in interface software.amazon.jsii.Builder<ApplicationLoadBalancerEndpoint>

Returns:

a newly built instance of ApplicationLoadBalancerEndpoint.