Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface ApplicationTargetGroupProps

All Superinterfaces:
BaseTargetGroupProps, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ApplicationTargetGroupProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-15T10:24:59.345Z") @Stability(Stable) public interface ApplicationTargetGroupProps extends software.amazon.jsii.JsiiSerializable, BaseTargetGroupProps
Properties for defining an Application Target Group.

Example: 

 Vpc vpc;
 // Target group with slow start mode enabled
 ApplicationTargetGroup tg = ApplicationTargetGroup.Builder.create(this, "TG")
         .targetType(TargetType.INSTANCE)
         .slowStart(Duration.seconds(60))
         .port(80)
         .vpc(vpc)
         .build();

  • Method Details

    • getEnableAnomalyMitigation

      @Stability(Stable) @Nullable default Boolean getEnableAnomalyMitigation()
      Indicates whether anomaly mitigation is enabled.

      Only available when loadBalancingAlgorithmType is TargetGroupLoadBalancingAlgorithmType.WEIGHTED_RANDOM

      Default: false

      See Also:

    • getLoadBalancingAlgorithmType

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

      Default: TargetGroupLoadBalancingAlgorithmType.ROUND_ROBIN

    • getPort

      @Stability(Stable) @Nullable default Number getPort()
      The port on which the target receives traffic.

      This is not applicable for Lambda targets.

      Default: - Determined from protocol if known

    • getProtocol

      @Stability(Stable) @Nullable default ApplicationProtocol getProtocol()
      The protocol used for communication with the target.

      This is not applicable for Lambda targets.

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

    • 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. If you use either Instance or IPAddress as targets, all target must be of the same type.

      Default: - No targets.

    • builder

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