Package software.amazon.awscdk.services.rtbfabric

Class CfnLinkRoutingRule

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.rtbfabric.CfnLinkRoutingRule
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ILinkRoutingRuleRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)", date="2026-06-16T16:14:32.252Z") @Stability(Stable) public class CfnLinkRoutingRule extends CfnResource implements IInspectable, ILinkRoutingRuleRef, ITaggableV2
Resource Type definition for AWS::RTBFabric::LinkRoutingRule.

A routing rule on a link within RTB Fabric that controls request routing based on conditions such as host headers, path matching, and query string parameters.

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.rtbfabric.*;
 CfnLinkRoutingRule cfnLinkRoutingRule = CfnLinkRoutingRule.Builder.create(this, "MyCfnLinkRoutingRule")
         .conditions(RuleConditionProperty.builder()
                 .hostHeader("hostHeader")
                 .hostHeaderWildcard("hostHeaderWildcard")
                 .pathExact("pathExact")
                 .pathPrefix("pathPrefix")
                 .queryStringEquals(QueryStringKeyValuePairProperty.builder()
                         .key("key")
                         .value("value")
                         .build())
                 .queryStringExists("queryStringExists")
                 .build())
         .gatewayId("gatewayId")
         .linkId("linkId")
         .priority(123)
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLinkRoutingRule

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

    • CfnLinkRoutingRule

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

    • CfnLinkRoutingRule

      @Stability(Stable) public CfnLinkRoutingRule(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLinkRoutingRuleProps props)
      Create a new AWS::RTBFabric::LinkRoutingRule.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForLinkRoutingRule

      @Stability(Stable) @NotNull public static String arnForLinkRoutingRule(@NotNull ILinkRoutingRuleRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnLinkRoutingRule

      @Stability(Stable) @NotNull public static Boolean isCfnLinkRoutingRule(@NotNull Object x)
      Checks whether the given object is a CfnLinkRoutingRule.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()

    • getAttrCreatedTimestamp

      @Stability(Stable) @NotNull public String getAttrCreatedTimestamp()

    • getAttrRuleId

      @Stability(Stable) @NotNull public String getAttrRuleId()

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()

    • getAttrUpdatedTimestamp

      @Stability(Stable) @NotNull public String getAttrUpdatedTimestamp()

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getLinkRoutingRuleRef

      @Stability(Stable) @NotNull public LinkRoutingRuleReference getLinkRoutingRuleRef()
      A reference to a LinkRoutingRule resource.
      Specified by:
      getLinkRoutingRuleRef in interface ILinkRoutingRuleRef

    • getConditions

      @Stability(Stable) @NotNull public Object getConditions()
      Conditions for a routing rule.

      Returns union: either IResolvable or CfnLinkRoutingRule.RuleConditionProperty

    • setConditions

      @Stability(Stable) public void setConditions(@NotNull IResolvable value)
      Conditions for a routing rule.

    • setConditions

      @Stability(Stable) public void setConditions(@NotNull CfnLinkRoutingRule.RuleConditionProperty value)
      Conditions for a routing rule.

    • getGatewayId

      @Stability(Stable) @NotNull public String getGatewayId()

    • setGatewayId

      @Stability(Stable) public void setGatewayId(@NotNull String value)

    • getLinkId

      @Stability(Stable) @NotNull public String getLinkId()

    • setLinkId

      @Stability(Stable) public void setLinkId(@NotNull String value)

    • getPriority

      @Stability(Stable) @NotNull public Number getPriority()

    • setPriority

      @Stability(Stable) public void setPriority(@NotNull Number value)

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Tags to assign to the LinkRoutingRule.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Tags to assign to the LinkRoutingRule.