Package software.amazon.awscdk.services.vpclattice

Interface CfnRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:28.268Z")
@Stability(Stable)
public interface CfnRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRule.

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.*;
 CfnRuleProps cfnRuleProps = CfnRuleProps.builder()
         .action(ActionProperty.builder()
                 .fixedResponse(FixedResponseProperty.builder()
                         .statusCode(123)
                         .build())
                 .forward(ForwardProperty.builder()
                         .targetGroups(List.of(WeightedTargetGroupProperty.builder()
                                 .targetGroupIdentifier("targetGroupIdentifier")
                                 // the properties below are optional
                                 .weight(123)
                                 .build()))
                         .build())
                 .build())
         .match(MatchProperty.builder()
                 .httpMatch(HttpMatchProperty.builder()
                         .headerMatches(List.of(HeaderMatchProperty.builder()
                                 .match(HeaderMatchTypeProperty.builder()
                                         .contains("contains")
                                         .exact("exact")
                                         .prefix("prefix")
                                         .build())
                                 .name("name")
                                 // the properties below are optional
                                 .caseSensitive(false)
                                 .build()))
                         .method("method")
                         .pathMatch(PathMatchProperty.builder()
                                 .match(PathMatchTypeProperty.builder()
                                         .exact("exact")
                                         .prefix("prefix")
                                         .build())
                                 // the properties below are optional
                                 .caseSensitive(false)
                                 .build())
                         .build())
                 .build())
         .priority(123)
         // the properties below are optional
         .listenerIdentifier("listenerIdentifier")
         .name("name")
         .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	CfnRuleProps.Builder	A builder for CfnRuleProps
static final class	CfnRuleProps.Jsii$Proxy	An implementation for CfnRuleProps

Method Summary

Modifier and Type	Method	Description
static CfnRuleProps.Builder	builder()
Object	getAction()	Describes the action for a rule.
default String	getListenerIdentifier()	The ID or ARN of the listener.
Object	getMatch()	The rule match.
default String	getName()	The name of the rule.
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)
@NotNull
Object getAction()

Describes the action for a rule.

See Also:

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

getMatch

@Stability(Stable)
@NotNull
Object getMatch()

The rule match.

See Also:

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

getPriority

@Stability(Stable)
@NotNull
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

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

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

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 CfnRuleProps.Builder builder()

Returns:

a CfnRuleProps.Builder of CfnRuleProps