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

Class InstanceEndpoint.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<InstanceEndpoint>

Enclosing class:

InstanceEndpoint

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

A fluent builder for InstanceEndpoint.

Method Summary

Modifier and Type	Method	Description
InstanceEndpoint	build()
static InstanceEndpoint.Builder	create(IInstance instance)
InstanceEndpoint.Builder	preserveClientIp(Boolean preserveClientIp)	Forward the client IP address.
InstanceEndpoint.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 InstanceEndpoint.Builder create(IInstance instance)

Parameters:

instance - This parameter is required.

Returns:

a new instance of InstanceEndpoint.Builder.

preserveClientIp

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

Forward the client IP address.

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. This parameter is required.

Returns:

this

weight

@Stability(Stable)
public InstanceEndpoint.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 InstanceEndpoint build()

Specified by:

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

Returns:

a newly built instance of InstanceEndpoint.