ApplicationTargetGroup

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.services.elasticloadbalancingv2.TargetGroupBase
    - - software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationTargetGroup

All Implemented Interfaces:: IConstruct, IDependable, IApplicationTargetGroup, ITargetGroup

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.995Z")
public class ApplicationTargetGroup
extends TargetGroupBase
implements IApplicationTargetGroup

Define an Application Target Group.

Example:

 Vpc vpc;
 // Target group with duration-based stickiness with load-balancer generated cookie
 ApplicationTargetGroup tg1 = ApplicationTargetGroup.Builder.create(this, "TG1")
         .targetType(TargetType.INSTANCE)
         .port(80)
         .stickinessCookieDuration(Duration.minutes(5))
         .vpc(vpc)
         .build();
 // Target group with application-based stickiness
 ApplicationTargetGroup tg2 = ApplicationTargetGroup.Builder.create(this, "TG2")
         .targetType(TargetType.INSTANCE)
         .port(80)
         .stickinessCookieDuration(Duration.minutes(5))
         .stickinessCookieName("MyDeliciousCookie")
         .vpc(vpc)
         .build();

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ApplicationTargetGroup.Builder
A fluent builder for ApplicationTargetGroup.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationTargetGroup
  IApplicationTargetGroup.Jsii$Default, IApplicationTargetGroup.Jsii$Proxy

Nested Classes
Modifier and Type	Class and Description
`static class`	`ApplicationTargetGroup.Builder` A fluent builder for `ApplicationTargetGroup`.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ApplicationTargetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`ApplicationTargetGroup(software.amazon.jsii.JsiiObjectRef objRef)`
	`ApplicationTargetGroup(software.constructs.Construct scope, java.lang.String id)`
	`ApplicationTargetGroup(software.constructs.Construct scope, java.lang.String id, ApplicationTargetGroupProps props)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addTarget(IApplicationLoadBalancerTarget... targets)` Add a load balancing target to this target group.
`static IApplicationTargetGroup`	`doImport(software.constructs.Construct scope, java.lang.String id, TargetGroupImportProps props)` Deprecated. Use `fromTargetGroupAttributes` instead
`void`	`enableCookieStickiness(Duration duration)` Enable sticky routing via a cookie to members of this target group.
`void`	`enableCookieStickiness(Duration duration, java.lang.String cookieName)` Enable sticky routing via a cookie to members of this target group.
`static IApplicationTargetGroup`	`fromTargetGroupAttributes(software.constructs.Construct scope, java.lang.String id, TargetGroupAttributes attrs)` Import an existing target group.
`java.lang.String`	`getFirstLoadBalancerFullName()` Full name of first load balancer.
`Metric`	`metric(java.lang.String metricName)` Return the given named metric for this Application Load Balancer Target Group.
`Metric`	`metric(java.lang.String metricName, MetricOptions props)` Return the given named metric for this Application Load Balancer Target Group.
`Metric`	`metricHealthyHostCount()` The number of healthy hosts in the target group.
`Metric`	`metricHealthyHostCount(MetricOptions props)` The number of healthy hosts in the target group.
`Metric`	`metricHttpCodeTarget(HttpCodeTarget code)` The number of HTTP 2xx/3xx/4xx/5xx response codes generated by all targets in this target group.
`Metric`	`metricHttpCodeTarget(HttpCodeTarget code, MetricOptions props)` The number of HTTP 2xx/3xx/4xx/5xx response codes generated by all targets in this target group.
`Metric`	`metricIpv6RequestCount()` The number of IPv6 requests received by the target group.
`Metric`	`metricIpv6RequestCount(MetricOptions props)` The number of IPv6 requests received by the target group.
`Metric`	`metricRequestCount()` The number of requests processed over IPv4 and IPv6.
`Metric`	`metricRequestCount(MetricOptions props)` The number of requests processed over IPv4 and IPv6.
`Metric`	`metricRequestCountPerTarget()` The average number of requests received by each target in a target group.
`Metric`	`metricRequestCountPerTarget(MetricOptions props)` The average number of requests received by each target in a target group.
`Metric`	`metricTargetConnectionErrorCount()` The number of connections that were not successfully established between the load balancer and target.
`Metric`	`metricTargetConnectionErrorCount(MetricOptions props)` The number of connections that were not successfully established between the load balancer and target.
`Metric`	`metricTargetResponseTime()` The time elapsed, in seconds, after the request leaves the load balancer until a response from the target is received.
`Metric`	`metricTargetResponseTime(MetricOptions props)` The time elapsed, in seconds, after the request leaves the load balancer until a response from the target is received.
`Metric`	`metricTargetTLSNegotiationErrorCount()` The number of TLS connections initiated by the load balancer that did not establish a session with the target.
`Metric`	`metricTargetTLSNegotiationErrorCount(MetricOptions props)` The number of TLS connections initiated by the load balancer that did not establish a session with the target.
`Metric`	`metricUnhealthyHostCount()` The number of unhealthy hosts in the target group.
`Metric`	`metricUnhealthyHostCount(MetricOptions props)` The number of unhealthy hosts in the target group.
`void`	`registerConnectable(IConnectable connectable)` Register a connectable as a member of this target group.
`void`	`registerConnectable(IConnectable connectable, Port portRange)` Register a connectable as a member of this target group.
`void`	`registerListener(IApplicationListener listener)` Register a listener that is load balancing to this target group.
`void`	`registerListener(IApplicationListener listener, software.constructs.IConstruct associatingConstruct)` Register a listener that is load balancing to this target group.
`protected java.util.List<java.lang.String>`	`validate()` Validate the current construct.

