Package software.amazon.awscdk.services.elasticloadbalancingv2

Class TargetGroupBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.elasticloadbalancingv2.TargetGroupBase

All Implemented Interfaces:

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

Direct Known Subclasses:

ApplicationTargetGroup, NetworkTargetGroup

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:25.831Z")
@Stability(Stable)
public abstract class TargetGroupBase
extends software.constructs.Construct
implements ITargetGroup

Define the target of a load balancer.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

ITargetGroup.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TargetGroupBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TargetGroupBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	TargetGroupBase(software.constructs.Construct scope, String id, BaseTargetGroupProps baseProps, Object additionalProps)

Method Summary

Modifier and Type	Method	Description
protected void	addLoadBalancerTarget(LoadBalancerTargetProps props)	Register the given load balancing target as part of this group.
void	configureHealthCheck(HealthCheck healthCheck)	Set/replace the target group's health check.
protected Number	getDefaultPort()	Default port configured for members of this target group.
abstract String	getFirstLoadBalancerFullName()	Full name of first load balancer.
HealthCheck	getHealthCheck()	Health check for the members of this target group.
String	getLoadBalancerArns()	A token representing a list of ARNs of the load balancers that route traffic to this target group.
software.constructs.IDependable	getLoadBalancerAttached()	List of constructs that need to be depended on to ensure the TargetGroup is associated to a load balancer.
protected software.constructs.DependencyGroup	getLoadBalancerAttachedDependencies()	Configurable dependable with all resources that lead to load balancer attachment.
String	getTargetGroupArn()	The ARN of the target group.
String	getTargetGroupFullName()	The full name of the target group.
List<String>	getTargetGroupLoadBalancerArns()	ARNs of load balancers load balancing to this TargetGroup.
String	getTargetGroupName()	The name of the target group.
protected TargetType	getTargetType()	The types of the directly registered members of this target group.
void	setAttribute(String key)	Set a non-standard attribute on the target group.
void	setAttribute(String key, String value)	Set a non-standard attribute on the target group.
void	setHealthCheck(HealthCheck value)	Health check for the members of this target group.
protected void	setTargetType(TargetType value)	The types of the directly registered members of this target group.
protected List<String>	validateHealthCheck()
protected List<String>	validateTargetGroup()

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

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

TargetGroupBase

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

TargetGroupBase

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

TargetGroupBase

@Stability(Stable)
protected TargetGroupBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 BaseTargetGroupProps baseProps,
 @NotNull
 Object additionalProps)

Parameters:

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.

Parameters:

props - This parameter is required.

configureHealthCheck

@Stability(Stable)
public void configureHealthCheck(@NotNull
 HealthCheck healthCheck)

Set/replace the target group's health check.

Parameters:

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.

Parameters:

key - This parameter is required.

value -

See Also:

• https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes

setAttribute

@Stability(Stable)
public void setAttribute(@NotNull
 String key)

Set a non-standard attribute on the target group.

Parameters:

key - This parameter is required.

See Also:

• https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes

validateHealthCheck

@Stability(Stable)
@NotNull
protected List<String> validateHealthCheck()

validateTargetGroup

@Stability(Stable)
@NotNull
protected List<String> validateTargetGroup()

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 software.constructs.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 software.constructs.DependencyGroup 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()

Health check for the members of this target group.

setHealthCheck

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

Health check for the members of this target group.

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.