Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface AddApplicationTargetsProps

All Superinterfaces:
AddRuleProps, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
AddApplicationTargetsProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.157Z") @Stability(Stable) public interface AddApplicationTargetsProps extends software.amazon.jsii.JsiiSerializable, AddRuleProps
Properties for adding new targets to a listener.

Example: 

 import software.amazon.awscdk.services.autoscaling.AutoScalingGroup;
 AutoScalingGroup asg;
 Vpc vpc;
 // Create the load balancer in a VPC. 'internetFacing' is 'false'
 // by default, which creates an internal load balancer.
 ApplicationLoadBalancer lb = ApplicationLoadBalancer.Builder.create(this, "LB")
         .vpc(vpc)
         .internetFacing(true)
         .build();
 // Add a listener and open up the load balancer's security group
 // to the world.
 ApplicationListener listener = lb.addListener("Listener", BaseApplicationListenerProps.builder()
         .port(80)
         // 'open: true' is the default, you can leave it out if you want. Set it
         // to 'false' and use `listener.connections` if you want to be selective
         // about who can access the load balancer.
         .open(true)
         .build());
 // Create an AutoScaling group and add it as a load balancing
 // target to the listener.
 listener.addTargets("ApplicationFleet", AddApplicationTargetsProps.builder()
         .port(8080)
         .targets(List.of(asg))
         .build());

  • Method Details

    • 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:

    • getLoadBalancingAlgorithmType

      @Stability(Stable) @Nullable default TargetGroupLoadBalancingAlgorithmType getLoadBalancingAlgorithmType()
      The load balancing algorithm to select targets for routing requests.

      Default: round_robin.

    • getPort

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

      Default: Determined from protocol if known

    • getProtocol

      @Stability(Stable) @Nullable default ApplicationProtocol getProtocol()
      The protocol to use.

      Default: Determined from port if known

    • getProtocolVersion

      @Stability(Stable) @Nullable default ApplicationProtocolVersion getProtocolVersion()
      The protocol version to use.

      Default: ApplicationProtocolVersion.HTTP1

    • getSlowStart

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

      Default: 0

    • getStickinessCookieDuration

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

      Default: Stickiness disabled

    • getStickinessCookieName

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

      Default: - If `stickinessCookieDuration` is set, a load-balancer generated cookie is used. Otherwise, no stickiness is defined.

      See Also:

    • 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<IApplicationLoadBalancerTarget> getTargets()
      The targets to add to this target group.

      Can be Instance, IPAddress, or any self-registering load balancing target. All target must be of the same type.

    • builder

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