Package software.amazon.awscdk.services.elasticloadbalancingv2

Class ApplicationTargetGroupProps.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationTargetGroupProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApplicationTargetGroupProps>

Enclosing interface:

ApplicationTargetGroupProps

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

A builder for ApplicationTargetGroupProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApplicationTargetGroupProps	build()	Builds the configured instance.
ApplicationTargetGroupProps.Builder	deregistrationDelay(Duration deregistrationDelay)	Sets the value of BaseTargetGroupProps.getDeregistrationDelay()
ApplicationTargetGroupProps.Builder	healthCheck(HealthCheck healthCheck)	Sets the value of BaseTargetGroupProps.getHealthCheck()
ApplicationTargetGroupProps.Builder	loadBalancingAlgorithmType(TargetGroupLoadBalancingAlgorithmType loadBalancingAlgorithmType)	Sets the value of ApplicationTargetGroupProps.getLoadBalancingAlgorithmType()
ApplicationTargetGroupProps.Builder	port(Number port)	Sets the value of ApplicationTargetGroupProps.getPort()
ApplicationTargetGroupProps.Builder	protocol(ApplicationProtocol protocol)	Sets the value of ApplicationTargetGroupProps.getProtocol()
ApplicationTargetGroupProps.Builder	protocolVersion(ApplicationProtocolVersion protocolVersion)	Sets the value of ApplicationTargetGroupProps.getProtocolVersion()
ApplicationTargetGroupProps.Builder	slowStart(Duration slowStart)	Sets the value of ApplicationTargetGroupProps.getSlowStart()
ApplicationTargetGroupProps.Builder	stickinessCookieDuration(Duration stickinessCookieDuration)	Sets the value of ApplicationTargetGroupProps.getStickinessCookieDuration()
ApplicationTargetGroupProps.Builder	stickinessCookieName(String stickinessCookieName)	Sets the value of ApplicationTargetGroupProps.getStickinessCookieName()
ApplicationTargetGroupProps.Builder	targetGroupName(String targetGroupName)	Sets the value of BaseTargetGroupProps.getTargetGroupName()
ApplicationTargetGroupProps.Builder	targets(List<? extends IApplicationLoadBalancerTarget> targets)	Sets the value of ApplicationTargetGroupProps.getTargets()
ApplicationTargetGroupProps.Builder	targetType(TargetType targetType)	Sets the value of BaseTargetGroupProps.getTargetType()
ApplicationTargetGroupProps.Builder	vpc(IVpc vpc)	Sets the value of BaseTargetGroupProps.getVpc()

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

loadBalancingAlgorithmType

@Stability(Stable)
public ApplicationTargetGroupProps.Builder loadBalancingAlgorithmType(TargetGroupLoadBalancingAlgorithmType loadBalancingAlgorithmType)

Sets the value of ApplicationTargetGroupProps.getLoadBalancingAlgorithmType()

Parameters:

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

Returns:

this

port

@Stability(Stable)
public ApplicationTargetGroupProps.Builder port(Number port)

Sets the value of ApplicationTargetGroupProps.getPort()

Parameters:

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

Returns:

this

protocol

@Stability(Stable)
public ApplicationTargetGroupProps.Builder protocol(ApplicationProtocol protocol)

Sets the value of ApplicationTargetGroupProps.getProtocol()

Parameters:

protocol - The protocol to use.

Returns:

this

protocolVersion

@Stability(Stable)
public ApplicationTargetGroupProps.Builder protocolVersion(ApplicationProtocolVersion protocolVersion)

Sets the value of ApplicationTargetGroupProps.getProtocolVersion()

Parameters:

protocolVersion - The protocol version to use.

Returns:

this

slowStart

@Stability(Stable)
public ApplicationTargetGroupProps.Builder slowStart(Duration slowStart)

Sets the value of ApplicationTargetGroupProps.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

@Stability(Stable)
public ApplicationTargetGroupProps.Builder stickinessCookieDuration(Duration stickinessCookieDuration)

Sets the value of ApplicationTargetGroupProps.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

@Stability(Stable)
public ApplicationTargetGroupProps.Builder stickinessCookieName(String stickinessCookieName)

Sets the value of ApplicationTargetGroupProps.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

targets

@Stability(Stable)
public ApplicationTargetGroupProps.Builder targets(List<? extends IApplicationLoadBalancerTarget> targets)

Sets the value of ApplicationTargetGroupProps.getTargets()

Parameters:

targets - The targets to add to this target group. Can be Instance, IPAddress, or any self-registering load balancing target. If you use either Instance or IPAddress as targets, all target must be of the same type.

Returns:

this

deregistrationDelay

@Stability(Stable)
public ApplicationTargetGroupProps.Builder deregistrationDelay(Duration deregistrationDelay)

Sets the value of BaseTargetGroupProps.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

@Stability(Stable)
public ApplicationTargetGroupProps.Builder healthCheck(HealthCheck healthCheck)

Sets the value of BaseTargetGroupProps.getHealthCheck()

Parameters:

healthCheck - Health check configuration.

Returns:

this

targetGroupName

@Stability(Stable)
public ApplicationTargetGroupProps.Builder targetGroupName(String targetGroupName)

Sets the value of BaseTargetGroupProps.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

targetType

@Stability(Stable)
public ApplicationTargetGroupProps.Builder targetType(TargetType targetType)

Sets the value of BaseTargetGroupProps.getTargetType()

Parameters:

targetType - The type of targets registered to this TargetGroup, either IP or Instance. All targets registered into the group must be of this type. If you register targets to the TargetGroup in the CDK app, the TargetType is determined automatically.

Returns:

this

vpc

@Stability(Stable)
public ApplicationTargetGroupProps.Builder vpc(IVpc vpc)

Sets the value of BaseTargetGroupProps.getVpc()

Parameters:

vpc - The virtual private cloud (VPC). only if TargetType is Ip or InstanceId

Returns:

this

build

@Stability(Stable)
public ApplicationTargetGroupProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ApplicationTargetGroupProps

Throws:

NullPointerException - if any required attribute was not provided