Package software.amazon.awscdk.cfnpropertymixins.services.vpclattice

Class CfnRulePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.vpclattice.CfnRulePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-19T12:55:27.251Z")
@Stability(Stable)
public class CfnRulePropsMixin
extends Mixin
implements software.constructs.IMixin

Creates a listener rule.

Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. For more information, see Listener rules in the Amazon VPC Lattice User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.vpclattice.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnRulePropsMixin cfnRulePropsMixin = CfnRulePropsMixin.Builder.create(CfnRuleMixinProps.builder()
         .action(ActionProperty.builder()
                 .fixedResponse(FixedResponseProperty.builder()
                         .statusCode(123)
                         .build())
                 .forward(ForwardProperty.builder()
                         .targetGroups(List.of(WeightedTargetGroupProperty.builder()
                                 .targetGroupIdentifier("targetGroupIdentifier")
                                 .weight(123)
                                 .build()))
                         .build())
                 .build())
         .listenerIdentifier("listenerIdentifier")
         .match(MatchProperty.builder()
                 .httpMatch(HttpMatchProperty.builder()
                         .headerMatches(List.of(HeaderMatchProperty.builder()
                                 .caseSensitive(false)
                                 .match(HeaderMatchTypeProperty.builder()
                                         .contains("contains")
                                         .exact("exact")
                                         .prefix("prefix")
                                         .build())
                                 .name("name")
                                 .build()))
                         .method("method")
                         .pathMatch(PathMatchProperty.builder()
                                 .caseSensitive(false)
                                 .match(PathMatchTypeProperty.builder()
                                         .exact("exact")
                                         .prefix("prefix")
                                         .build())
                                 .build())
                         .build())
                 .build())
         .name("name")
         .priority(123)
         .serviceIdentifier("serviceIdentifier")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnRulePropsMixin.ActionProperty	Describes the action for a rule.
static final class	CfnRulePropsMixin.Builder	A fluent builder for CfnRulePropsMixin.
static interface	CfnRulePropsMixin.FixedResponseProperty	Describes an action that returns a custom HTTP response.
static interface	CfnRulePropsMixin.ForwardProperty	The forward action.
static interface	CfnRulePropsMixin.HeaderMatchProperty	Describes the constraints for a header match.
static interface	CfnRulePropsMixin.HeaderMatchTypeProperty	Describes a header match type.
static interface	CfnRulePropsMixin.HttpMatchProperty	Describes criteria that can be applied to incoming requests.
static interface	CfnRulePropsMixin.MatchProperty	Describes a rule match.
static interface	CfnRulePropsMixin.PathMatchProperty	Describes the conditions that can be applied when matching a path for incoming requests.
static interface	CfnRulePropsMixin.PathMatchTypeProperty	Describes a path match type.
static interface	CfnRulePropsMixin.WeightedTargetGroupProperty	Describes the weight of a target group.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnRulePropsMixin(CfnRuleMixinProps props)	Create a mixin to apply properties to AWS::VpcLattice::Rule.
	CfnRulePropsMixin(CfnRuleMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::VpcLattice::Rule.
protected	CfnRulePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRulePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnRuleMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnRulePropsMixin

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

CfnRulePropsMixin

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

CfnRulePropsMixin

@Stability(Stable)
public CfnRulePropsMixin(@NotNull
 CfnRuleMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::VpcLattice::Rule.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnRulePropsMixin

@Stability(Stable)
public CfnRulePropsMixin(@NotNull
 CfnRuleMixinProps props)

Create a mixin to apply properties to AWS::VpcLattice::Rule.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnRuleMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()