Methods inherited from class software.amazon.awscdk.services.elasticloadbalancingv2.TargetGroupBase
addLoadBalancerTarget, configureHealthCheck, getDefaultPort, getHealthCheck, getLoadBalancerArns, getLoadBalancerAttached, getLoadBalancerAttachedDependencies, getTargetGroupArn, getTargetGroupFullName, getTargetGroupLoadBalancerArns, getTargetGroupName, getTargetType, setAttribute, setAttribute, setHealthCheck, setTargetType

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.ITargetGroup
getLoadBalancerArns, getLoadBalancerAttached, getTargetGroupArn, getTargetGroupName

Methods inherited from interface software.amazon.awscdk.core.IConstruct
getNode

- Constructor Detail
  - ApplicationTargetGroup
```
protected ApplicationTargetGroup(software.amazon.jsii.JsiiObjectRef objRef)
```
  - ApplicationTargetGroup
```
protected ApplicationTargetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - ApplicationTargetGroup
```
public ApplicationTargetGroup(software.constructs.Construct scope,
                              java.lang.String id,
                              ApplicationTargetGroupProps props)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    props -
  - ApplicationTargetGroup
```
public ApplicationTargetGroup(software.constructs.Construct scope,
                              java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
- Method Detail
  - fromTargetGroupAttributes
```
public static IApplicationTargetGroup fromTargetGroupAttributes(software.constructs.Construct scope,
                                                                java.lang.String id,
                                                                TargetGroupAttributes attrs)
```
    Import an existing target group.
    
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    attrs - This parameter is required.
  - doImport
```
@Deprecated
public static IApplicationTargetGroup doImport(software.constructs.Construct scope,
                                                           java.lang.String id,
                                                           TargetGroupImportProps props)
```
    Deprecated. Use `fromTargetGroupAttributes` instead
    
    (deprecated) Import an existing target group.
    
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    props - This parameter is required.
  - addTarget
```
public void addTarget(IApplicationLoadBalancerTarget... targets)
```
    Add a load balancing target to this target group.
    
    Specified by:
    
    addTarget in interface IApplicationTargetGroup
    
    Parameters:
    
    targets - This parameter is required.
  - enableCookieStickiness
```
public void enableCookieStickiness(Duration duration,
                                   java.lang.String cookieName)
```
    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 - This parameter is required.
    
    cookieName -
    
    See Also:
    
    https://docs.aws.amazon.com/elasticloadbalancing/latest/application/sticky-sessions.html
  - enableCookieStickiness
```
public void enableCookieStickiness(Duration duration)
```
    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 - This parameter is required.
    
    See Also:
    
    https://docs.aws.amazon.com/elasticloadbalancing/latest/application/sticky-sessions.html
  - metric
```
public Metric metric(java.lang.String metricName,
                     MetricOptions props)
```
    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.
    Default: Average over 5 minutes
    
    Parameters:
    
    metricName - This parameter is required.
    
    props -
  - metric
```
public Metric metric(java.lang.String metricName)
```
    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.
    Default: Average over 5 minutes
    
    Parameters:
    
    metricName - This parameter is required.
  - metricHealthyHostCount
```
public Metric metricHealthyHostCount(MetricOptions props)
```
    The number of healthy hosts in the target group.
    Default: Average over 5 minutes
    
    Parameters:
    
    props -
  - metricHealthyHostCount
```
public Metric metricHealthyHostCount()
```
    The number of healthy hosts in the target group.
    Default: Average over 5 minutes
  - metricHttpCodeTarget
```
public Metric metricHttpCodeTarget(HttpCodeTarget code,
                                   MetricOptions props)
