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

Interface CfnRuleMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-19T12:55:27.250Z")
@Stability(Stable)
public interface CfnRuleMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnRulePropsMixin.

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.*;
 CfnRuleMixinProps cfnRuleMixinProps = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRuleMixinProps.Builder	builder()
default Object	getAction()	Describes the action for a rule.
default String	getListenerIdentifier()	The ID or ARN of the listener.
default Object	getMatch()	The rule match.
default String	getName()	The name of the rule.
default Number	getPriority()	The priority assigned to the rule.
default String	getServiceIdentifier()	The ID or ARN of the service.
default List<CfnTag>	getTags()	The tags for the rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@Nullable
default Object getAction()

Describes the action for a rule.

Returns union: either IResolvable or CfnRulePropsMixin.ActionProperty

See Also:

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

getListenerIdentifier

@Stability(Stable)
@Nullable
default String getListenerIdentifier()

The ID or ARN of the listener.

See Also:

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

getMatch

@Stability(Stable)
@Nullable
default Object getMatch()

The rule match.

Returns union: either IResolvable or CfnRulePropsMixin.MatchProperty

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the rule.

The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

If you don't specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name.

See Also:

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

getPriority

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

The priority assigned to the rule.

Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.

See Also:

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

getServiceIdentifier

@Stability(Stable)
@Nullable
default String getServiceIdentifier()

The ID or ARN of the service.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags for the rule.

See Also:

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

builder

@Stability(Stable)
static CfnRuleMixinProps.Builder builder()

Returns:

a CfnRuleMixinProps.Builder of CfnRuleMixinProps