software.amazon.awscdk.services.elasticloadbalancingv2

Class NetworkTargetGroup.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancingv2.NetworkTargetGroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<NetworkTargetGroup>

Enclosing class:

NetworkTargetGroup

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

(experimental) A fluent builder for NetworkTargetGroup.

Method Summary

Modifier and Type	Method and Description
NetworkTargetGroup	build()
static NetworkTargetGroup.Builder	create(software.constructs.Construct scope, String id)
NetworkTargetGroup.Builder	deregistrationDelay(Duration deregistrationDelay) (experimental) The amount of time for Elastic Load Balancing to wait before deregistering a target.
NetworkTargetGroup.Builder	healthCheck(HealthCheck healthCheck) (experimental) Health check configuration.
NetworkTargetGroup.Builder	port(Number port) (experimental) The port on which the listener listens for requests.
NetworkTargetGroup.Builder	preserveClientIp(Boolean preserveClientIp) (experimental) Indicates whether client IP preservation is enabled.
NetworkTargetGroup.Builder	protocol(Protocol protocol) (experimental) Protocol for target group, expects TCP, TLS, UDP, or TCP_UDP.
NetworkTargetGroup.Builder	proxyProtocolV2(Boolean proxyProtocolV2) (experimental) Indicates whether Proxy Protocol version 2 is enabled.
NetworkTargetGroup.Builder	targetGroupName(String targetGroupName) (experimental) The name of the target group.
NetworkTargetGroup.Builder	targets(List<? extends INetworkLoadBalancerTarget> targets) (experimental) The targets to add to this target group.
NetworkTargetGroup.Builder	targetType(TargetType targetType) (experimental) The type of targets registered to this TargetGroup, either IP or Instance.
NetworkTargetGroup.Builder	vpc(IVpc vpc) (experimental) The virtual private cloud (VPC).

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 NetworkTargetGroup.Builder create(software.constructs.Construct scope,
                                                                               String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of NetworkTargetGroup.Builder.

deregistrationDelay

@Stability(value=Experimental)
public NetworkTargetGroup.Builder deregistrationDelay(Duration deregistrationDelay)

(experimental) The amount of time for Elastic Load Balancing to wait before deregistering a target.

The range is 0-3600 seconds.

Default: 300

Parameters:

deregistrationDelay - The amount of time for Elastic Load Balancing to wait before deregistering a target. This parameter is required.

Returns:

this

healthCheck

@Stability(value=Experimental)
public NetworkTargetGroup.Builder healthCheck(HealthCheck healthCheck)

(experimental) Health check configuration.

Default: - None.

Parameters:

healthCheck - Health check configuration. This parameter is required.

Returns:

this

targetGroupName

@Stability(value=Experimental)
public NetworkTargetGroup.Builder targetGroupName(String targetGroupName)

(experimental) 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.

Default: - Automatically generated.

Parameters:

targetGroupName - The name of the target group. This parameter is required.

Returns:

this

targetType

@Stability(value=Experimental)
public NetworkTargetGroup.Builder targetType(TargetType targetType)

(experimental) 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.

Default: - Determined automatically.

Parameters:

targetType - The type of targets registered to this TargetGroup, either IP or Instance. This parameter is required.

Returns:

this

vpc

@Stability(value=Experimental)
public NetworkTargetGroup.Builder vpc(IVpc vpc)

(experimental) The virtual private cloud (VPC).

only if TargetType is Ip or InstanceId

Default: - undefined

Parameters:

vpc - The virtual private cloud (VPC). This parameter is required.

Returns:

this

port

@Stability(value=Experimental)
public NetworkTargetGroup.Builder port(Number port)

(experimental) The port on which the listener listens for requests.

Parameters:

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

Returns:

this

preserveClientIp

@Stability(value=Experimental)
public NetworkTargetGroup.Builder preserveClientIp(Boolean preserveClientIp)

(experimental) Indicates whether client IP preservation is enabled.

Default: false if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, true.

Parameters:

preserveClientIp - Indicates whether client IP preservation is enabled. This parameter is required.

Returns:

this

protocol

@Stability(value=Experimental)
public NetworkTargetGroup.Builder protocol(Protocol protocol)

(experimental) Protocol for target group, expects TCP, TLS, UDP, or TCP_UDP.

Default: - TCP

Parameters:

protocol - Protocol for target group, expects TCP, TLS, UDP, or TCP_UDP. This parameter is required.

Returns:

this

proxyProtocolV2

@Stability(value=Experimental)
public NetworkTargetGroup.Builder proxyProtocolV2(Boolean proxyProtocolV2)

(experimental) Indicates whether Proxy Protocol version 2 is enabled.

Default: false

Parameters:

proxyProtocolV2 - Indicates whether Proxy Protocol version 2 is enabled. This parameter is required.

Returns:

this

targets

@Stability(value=Experimental)
public NetworkTargetGroup.Builder targets(List<? extends INetworkLoadBalancerTarget> targets)

(experimental) 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.

Default: - No targets.

Parameters:

targets - The targets to add to this target group. This parameter is required.

Returns:

this

build

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

Specified by:

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