software.amazon.awscdk.services.elasticloadbalancingv2

Class TargetGroupBase

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.elasticloadbalancingv2.TargetGroupBase

All Implemented Interfaces:

IConstruct, IDependable, ITargetGroup

Direct Known Subclasses:

ApplicationTargetGroup, NetworkTargetGroup

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

Define the target of a load balancer.

Nested Class Summary

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

ITargetGroup.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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 java.lang.Number	getDefaultPort() Default port configured for members of this target group.
abstract java.lang.String	getFirstLoadBalancerFullName() Full name of first load balancer.
HealthCheck	getHealthCheck()
java.lang.String	getLoadBalancerArns() A token representing a list of ARNs of the load balancers that route traffic to this target group.
IDependable	getLoadBalancerAttached() List of constructs that need to be depended on to ensure the TargetGroup is associated to a load balancer.
protected ConcreteDependable	getLoadBalancerAttachedDependencies() Configurable dependable with all resources that lead to load balancer attachment.
java.lang.String	getTargetGroupArn() The ARN of the target group.
java.lang.String	getTargetGroupFullName() The full name of the target group.
java.util.List<java.lang.String>	getTargetGroupLoadBalancerArns() ARNs of load balancers load balancing to this TargetGroup.
java.lang.String	getTargetGroupName() The name of the target group.
protected TargetType	getTargetType() The types of the directly registered members of this target group.
void	setAttribute(java.lang.String key) Set a non-standard attribute on the target group.
void	setAttribute(java.lang.String key, java.lang.String value) Set a non-standard attribute on the target group.
void	setHealthCheck(HealthCheck value)
protected void	setTargetType(TargetType value) The types of the directly registered members of this target group.
protected java.util.List<java.lang.String>	validate() Validate the current construct.

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

getNode

Constructor Detail

TargetGroupBase

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

TargetGroupBase

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

TargetGroupBase

protected TargetGroupBase(software.constructs.Construct scope,
                          java.lang.String id,
                          BaseTargetGroupProps baseProps,
                          java.lang.Object additionalProps)

Parameters:

scope - This parameter is required.

id - This parameter is required.

baseProps - This parameter is required.

additionalProps - This parameter is required.

Method Detail

addLoadBalancerTarget

protected void addLoadBalancerTarget(LoadBalancerTargetProps props)

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

Parameters:

props - This parameter is required.

configureHealthCheck

public void configureHealthCheck(HealthCheck healthCheck)

Set/replace the target group's health check.

Parameters:

healthCheck - This parameter is required.

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.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

public void setAttribute(java.lang.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

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 Construct

Returns:

An array of validation error messages, or an empty array if the construct is valid.

getDefaultPort

protected java.lang.Number getDefaultPort()

Default port configured for members of this target group.

getFirstLoadBalancerFullName

public abstract java.lang.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

public java.lang.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

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

protected ConcreteDependable getLoadBalancerAttachedDependencies()

Configurable dependable with all resources that lead to load balancer attachment.

getTargetGroupArn

public java.lang.String getTargetGroupArn()

The ARN of the target group.

Specified by:

getTargetGroupArn in interface ITargetGroup

getTargetGroupFullName

public java.lang.String getTargetGroupFullName()

The full name of the target group.

getTargetGroupLoadBalancerArns

public java.util.List<java.lang.String> getTargetGroupLoadBalancerArns()

ARNs of load balancers load balancing to this TargetGroup.

getTargetGroupName

public java.lang.String getTargetGroupName()

The name of the target group.

Specified by:

getTargetGroupName in interface ITargetGroup

getHealthCheck

public HealthCheck getHealthCheck()

setHealthCheck

public void setHealthCheck(HealthCheck value)

getTargetType

protected TargetType getTargetType()

The types of the directly registered members of this target group.

setTargetType

protected void setTargetType(TargetType value)

The types of the directly registered members of this target group.