Class GuApplicationTargetGroup

Construct which creates a Target Group.

This construct should be used in conjunction with [[GuApplicationLoadBalancer]] and [[GuApplicationListener]] to route traffic to your application. For more details on these three components, see the AWS documentation.

By default, Target Groups created via this construct will perform a healthcheck against /healthcheck on your application's traffic port (as specified via the port prop). All healthcheck defaults can be overridden via the healthcheck prop.

For example, to use /test for the healthcheck path use:

new GuApplicationTargetGroup(stack, "TargetGroup", {
    // other props
    healthCheck: {
      path: "/test",
    },
  });

This resource is stateful.

See

https://github.com/guardian/cdk/blob/main/docs/stateful-resources.md

Hierarchy

  • Mixin<typeof ApplicationTargetGroup, this> & ApplicationTargetGroup<this>
    • GuApplicationTargetGroup

Constructors

constructor

Properties

defaultPort healthCheck idWithApp loadBalancerArns loadBalancerAttachedDependencies node targetGroupArn targetGroupFullName targetGroupLoadBalancerArns targetGroupName targetType? DefaultHealthCheck defaultHealthcheckInterval defaultHealthcheckTimeout

Accessors

firstLoadBalancerFullName loadBalancerAttached metrics

Methods

addLoadBalancerTarget addTarget configureHealthCheck enableCookieStickiness metric metricHealthyHostCount metricHttpCodeTarget metricIpv6RequestCount metricRequestCount metricRequestCountPerTarget metricTargetConnectionErrorCount metricTargetResponseTime metricTargetTLSNegotiationErrorCount metricUnhealthyHostCount registerConnectable registerListener setAttribute toString validateHealthCheck validateTargetGroup fromTargetGroupAttributes isConstruct

Constructors

constructor

Properties

Protected Readonly defaultPort

defaultPort: number

Default port configured for members of this target group

healthCheck

healthCheck: HealthCheck

Health check for the members of this target group

Readonly idWithApp

idWithApp: string

The ID of the construct with the App suffix. This should be used in place of id when trying to reference the construct.

Readonly loadBalancerArns

loadBalancerArns: string

A token representing a list of ARNs of the load balancers that route traffic to this target group

Protected Readonly loadBalancerAttachedDependencies

loadBalancerAttachedDependencies: DependencyGroup

Configurable dependable with all resources that lead to load balancer attachment

Readonly node

node: Node

The tree node.

Readonly targetGroupArn

targetGroupArn: string

The ARN of the target group

Readonly targetGroupFullName

targetGroupFullName: string

The full name of the target group

Readonly targetGroupLoadBalancerArns

targetGroupLoadBalancerArns: string[]

ARNs of load balancers load balancing to this TargetGroup

Readonly targetGroupName

targetGroupName: string

The name of the target group

Protected Optional targetType

targetType?: TargetType

The types of the directly registered members of this target group

Static DefaultHealthCheck

DefaultHealthCheck: HealthCheck = ...

Static Private defaultHealthcheckInterval

defaultHealthcheckInterval: Duration = ...

Static Private defaultHealthcheckTimeout

defaultHealthcheckTimeout: Duration = ...

Accessors

firstLoadBalancerFullName

  • get firstLoadBalancerFullName(): string

  • Full name of first load balancer

    Returns string

loadBalancerAttached

  • get loadBalancerAttached(): IDependable

  • List of constructs that need to be depended on to ensure the TargetGroup is associated to a load balancer

    Returns IDependable

metrics

  • get metrics(): IApplicationTargetGroupMetrics

  • Returns IApplicationTargetGroupMetrics

Methods

Protected addLoadBalancerTarget

  • addLoadBalancerTarget(props): void

  • Register the given load balancing target as part of this group

    Parameters

    • props: LoadBalancerTargetProps

    Returns void

addTarget

  • addTarget(...targets): void

  • Add a load balancing target to this target group

    Parameters

    • Rest ...targets: IApplicationLoadBalancerTarget[]

    Returns void

configureHealthCheck

  • configureHealthCheck(healthCheck): void

  • Set/replace the target group's health check

    Parameters

    • healthCheck: HealthCheck

    Returns void

enableCookieStickiness

  • enableCookieStickiness(duration, cookieName?): void

  • Enable sticky routing via a cookie to members of this target group.

    Note: If the cookieName parameter is set, application-based stickiness will be applied, otherwise it defaults to duration-based stickiness attributes (lb_cookie).

    Parameters

    • duration: Duration
    • Optional cookieName: string

    Returns void

    See

    https://docs.aws.amazon.com/elasticloadbalancing/latest/application/sticky-sessions.html

metric

  • metric(metricName, props?): Metric

  • Return the given named metric for this Application Load Balancer Target Group

    Returns the metric for this target group from the point of view of the first load balancer load balancing to it. If you have multiple load balancers load sending traffic to the same target group, you will have to override the dimensions on this metric.

    Parameters

    • metricName: string
    • Optional props: MetricOptions

    Returns Metric

    Default

    Average over 5 minutes

metricHealthyHostCount

  • metricHealthyHostCount(props?): Metric

  • The number of healthy hosts in the target group

    Parameters

    • Optional props: MetricOptions

    Returns Metric

    Default

    Average over 5 minutes

    Deprecated

    Use ApplicationTargetGroup.metrics.healthyHostCount instead

