Package software.amazon.awscdk.services.globalaccelerator

Class RawEndpoint.Builder

java.lang.Object

software.amazon.awscdk.services.globalaccelerator.RawEndpoint.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<RawEndpoint>

Enclosing class:

RawEndpoint

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

A fluent builder for RawEndpoint.

Method Summary

Modifier and Type	Method	Description
RawEndpoint	build()
static RawEndpoint.Builder	create()
RawEndpoint.Builder	endpointId(String endpointId)	Identifier of the endpoint.
RawEndpoint.Builder	preserveClientIp(Boolean preserveClientIp)	Forward the client IP address.
RawEndpoint.Builder	region(String region)	The region where this endpoint is located.
RawEndpoint.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 RawEndpoint.Builder create()

Returns:

a new instance of RawEndpoint.Builder.

endpointId

@Stability(Stable)
public RawEndpoint.Builder endpointId(String endpointId)

Identifier of the endpoint.

Load balancer ARN, instance ID or EIP allocation ID.

Parameters:

endpointId - Identifier of the endpoint. This parameter is required.

Returns:

this

preserveClientIp

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

Only applies to Application Load Balancers and EC2 instances.

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

Default: true if possible and available

Parameters:

preserveClientIp - Forward the client IP address. This parameter is required.

Returns:

this

region

@Stability(Stable)
public RawEndpoint.Builder region(String region)

The region where this endpoint is located.

Default: - Unknown what region this endpoint is located

Parameters:

region - The region where this endpoint is located. This parameter is required.

Returns:

this

weight

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

Specified by:

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

Returns:

a newly built instance of RawEndpoint.