Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface AddNetworkTargetsProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
AddNetworkTargetsProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:16.947Z") @Stability(Stable) public interface AddNetworkTargetsProps extends software.amazon.jsii.JsiiSerializable
Properties for adding new network targets to a listener.

Example: 

 Vpc vpc;
 AutoScalingGroup asg;
 ISecurityGroup sg1;
 ISecurityGroup sg2;
 // Create the load balancer in a VPC. 'internetFacing' is 'false'
 // by default, which creates an internal load balancer.
 NetworkLoadBalancer lb = NetworkLoadBalancer.Builder.create(this, "LB")
         .vpc(vpc)
         .internetFacing(true)
         .securityGroups(List.of(sg1))
         .build();
 lb.addSecurityGroup(sg2);
 // Add a listener on a particular port.
 NetworkListener listener = lb.addListener("Listener", BaseNetworkListenerProps.builder()
         .port(443)
         .build());
 // Add targets on a particular port.
 listener.addTargets("AppFleet", AddNetworkTargetsProps.builder()
         .port(443)
         .targets(List.of(asg))
         .build());

  • Method Details

    • getPort

      @Stability(Stable) @NotNull Number getPort()
      The port on which the listener listens for requests.

      Default: Determined from protocol if known

    • getDeregistrationDelay

      @Stability(Stable) @Nullable 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

      @Stability(Stable) @Nullable default HealthCheck getHealthCheck()
      Health check configuration.

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

      See Also:

    • getPreserveClientIp

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default Protocol getProtocol()
      Protocol for target group, expects TCP, TLS, UDP, or TCP_UDP.

      Default: - inherits the protocol of the listener

    • getProxyProtocolV2

      @Stability(Stable) @Nullable default Boolean getProxyProtocolV2()
      Indicates whether Proxy Protocol version 2 is enabled.

      Default: false

    • getTargetGroupName

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) static AddNetworkTargetsProps.Builder builder()
      Returns:
      a AddNetworkTargetsProps.Builder of AddNetworkTargetsProps