```
    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.
    Default: Sum over 5 minutes
    
    Parameters:
    
    code - This parameter is required.
    
    props -
  - metricHttpCodeTarget
```
public Metric metricHttpCodeTarget(HttpCodeTarget code)
```
    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.
    Default: Sum over 5 minutes
    
    Parameters:
    
    code - This parameter is required.
  - metricIpv6RequestCount
```
public Metric metricIpv6RequestCount(MetricOptions props)
```
    The number of IPv6 requests received by the target group.
    Default: Sum over 5 minutes
    
    Parameters:
    
    props -
  - metricIpv6RequestCount
```
public Metric metricIpv6RequestCount()
```
    The number of IPv6 requests received by the target group.
    Default: Sum over 5 minutes
  - metricRequestCount
```
public Metric metricRequestCount(MetricOptions props)
```
    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.
    Default: Sum over 5 minutes
    
    Parameters:
    
    props -
  - metricRequestCount
```
public Metric metricRequestCount()
```
    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.
    Default: Sum over 5 minutes
  - metricRequestCountPerTarget
```
public Metric metricRequestCountPerTarget(MetricOptions props)
```
    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.
    Default: Sum over 5 minutes
    
    Parameters:
    
    props -
  - metricRequestCountPerTarget
```
public Metric metricRequestCountPerTarget()
```
    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.
    Default: Sum over 5 minutes
  - metricTargetConnectionErrorCount
```
public Metric metricTargetConnectionErrorCount(MetricOptions props)
```
    The number of connections that were not successfully established between the load balancer and target.
    Default: Sum over 5 minutes
    
    Parameters:
    
    props -
  - metricTargetConnectionErrorCount
```
public Metric metricTargetConnectionErrorCount()
```
    The number of connections that were not successfully established between the load balancer and target.
    Default: Sum over 5 minutes
  - metricTargetResponseTime
```
public Metric metricTargetResponseTime(MetricOptions props)
```
    The time elapsed, in seconds, after the request leaves the load balancer until a response from the target is received.
    Default: Average over 5 minutes
    
    Parameters:
    
    props -
  - metricTargetResponseTime
```
public Metric metricTargetResponseTime()
```
    The time elapsed, in seconds, after the request leaves the load balancer until a response from the target is received.
    Default: Average over 5 minutes
  - metricTargetTLSNegotiationErrorCount
```
public Metric metricTargetTLSNegotiationErrorCount(MetricOptions props)
```
    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.
    Default: Sum over 5 minutes
    
    Parameters:
    
    props -
  - metricTargetTLSNegotiationErrorCount
```
public Metric metricTargetTLSNegotiationErrorCount()
```
    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.
    Default: Sum over 5 minutes
  - metricUnhealthyHostCount
```
public Metric metricUnhealthyHostCount(MetricOptions props)
```
    The number of unhealthy hosts in the target group.
    Default: Average over 5 minutes
    
    Parameters:
    
    props -
  - metricUnhealthyHostCount
```
public Metric metricUnhealthyHostCount()
```
    The number of unhealthy hosts in the target group.
    Default: Average over 5 minutes
  - registerConnectable
```
public void registerConnectable(IConnectable connectable,
                                Port portRange)
```
    Register a connectable as a member of this target group.
    Don't call this directly. It will be called by load balancing targets.
    
    Specified by:
    
    registerConnectable in interface IApplicationTargetGroup
    
    Parameters:
    
    connectable - This parameter is required.
    
    portRange -
  - registerConnectable
```
public void registerConnectable(IConnectable connectable)
```
    Register a connectable as a member of this target group.
    Don't call this directly. It will be called by load balancing targets.
    
    Specified by:
    
    registerConnectable in interface IApplicationTargetGroup
    
    Parameters:
    
    connectable - This parameter is required.
  - registerListener
```
public void registerListener(IApplicationListener listener,
                             software.constructs.IConstruct associatingConstruct)
```
    Register a listener that is load balancing to this target group.
    Don't call this directly. It will be called by listeners.
    
    Specified by:
    
    registerListener in interface IApplicationTargetGroup
    
    Parameters:
    
    listener - This parameter is required.
    
    associatingConstruct -
  - registerListener
```
public void registerListener(IApplicationListener listener)
```
    Register a listener that is load balancing to this target group.
    Don't call this directly. It will be called by listeners.
    
    Specified by:
    
    registerListener in interface IApplicationTargetGroup
    
    Parameters:
    
    listener - This parameter is required.
  - validate
```
protected java.util.List<java.lang.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.
    
    Overrides:
    
    validate in class TargetGroupBase
    
    Returns:
    
    An array of validation error messages, or an empty array if the construct is valid.
  - getFirstLoadBalancerFullName
```
public java.lang.String getFirstLoadBalancerFullName()
```
    Full name of first load balancer.
    
    Specified by:
    
    getFirstLoadBalancerFullName in class TargetGroupBase

Class ApplicationTargetGroup

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationTargetGroup

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.services.elasticloadbalancingv2.TargetGroupBase

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.ITargetGroup

Methods inherited from interface software.amazon.awscdk.core.IConstruct

Constructor Detail

ApplicationTargetGroup

ApplicationTargetGroup

ApplicationTargetGroup

ApplicationTargetGroup

Method Detail

fromTargetGroupAttributes

doImport

addTarget

enableCookieStickiness

enableCookieStickiness

metric

metric

metricHealthyHostCount

metricHealthyHostCount

metricHttpCodeTarget

metricHttpCodeTarget

metricIpv6RequestCount

metricIpv6RequestCount

metricRequestCount

metricRequestCount

metricRequestCountPerTarget

metricRequestCountPerTarget

metricTargetConnectionErrorCount

metricTargetConnectionErrorCount

metricTargetResponseTime

metricTargetResponseTime

metricTargetTLSNegotiationErrorCount

metricTargetTLSNegotiationErrorCount

metricUnhealthyHostCount

metricUnhealthyHostCount

registerConnectable

registerConnectable

registerListener

registerListener

validate

getFirstLoadBalancerFullName