Class NetworkTargetGroup
Define a Network Target Group.
stable
Synopsis
Constructors
| constructor(scope, id, props) | stable |
Properties
| firstLoadBalancerFullName | Full name of first load balancer. |
Methods
| addTarget(targets) | Add a load balancing target to this target group. |
| fromTargetGroupAttributes(scope, id, attrs) | Import an existing target group. |
| import(scope, id, props) | (deprecated) Import an existing listener. |
| metricHealthyHostCount(props) | The number of targets that are considered healthy. |
| metricUnHealthyHostCount(props) | The number of targets that are considered unhealthy. |
| registerListener(listener) | Register a listener that is load balancing to this target group. |
| validate() | Validate the current construct. |
Constructors
constructor(scope, id, props)
stable
Declaration
constructor(scope: Construct, id: string, props: NetworkTargetGroupProps);Parameters
- scope Construct
- id string
- props NetworkTargetGroupProps
Properties
firstLoadBalancerFullName
Full name of first load balancer.
stable
Declaration
readonly firstLoadBalancerFullName: string;Property Value
string
Methods
addTarget(targets)
Add a load balancing target to this target group.
stable
Declaration
addTarget(...targets: INetworkLoadBalancerTarget[]): void;Parameters
- targets INetworkLoadBalancerTarget[]
Returns
void
fromTargetGroupAttributes(scope, id, attrs)
Import an existing target group.
stable
Declaration
static fromTargetGroupAttributes(scope: Construct, id: string, attrs: TargetGroupAttributes): INetworkTargetGroup;Parameters
- scope Construct
- id string
- attrs TargetGroupAttributes
Returns
import(scope, id, props)
(deprecated) Import an existing listener.
Declaration
static import(scope: Construct, id: string, props: TargetGroupImportProps): INetworkTargetGroup;Parameters
- scope Construct
- id string
- props TargetGroupImportProps
Returns
metricHealthyHostCount(props)
The number of targets that are considered healthy.
Average over 5 minutes stable
Declaration
metricHealthyHostCount(props?: cloudwatch.MetricOptions): cloudwatch.Metric;Parameters
- props cloudwatch.MetricOptions
Returns
cloudwatch.Metric
metricUnHealthyHostCount(props)
The number of targets that are considered unhealthy.
Average over 5 minutes stable
Declaration
metricUnHealthyHostCount(props?: cloudwatch.MetricOptions): cloudwatch.Metric;Parameters
- props cloudwatch.MetricOptions
Returns
cloudwatch.Metric
registerListener(listener)
Register a listener that is load balancing to this target group.
Don't call this directly. It will be called by listeners.
stable
Declaration
registerListener(listener: INetworkListener): void;Parameters
- listener INetworkListener
Returns
void
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.
stable
Declaration
protected validate(): string[];Returns
string[]