Skip to content
v2.275.0

WeightedTargetGroupProperty Struct ​

Describes the weight of a target group.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_vpclattice as vpclattice } from 'aws-cdk-lib';
const weightedTargetGroupProperty: vpclattice.CfnRule.WeightedTargetGroupProperty = {
  targetGroupIdentifier: 'targetGroupIdentifier',

  // the properties below are optional
  weight: 123,
};

Properties ​

targetGroupIdentifierstringtarget_group_identifierstrtargetGroupIdentifierStringTargetGroupIdentifierstringTargetGroupIdentifier*stringrequired#
The ID of the target group.
weightoptionalnumberweightoptionalint | floatweightoptionalNumberWeightoptionaldoubleWeightoptional*float64#
Only required if you specify multiple target groups for a forward action.
notes

The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.