Package software.amazon.awscdk.services.globalaccelerator

Class EndpointGroupProps.Builder

java.lang.Object

software.amazon.awscdk.services.globalaccelerator.EndpointGroupProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EndpointGroupProps>

Enclosing interface:

EndpointGroupProps

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

A builder for EndpointGroupProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EndpointGroupProps	build()	Builds the configured instance.
EndpointGroupProps.Builder	endpointGroupName(String endpointGroupName)	Sets the value of EndpointGroupOptions.getEndpointGroupName()
EndpointGroupProps.Builder	endpoints(List<? extends IEndpoint> endpoints)	Sets the value of EndpointGroupOptions.getEndpoints()
EndpointGroupProps.Builder	healthCheckInterval(Duration healthCheckInterval)	Sets the value of EndpointGroupOptions.getHealthCheckInterval()
EndpointGroupProps.Builder	healthCheckPath(String healthCheckPath)	Sets the value of EndpointGroupOptions.getHealthCheckPath()
EndpointGroupProps.Builder	healthCheckPort(Number healthCheckPort)	Sets the value of EndpointGroupOptions.getHealthCheckPort()
EndpointGroupProps.Builder	healthCheckProtocol(HealthCheckProtocol healthCheckProtocol)	Sets the value of EndpointGroupOptions.getHealthCheckProtocol()
EndpointGroupProps.Builder	healthCheckThreshold(Number healthCheckThreshold)	Sets the value of EndpointGroupOptions.getHealthCheckThreshold()
EndpointGroupProps.Builder	listener(IListener listener)	Sets the value of EndpointGroupProps.getListener()
EndpointGroupProps.Builder	portOverrides(List<? extends PortOverride> portOverrides)	Sets the value of EndpointGroupOptions.getPortOverrides()
EndpointGroupProps.Builder	region(String region)	Sets the value of EndpointGroupOptions.getRegion()
EndpointGroupProps.Builder	trafficDialPercentage(Number trafficDialPercentage)	Sets the value of EndpointGroupOptions.getTrafficDialPercentage()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

listener

@Stability(Stable)
public EndpointGroupProps.Builder listener(IListener listener)

Sets the value of EndpointGroupProps.getListener()

Parameters:

listener - The Amazon Resource Name (ARN) of the listener. This parameter is required.

Returns:

this

endpointGroupName

@Stability(Stable)
public EndpointGroupProps.Builder endpointGroupName(String endpointGroupName)

Sets the value of EndpointGroupOptions.getEndpointGroupName()

Parameters:

endpointGroupName - Name of the endpoint group.

Returns:

this

endpoints

@Stability(Stable)
public EndpointGroupProps.Builder endpoints(List<? extends IEndpoint> endpoints)

Sets the value of EndpointGroupOptions.getEndpoints()

Parameters:

endpoints - Initial list of endpoints for this group.

Returns:

this

healthCheckInterval

@Stability(Stable)
public EndpointGroupProps.Builder healthCheckInterval(Duration healthCheckInterval)

Sets the value of EndpointGroupOptions.getHealthCheckInterval()

Parameters:

healthCheckInterval - The time between health checks for each endpoint. Must be either 10 or 30 seconds.

Returns:

this

healthCheckPath

@Stability(Stable)
public EndpointGroupProps.Builder healthCheckPath(String healthCheckPath)

Sets the value of EndpointGroupOptions.getHealthCheckPath()

Parameters:

healthCheckPath - The ping path for health checks (if the protocol is HTTP(S)).

Returns:

this

healthCheckPort

@Stability(Stable)
public EndpointGroupProps.Builder healthCheckPort(Number healthCheckPort)

Sets the value of EndpointGroupOptions.getHealthCheckPort()

Parameters:

healthCheckPort - The port used to perform health checks.

Returns:

this

healthCheckProtocol

@Stability(Stable)
public EndpointGroupProps.Builder healthCheckProtocol(HealthCheckProtocol healthCheckProtocol)

Sets the value of EndpointGroupOptions.getHealthCheckProtocol()

Parameters:

healthCheckProtocol - The protocol used to perform health checks.

Returns:

this

healthCheckThreshold

@Stability(Stable)
public EndpointGroupProps.Builder healthCheckThreshold(Number healthCheckThreshold)

Sets the value of EndpointGroupOptions.getHealthCheckThreshold()

Parameters:

healthCheckThreshold - The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy.

Returns:

this

portOverrides

@Stability(Stable)
public EndpointGroupProps.Builder portOverrides(List<? extends PortOverride> portOverrides)

Sets the value of EndpointGroupOptions.getPortOverrides()

Parameters:

portOverrides - Override the destination ports used to route traffic to an endpoint. Unless overridden, the port used to hit the endpoint will be the same as the port that traffic arrives on at the listener.

Returns:

this

region

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

Sets the value of EndpointGroupOptions.getRegion()

Parameters:

region - The AWS Region where the endpoint group is located.

Returns:

this

trafficDialPercentage

@Stability(Stable)
public EndpointGroupProps.Builder trafficDialPercentage(Number trafficDialPercentage)

Sets the value of EndpointGroupOptions.getTrafficDialPercentage()

Parameters:

trafficDialPercentage - The percentage of traffic to send to this AWS Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing. Additional traffic is distributed to other endpoint groups for this listener.

Returns:

this

build

@Stability(Stable)
public EndpointGroupProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EndpointGroupProps

Throws:

NullPointerException - if any required attribute was not provided