Package software.amazon.awscdk.services.vpclattice

Interface CfnRule.WeightedTargetGroupProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRule.WeightedTargetGroupProperty.Jsii$Proxy

Enclosing class:

CfnRule

@Stability(Stable)
public static interface CfnRule.WeightedTargetGroupProperty
extends software.amazon.jsii.JsiiSerializable

Describes the weight of a target group.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.vpclattice.*;
 WeightedTargetGroupProperty weightedTargetGroupProperty = WeightedTargetGroupProperty.builder()
         .targetGroupIdentifier("targetGroupIdentifier")
         // the properties below are optional
         .weight(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-weightedtargetgroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRule.WeightedTargetGroupProperty.Builder	A builder for CfnRule.WeightedTargetGroupProperty
static final class	CfnRule.WeightedTargetGroupProperty.Jsii$Proxy	An implementation for CfnRule.WeightedTargetGroupProperty

Method Summary

Modifier and Type	Method	Description
static CfnRule.WeightedTargetGroupProperty.Builder	builder()
String	getTargetGroupIdentifier()	The ID of the target group.
default Number	getWeight()	Only required if you specify multiple target groups for a forward action.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTargetGroupIdentifier

@Stability(Stable)
@NotNull
String getTargetGroupIdentifier()

The ID of the target group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-weightedtargetgroup.html#cfn-vpclattice-rule-weightedtargetgroup-targetgroupidentifier

getWeight

@Stability(Stable)
@Nullable
default Number getWeight()

Only required if you specify multiple target groups for a forward action.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-weightedtargetgroup.html#cfn-vpclattice-rule-weightedtargetgroup-weight

builder

@Stability(Stable)
static CfnRule.WeightedTargetGroupProperty.Builder builder()

Returns:

a CfnRule.WeightedTargetGroupProperty.Builder of CfnRule.WeightedTargetGroupProperty