software.amazon.awscdk.services.elasticloadbalancingv2

Interface AddNetworkTargetsProps

All Known Implementing Classes:

AddNetworkTargetsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.499Z")
public interface AddNetworkTargetsProps

Properties for adding new network targets to a listener.

Example:

 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpNlbIntegration;
 Vpc vpc = new Vpc(this, "VPC");
 NetworkLoadBalancer lb = NetworkLoadBalancer.Builder.create(this, "lb").vpc(vpc).build();
 NetworkListener listener = lb.addListener("listener", BaseNetworkListenerProps.builder().port(80).build());
 listener.addTargets("target", AddNetworkTargetsProps.builder()
         .port(80)
         .build());
 HttpApi httpEndpoint = HttpApi.Builder.create(this, "HttpProxyPrivateApi")
         .defaultIntegration(new HttpNlbIntegration("DefaultIntegration", listener))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AddNetworkTargetsProps.Builder A builder for AddNetworkTargetsProps
static class	AddNetworkTargetsProps.Jsii$Proxy An implementation for AddNetworkTargetsProps

Method Summary

Modifier and Type	Method and Description
static AddNetworkTargetsProps.Builder	builder()
default Duration	getDeregistrationDelay() The amount of time for Elastic Load Balancing to wait before deregistering a target.
default HealthCheck	getHealthCheck() Health check configuration.
java.lang.Number	getPort() The port on which the listener listens for requests.
default java.lang.Boolean	getPreserveClientIp() Indicates whether client IP preservation is enabled.
default Protocol	getProtocol() Protocol for target group, expects TCP, TLS, UDP, or TCP_UDP.
default java.lang.Boolean	getProxyProtocolV2() Indicates whether Proxy Protocol version 2 is enabled.
default java.lang.String	getTargetGroupName() The name of the target group.
default java.util.List<INetworkLoadBalancerTarget>	getTargets() The targets to add to this target group.

Method Detail

getPort

java.lang.Number getPort()

The port on which the listener listens for requests.

Default: Determined from protocol if known

getDeregistrationDelay

default Duration getDeregistrationDelay()

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

The range is 0-3600 seconds.

Default: Duration.minutes(5)

getHealthCheck

default HealthCheck getHealthCheck()

Health check configuration.

Default: - The default value for each property in this configuration varies depending on the target.

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#aws-resource-elasticloadbalancingv2-targetgroup-properties

getPreserveClientIp

default java.lang.Boolean getPreserveClientIp()

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.

getProtocol

default Protocol getProtocol()

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

Default: - inherits the protocol of the listener

getProxyProtocolV2

default java.lang.Boolean getProxyProtocolV2()

Indicates whether Proxy Protocol version 2 is enabled.

Default: false

getTargetGroupName

default java.lang.String getTargetGroupName()

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

getTargets

default java.util.List<INetworkLoadBalancerTarget> getTargets()

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.

builder

static AddNetworkTargetsProps.Builder builder()

Returns:

a AddNetworkTargetsProps.Builder of AddNetworkTargetsProps