software.amazon.awscdk.services.globalaccelerator

Class EndpointConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.globalaccelerator.EndpointConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EndpointConfiguration>

Enclosing class:

EndpointConfiguration

@Stability(value=Experimental)
public static final class EndpointConfiguration.Builder
extends Object
implements software.amazon.jsii.Builder<EndpointConfiguration>

(experimental) A fluent builder for EndpointConfiguration.

Method Summary

Modifier and Type	Method and Description
EndpointConfiguration	build()
EndpointConfiguration.Builder	clientIpReservation(Boolean clientIpReservation) (experimental) Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint.
static EndpointConfiguration.Builder	create(software.constructs.Construct scope, String id)
EndpointConfiguration.Builder	endpointGroup(EndpointGroup endpointGroup) (experimental) The endopoint group reesource.
EndpointConfiguration.Builder	endpointId(String endpointId) (experimental) An ID for the endpoint.
EndpointConfiguration.Builder	weight(Number weight) (experimental) The weight associated with the endpoint.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static EndpointConfiguration.Builder create(software.constructs.Construct scope,
                                                                                  String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of EndpointConfiguration.Builder.

clientIpReservation

@Stability(value=Experimental)
public EndpointConfiguration.Builder clientIpReservation(Boolean clientIpReservation)

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

Default: true

Parameters:

clientIpReservation - Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. This parameter is required.

Returns:

this

weight

@Stability(value=Experimental)
public EndpointConfiguration.Builder weight(Number weight)

(experimental) The weight associated with the endpoint.

When you add weights to endpoints, you configure AWS 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.

Default: - not specified

Parameters:

weight - The weight associated with the endpoint. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html

endpointGroup

@Stability(value=Experimental)
public EndpointConfiguration.Builder endpointGroup(EndpointGroup endpointGroup)

(experimental) The endopoint group reesource.

[disable-awslint:ref-via-interface]

Parameters:

endpointGroup - The endopoint group reesource. This parameter is required.

Returns:

this

endpointId

@Stability(value=Experimental)
public EndpointConfiguration.Builder endpointId(String endpointId)

(experimental) 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 EC2 instances, this is the EC2 instance ID.

Parameters:

endpointId - An ID for the endpoint. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public EndpointConfiguration build()

Specified by:

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