software.amazon.awscdk.services.elasticloadbalancingv2

Class ApplicationTargetGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.elasticloadbalancingv2.TargetGroupBase

software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationTargetGroup

All Implemented Interfaces:

IApplicationTargetGroup, ITargetGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:18.642Z")
 @Stability(value=Experimental)
public class ApplicationTargetGroup
extends TargetGroupBase
implements IApplicationTargetGroup

(experimental) Define an Application Target Group.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApplicationTargetGroup.Builder (experimental) A fluent builder for ApplicationTargetGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IApplicationTargetGroup.Jsii$Default, IApplicationTargetGroup.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

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.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getLoadBalancerArns, getLoadBalancerAttached, getTargetGroupArn

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ApplicationTargetGroup

protected ApplicationTargetGroup(software.amazon.jsii.JsiiObjectRef objRef)

ApplicationTargetGroup

protected ApplicationTargetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ApplicationTargetGroup

@Stability(value=Experimental)
public ApplicationTargetGroup(@NotNull
                                                             software.constructs.Construct scope,
                                                             @NotNull
                                                             String id,
                                                             @Nullable
                                                             ApplicationTargetGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

ApplicationTargetGroup

@Stability(value=Experimental)
public ApplicationTargetGroup(@NotNull
                                                             software.constructs.Construct scope,
                                                             @NotNull
                                                             String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromTargetGroupAttributes

@Stability(value=Experimental)
 @NotNull
public static IApplicationTargetGroup fromTargetGroupAttributes(@NotNull
                                                                                                         software.constructs.Construct scope,
                                                                                                         @NotNull
                                                                                                         String id,
                                                                                                         @NotNull
                                                                                                         TargetGroupAttributes attrs)

(experimental) Import an existing target group.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addTarget

@Stability(value=Experimental)
public void addTarget(@NotNull
                                                     IApplicationLoadBalancerTarget... targets)

(experimental) Add a load balancing target to this target group.

Specified by:

addTarget in interface IApplicationTargetGroup

Parameters:

targets - This parameter is required.

enableCookieStickiness

@Stability(value=Experimental)
public void enableCookieStickiness(@NotNull
                                                                  Duration duration,
                                                                  @Nullable
                                                                  String cookieName)

(experimental) 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

@Stability(value=Experimental)
public void enableCookieStickiness(@NotNull
                                                                  Duration duration)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName,
                                                              @Nullable
                                                              MetricOptions props)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public Metric metricHealthyHostCount(@Nullable
                                                                              MetricOptions props)

(experimental) The number of healthy hosts in the target group.

Default: Average over 5 minutes

Parameters:

props -

metricHealthyHostCount

@Stability(value=Experimental)
 @NotNull
public Metric metricHealthyHostCount()

(experimental) The number of healthy hosts in the target group.

Default: Average over 5 minutes

metricHttpCodeTarget

@Stability(value=Experimental)
 @NotNull
public Metric metricHttpCodeTarget(@NotNull
                                                                            HttpCodeTarget code,
                                                                            @Nullable
                                                                            MetricOptions props)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public Metric metricHttpCodeTarget(@NotNull
                                                                            HttpCodeTarget code)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public Metric metricIpv6RequestCount(@Nullable
                                                                              MetricOptions props)

(experimental) The number of IPv6 requests received by the target group.

Default: Sum over 5 minutes

Parameters:

props -

metricIpv6RequestCount

@Stability(value=Experimental)
 @NotNull
public Metric metricIpv6RequestCount()

(experimental) The number of IPv6 requests received by the target group.

Default: Sum over 5 minutes

metricRequestCount

@Stability(value=Experimental)
 @NotNull
public Metric metricRequestCount(@Nullable
                                                                          MetricOptions props)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public Metric metricRequestCount()

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public Metric metricRequestCountPerTarget(@Nullable
                                                                                   MetricOptions props)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public Metric metricRequestCountPerTarget()

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public Metric metricTargetConnectionErrorCount(@Nullable
                                                                                        MetricOptions props)

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

Default: Sum over 5 minutes

Parameters:

props -

metricTargetConnectionErrorCount

@Stability(value=Experimental)
 @NotNull
public Metric metricTargetConnectionErrorCount()

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

Default: Sum over 5 minutes

metricTargetResponseTime

@Stability(value=Experimental)
 @NotNull
public Metric metricTargetResponseTime(@Nullable
                                                                                MetricOptions props)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public Metric metricTargetResponseTime()

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public Metric metricTargetTLSNegotiationErrorCount(@Nullable
                                                                                            MetricOptions props)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public Metric metricTargetTLSNegotiationErrorCount()

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public Metric metricUnhealthyHostCount(@Nullable
                                                                                MetricOptions props)

(experimental) The number of unhealthy hosts in the target group.

Default: Average over 5 minutes

Parameters:

props -

metricUnhealthyHostCount

@Stability(value=Experimental)
 @NotNull
public Metric metricUnhealthyHostCount()

(experimental) The number of unhealthy hosts in the target group.

Default: Average over 5 minutes

registerConnectable

@Stability(value=Experimental)
public void registerConnectable(@NotNull
                                                               IConnectable connectable,
                                                               @Nullable
                                                               Port portRange)

(experimental) 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

@Stability(value=Experimental)
public void registerConnectable(@NotNull
                                                               IConnectable connectable)

(experimental) 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

@Stability(value=Experimental)
public void registerListener(@NotNull
                                                            IApplicationListener listener,
                                                            @Nullable
                                                            software.constructs.IConstruct associatingConstruct)

(experimental) 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

@Stability(value=Experimental)
public void registerListener(@NotNull
                                                            IApplicationListener listener)

(experimental) 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.

validateTargetGroup

@Stability(value=Experimental)
 @NotNull
protected List<String> validateTargetGroup()

Overrides:

validateTargetGroup in class TargetGroupBase

getFirstLoadBalancerFullName

@Stability(value=Experimental)
 @NotNull
public String getFirstLoadBalancerFullName()

(experimental) Full name of first load balancer.

Specified by:

getFirstLoadBalancerFullName in class TargetGroupBase