metricHttpCodeTarget

  • metricHttpCodeTarget(code, props?): Metric

  • The number of HTTP 2xx/3xx/4xx/5xx response codes generated by all targets in this target group.

    This does not include any response codes generated by the load balancer.

    Parameters

    • code: HttpCodeTarget
    • Optional props: MetricOptions

    Returns Metric

    Default

    Sum over 5 minutes

    Deprecated

    Use ApplicationTargetGroup.metrics.httpCodeTarget instead

metricIpv6RequestCount

  • metricIpv6RequestCount(props?): Metric

  • The number of IPv6 requests received by the target group

    Parameters

    • Optional props: MetricOptions

    Returns Metric

    Default

    Sum over 5 minutes

    Deprecated

    Use ApplicationTargetGroup.metrics.ipv6RequestCount instead

metricRequestCount

  • metricRequestCount(props?): Metric

  • The number of requests processed over IPv4 and IPv6.

    This count includes only the requests with a response generated by a target of the load balancer.

    Parameters

    • Optional props: MetricOptions

    Returns Metric

    Default

    Sum over 5 minutes

    Deprecated

    Use ApplicationTargetGroup.metrics.requestCount instead

metricRequestCountPerTarget

  • metricRequestCountPerTarget(props?): Metric

  • The average number of requests received by each target in a target group.

    The only valid statistic is Sum. Note that this represents the average not the sum.

    Parameters

    • Optional props: MetricOptions

    Returns Metric

    Default

    Sum over 5 minutes

    Deprecated

    Use ApplicationTargetGroup.metrics.requestCountPerTarget instead

metricTargetConnectionErrorCount

  • metricTargetConnectionErrorCount(props?): Metric

  • The number of connections that were not successfully established between the load balancer and target.

    Parameters

    • Optional props: MetricOptions

    Returns Metric

    Default

    Sum over 5 minutes

    Deprecated

    Use ApplicationTargetGroup.metrics.targetConnectionErrorCount instead

metricTargetResponseTime

  • metricTargetResponseTime(props?): Metric

  • The time elapsed, in seconds, after the request leaves the load balancer until a response from the target is received.

    Parameters

    • Optional props: MetricOptions

    Returns Metric

    Default

    Average over 5 minutes

    Deprecated

    Use ApplicationTargetGroup.metrics.targetResponseTime instead

metricTargetTLSNegotiationErrorCount

  • metricTargetTLSNegotiationErrorCount(props?): Metric

  • The number of TLS connections initiated by the load balancer that did not establish a session with the target.

    Possible causes include a mismatch of ciphers or protocols.

    Parameters

    • Optional props: MetricOptions

    Returns Metric

    Default

    Sum over 5 minutes

    Deprecated

    Use ApplicationTargetGroup.metrics.tlsNegotiationErrorCount instead

metricUnhealthyHostCount

  • metricUnhealthyHostCount(props?): Metric

  • The number of unhealthy hosts in the target group

    Parameters

    • Optional props: MetricOptions

    Returns Metric

    Default

    Average over 5 minutes

    Deprecated

    Use ApplicationTargetGroup.metrics.unhealthyHostCount instead

registerConnectable

  • registerConnectable(connectable, portRange?): void

  • Register a connectable as a member of this target group.

    Don't call this directly. It will be called by load balancing targets.

    Parameters

    • connectable: IConnectable
    • Optional portRange: Port

    Returns void

registerListener

  • registerListener(listener, associatingConstruct?): void

  • Register a listener that is load balancing to this target group.

    Don't call this directly. It will be called by listeners.

    Parameters

    • listener: IApplicationListener
    • Optional associatingConstruct: IConstruct

    Returns void

setAttribute

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

Protected validateHealthCheck

  • validateHealthCheck(): string[]

  • Returns string[]

Protected validateTargetGroup

  • validateTargetGroup(): string[]

  • Returns string[]

Static fromTargetGroupAttributes

  • fromTargetGroupAttributes(scope, id, attrs): IApplicationTargetGroup

  • Import an existing target group

    Parameters

    • scope: Construct
    • id: string
    • attrs: TargetGroupAttributes

    Returns IApplicationTargetGroup

Static isConstruct

  • isConstruct(x): x is Construct

  • Checks if x is a construct.

    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

    Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

    Parameters

    • x: any

      Any object

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

Settings

Member Visibility

Theme

On This Page

constructordefaultPorthealthCheckidWithApploadBalancerArnsloadBalancerAttachedDependenciesnodetargetGroupArntargetGroupFullNametargetGroupLoadBalancerArnstargetGroupNametargetTypeDefaultHealthCheckdefaultHealthcheckIntervaldefaultHealthcheckTimeoutfirstLoadBalancerFullNameloadBalancerAttachedmetricsaddLoadBalancerTargetaddTargetconfigureHealthCheckenableCookieStickinessmetricmetricHealthyHostCountmetricHttpCodeTargetmetricIpv6RequestCountmetricRequestCountmetricRequestCountPerTargetmetricTargetConnectionErrorCountmetricTargetResponseTimemetricTargetTLSNegotiationErrorCountmetricUnhealthyHostCountregisterConnectableregisterListenersetAttributetoStringvalidateHealthCheckvalidateTargetGroupfromTargetGroupAttributesisConstruct