All Implemented Interfaces:
IConstruct, IDependable, ITargetGroup,, software.constructs.IConstruct
Direct Known Subclasses:
ApplicationTargetGroup, NetworkTargetGroup

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.396Z") @Stability(Stable) public abstract class TargetGroupBase extends Construct implements ITargetGroup
Define the target of a load balancer.
  • Constructor Details

    • TargetGroupBase

      protected TargetGroupBase( objRef)
    • TargetGroupBase

      protected TargetGroupBase( initializationMode)
    • TargetGroupBase

      @Stability(Stable) protected TargetGroupBase(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull BaseTargetGroupProps baseProps, @NotNull Object additionalProps)
      scope - This parameter is required.
      id - This parameter is required.
      baseProps - This parameter is required.
      additionalProps - This parameter is required.
  • Method Details

    • addLoadBalancerTarget

      @Stability(Stable) protected void addLoadBalancerTarget(@NotNull LoadBalancerTargetProps props)
      Register the given load balancing target as part of this group.

      props - This parameter is required.
    • configureHealthCheck

      @Stability(Stable) public void configureHealthCheck(@NotNull HealthCheck healthCheck)
      Set/replace the target group's health check.

      healthCheck - This parameter is required.
    • setAttribute

      @Stability(Stable) public void setAttribute(@NotNull String key, @Nullable String value)
      Set a non-standard attribute on the target group.

      key - This parameter is required.
      value -
      See Also:
    • setAttribute

      @Stability(Stable) public void setAttribute(@NotNull String key)
      Set a non-standard attribute on the target group.

      key - This parameter is required.
      See Also:
    • validate

      @Stability(Stable) @NotNull protected List<String> validate()
      Validate the current construct.

      This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

      validate in class Construct
      An array of validation error messages, or an empty array if the construct is valid.
    • getDefaultPort

      @Stability(Stable) @NotNull protected Number getDefaultPort()
      Default port configured for members of this target group.
    • getFirstLoadBalancerFullName

      @Stability(Stable) @NotNull public abstract String getFirstLoadBalancerFullName()
      Full name of first load balancer.

      This identifier is emitted as a dimensions of the metrics of this target group.

      Example value: app/my-load-balancer/123456789

    • getLoadBalancerArns

      @Stability(Stable) @NotNull public String getLoadBalancerArns()
      A token representing a list of ARNs of the load balancers that route traffic to this target group.
      Specified by:
      getLoadBalancerArns in interface ITargetGroup
    • getLoadBalancerAttached

      @Stability(Stable) @NotNull public IDependable getLoadBalancerAttached()
      List of constructs that need to be depended on to ensure the TargetGroup is associated to a load balancer.
      Specified by:
      getLoadBalancerAttached in interface ITargetGroup
    • getLoadBalancerAttachedDependencies

      @Stability(Stable) @NotNull protected ConcreteDependable getLoadBalancerAttachedDependencies()
      Configurable dependable with all resources that lead to load balancer attachment.
    • getTargetGroupArn

      @Stability(Stable) @NotNull public String getTargetGroupArn()
      The ARN of the target group.
      Specified by:
      getTargetGroupArn in interface ITargetGroup
    • getTargetGroupFullName

      @Stability(Stable) @NotNull public String getTargetGroupFullName()
      The full name of the target group.
    • getTargetGroupLoadBalancerArns

      @Stability(Stable) @NotNull public List<String> getTargetGroupLoadBalancerArns()
      ARNs of load balancers load balancing to this TargetGroup.
    • getTargetGroupName

      @Stability(Stable) @NotNull public String getTargetGroupName()
      The name of the target group.
      Specified by:
      getTargetGroupName in interface ITargetGroup
    • getHealthCheck

      @Stability(Stable) @NotNull public HealthCheck getHealthCheck()
    • setHealthCheck

      @Stability(Stable) public void setHealthCheck(@NotNull HealthCheck value)
    • getTargetType

      @Stability(Stable) @Nullable protected TargetType getTargetType()
      The types of the directly registered members of this target group.
    • setTargetType

      @Stability(Stable) protected void setTargetType(@Nullable TargetType value)
      The types of the directly registered members of this target group.