Package software.amazon.awscdk.services.elasticloadbalancingv2

Class NetworkTargetGroupProps.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancingv2.NetworkTargetGroupProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<NetworkTargetGroupProps>

Enclosing interface:

NetworkTargetGroupProps

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

A builder for NetworkTargetGroupProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NetworkTargetGroupProps	build()	Builds the configured instance.
NetworkTargetGroupProps.Builder	deregistrationDelay(Duration deregistrationDelay)	Sets the value of BaseTargetGroupProps.getDeregistrationDelay()
NetworkTargetGroupProps.Builder	healthCheck(HealthCheck healthCheck)	Sets the value of BaseTargetGroupProps.getHealthCheck()
NetworkTargetGroupProps.Builder	port(Number port)	Sets the value of NetworkTargetGroupProps.getPort()
NetworkTargetGroupProps.Builder	preserveClientIp(Boolean preserveClientIp)	Sets the value of NetworkTargetGroupProps.getPreserveClientIp()
NetworkTargetGroupProps.Builder	protocol(Protocol protocol)	Sets the value of NetworkTargetGroupProps.getProtocol()
NetworkTargetGroupProps.Builder	proxyProtocolV2(Boolean proxyProtocolV2)	Sets the value of NetworkTargetGroupProps.getProxyProtocolV2()
NetworkTargetGroupProps.Builder	targetGroupName(String targetGroupName)	Sets the value of BaseTargetGroupProps.getTargetGroupName()
NetworkTargetGroupProps.Builder	targets(List<? extends INetworkLoadBalancerTarget> targets)	Sets the value of NetworkTargetGroupProps.getTargets()
NetworkTargetGroupProps.Builder	targetType(TargetType targetType)	Sets the value of BaseTargetGroupProps.getTargetType()
NetworkTargetGroupProps.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

port

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

Sets the value of NetworkTargetGroupProps.getPort()

Parameters:

port - The port on which the listener listens for requests. This parameter is required.

Returns:

this

preserveClientIp

@Stability(Stable)
public NetworkTargetGroupProps.Builder preserveClientIp(Boolean preserveClientIp)

Sets the value of NetworkTargetGroupProps.getPreserveClientIp()

Parameters:

preserveClientIp - Indicates whether client IP preservation is enabled.

Returns:

this

protocol

@Stability(Stable)
public NetworkTargetGroupProps.Builder protocol(Protocol protocol)

Sets the value of NetworkTargetGroupProps.getProtocol()

Parameters:

protocol - Protocol for target group, expects TCP, TLS, UDP, or TCP_UDP.

Returns:

this

proxyProtocolV2

@Stability(Stable)
public NetworkTargetGroupProps.Builder proxyProtocolV2(Boolean proxyProtocolV2)

Sets the value of NetworkTargetGroupProps.getProxyProtocolV2()

Parameters:

proxyProtocolV2 - Indicates whether Proxy Protocol version 2 is enabled.

Returns:

this

targets

@Stability(Stable)
public NetworkTargetGroupProps.Builder targets(List<? extends INetworkLoadBalancerTarget> targets)

Sets the value of NetworkTargetGroupProps.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 NetworkTargetGroupProps.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 NetworkTargetGroupProps.Builder healthCheck(HealthCheck healthCheck)

Sets the value of BaseTargetGroupProps.getHealthCheck()

Parameters:

healthCheck - Health check configuration.

Returns:

this

targetGroupName

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of NetworkTargetGroupProps

Throws:

NullPointerException - if any required attribute was not provided