software.amazon.awscdk.services.elasticloadbalancingv2

Class AddApplicationTargetsProps.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancingv2.AddApplicationTargetsProps.Builder

Enclosing interface:

AddApplicationTargetsProps

public static final class AddApplicationTargetsProps.Builder
extends java.lang.Object

A builder for AddApplicationTargetsProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AddApplicationTargetsProps	build() Builds the configured instance.
AddApplicationTargetsProps.Builder	conditions(java.util.List<? extends ListenerCondition> conditions) Sets the value of AddRuleProps.getConditions()
AddApplicationTargetsProps.Builder	deregistrationDelay(Duration deregistrationDelay) Sets the value of AddApplicationTargetsProps.getDeregistrationDelay()
AddApplicationTargetsProps.Builder	healthCheck(HealthCheck healthCheck) Sets the value of AddApplicationTargetsProps.getHealthCheck()
AddApplicationTargetsProps.Builder	hostHeader(java.lang.String hostHeader) Deprecated. Use `conditions` instead.
AddApplicationTargetsProps.Builder	loadBalancingAlgorithmType(TargetGroupLoadBalancingAlgorithmType loadBalancingAlgorithmType) Sets the value of AddApplicationTargetsProps.getLoadBalancingAlgorithmType()
AddApplicationTargetsProps.Builder	pathPattern(java.lang.String pathPattern) Deprecated. Use `conditions` instead.
AddApplicationTargetsProps.Builder	pathPatterns(java.util.List<java.lang.String> pathPatterns) Deprecated. Use `conditions` instead.
AddApplicationTargetsProps.Builder	port(java.lang.Number port) Sets the value of AddApplicationTargetsProps.getPort()
AddApplicationTargetsProps.Builder	priority(java.lang.Number priority) Sets the value of AddRuleProps.getPriority()
AddApplicationTargetsProps.Builder	protocol(ApplicationProtocol protocol) Sets the value of AddApplicationTargetsProps.getProtocol()
AddApplicationTargetsProps.Builder	protocolVersion(ApplicationProtocolVersion protocolVersion) Sets the value of AddApplicationTargetsProps.getProtocolVersion()
AddApplicationTargetsProps.Builder	slowStart(Duration slowStart) Sets the value of AddApplicationTargetsProps.getSlowStart()
AddApplicationTargetsProps.Builder	stickinessCookieDuration(Duration stickinessCookieDuration) Sets the value of AddApplicationTargetsProps.getStickinessCookieDuration()
AddApplicationTargetsProps.Builder	stickinessCookieName(java.lang.String stickinessCookieName) Sets the value of AddApplicationTargetsProps.getStickinessCookieName()
AddApplicationTargetsProps.Builder	targetGroupName(java.lang.String targetGroupName) Sets the value of AddApplicationTargetsProps.getTargetGroupName()
AddApplicationTargetsProps.Builder	targets(java.util.List<? extends IApplicationLoadBalancerTarget> targets) Sets the value of AddApplicationTargetsProps.getTargets()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

deregistrationDelay

public AddApplicationTargetsProps.Builder deregistrationDelay(Duration deregistrationDelay)

Sets the value of AddApplicationTargetsProps.getDeregistrationDelay()

Parameters:

deregistrationDelay - The amount of time for Elastic Load Balancing to wait before deregistering a target. The range is 0-3600 seconds.

Returns:

this

healthCheck

public AddApplicationTargetsProps.Builder healthCheck(HealthCheck healthCheck)

Sets the value of AddApplicationTargetsProps.getHealthCheck()

Parameters:

healthCheck - Health check configuration.

Returns:

this

loadBalancingAlgorithmType

public AddApplicationTargetsProps.Builder loadBalancingAlgorithmType(TargetGroupLoadBalancingAlgorithmType loadBalancingAlgorithmType)

Sets the value of AddApplicationTargetsProps.getLoadBalancingAlgorithmType()

Parameters:

loadBalancingAlgorithmType - The load balancing algorithm to select targets for routing requests.

Returns:

this

port

public AddApplicationTargetsProps.Builder port(java.lang.Number port)

Sets the value of AddApplicationTargetsProps.getPort()

Parameters:

port - The port on which the listener listens for requests.

Returns:

this

protocol

public AddApplicationTargetsProps.Builder protocol(ApplicationProtocol protocol)

Sets the value of AddApplicationTargetsProps.getProtocol()

Parameters:

protocol - The protocol to use.

Returns:

this

protocolVersion

public AddApplicationTargetsProps.Builder protocolVersion(ApplicationProtocolVersion protocolVersion)

Sets the value of AddApplicationTargetsProps.getProtocolVersion()

Parameters:

protocolVersion - The protocol version to use.

Returns:

this

slowStart

public AddApplicationTargetsProps.Builder slowStart(Duration slowStart)

Sets the value of AddApplicationTargetsProps.getSlowStart()

Parameters:

slowStart - The time period during which the load balancer sends a newly registered target a linearly increasing share of the traffic to the target group. The range is 30-900 seconds (15 minutes).

Returns:

this

stickinessCookieDuration

public AddApplicationTargetsProps.Builder stickinessCookieDuration(Duration stickinessCookieDuration)

Sets the value of AddApplicationTargetsProps.getStickinessCookieDuration()

Parameters:

stickinessCookieDuration - The stickiness cookie expiration period. Setting this value enables load balancer stickiness.

After this period, the cookie is considered stale. The minimum value is 1 second and the maximum value is 7 days (604800 seconds).

Returns:

this

stickinessCookieName

public AddApplicationTargetsProps.Builder stickinessCookieName(java.lang.String stickinessCookieName)

Sets the value of AddApplicationTargetsProps.getStickinessCookieName()

Parameters:

stickinessCookieName - The name of an application-based stickiness cookie. Names that start with the following prefixes are not allowed: AWSALB, AWSALBAPP, and AWSALBTG; they're reserved for use by the load balancer.

Note: stickinessCookieName parameter depends on the presence of stickinessCookieDuration parameter. If stickinessCookieDuration is not set, stickinessCookieName will be omitted.

Returns:

this

targetGroupName

public AddApplicationTargetsProps.Builder targetGroupName(java.lang.String targetGroupName)

Sets the value of AddApplicationTargetsProps.getTargetGroupName()

Parameters:

targetGroupName - The name of the target group. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.

Returns:

this

targets

public AddApplicationTargetsProps.Builder targets(java.util.List<? extends IApplicationLoadBalancerTarget> targets)

Sets the value of AddApplicationTargetsProps.getTargets()

Parameters:

targets - The targets to add to this target group. Can be Instance, IPAddress, or any self-registering load balancing target. All target must be of the same type.

Returns:

this

conditions

public AddApplicationTargetsProps.Builder conditions(java.util.List<? extends ListenerCondition> conditions)

Sets the value of AddRuleProps.getConditions()

Parameters:

conditions - Rule applies if matches the conditions.

Returns:

this

hostHeader

@Deprecated
public AddApplicationTargetsProps.Builder hostHeader(java.lang.String hostHeader)

Deprecated. Use `conditions` instead.

Sets the value of AddRuleProps.getHostHeader()

Parameters:

hostHeader - Rule applies if the requested host matches the indicated host. May contain up to three '*' wildcards.

Requires that priority is set.

Returns:

this

pathPattern

@Deprecated
public AddApplicationTargetsProps.Builder pathPattern(java.lang.String pathPattern)

Deprecated. Use `conditions` instead.

Sets the value of AddRuleProps.getPathPattern()

Parameters:

pathPattern - Rule applies if the requested path matches the given path pattern. May contain up to three '*' wildcards.

Requires that priority is set.

Returns:

this

pathPatterns

@Deprecated
public AddApplicationTargetsProps.Builder pathPatterns(java.util.List<java.lang.String> pathPatterns)

Deprecated. Use `conditions` instead.

Sets the value of AddRuleProps.getPathPatterns()

Parameters:

pathPatterns - Rule applies if the requested path matches any of the given patterns. May contain up to three '*' wildcards.

Requires that priority is set.

Returns:

this

priority

public AddApplicationTargetsProps.Builder priority(java.lang.Number priority)

Sets the value of AddRuleProps.getPriority()

Parameters:

priority - Priority of this target group. The rule with the lowest priority will be used for every request. If priority is not given, these target groups will be added as defaults, and must not have conditions.

Priorities must be unique.

Returns:

this

build

public AddApplicationTargetsProps build()

Builds the configured instance.

Returns:

a new instance of AddApplicationTargetsProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided