Package software.amazon.awscdk.services.bedrockagentcore

Class CfnGatewayRule

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.bedrockagentcore.CfnGatewayRule
All Implemented Interfaces:
IInspectable, IGatewayRuleRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:04.608Z") @Stability(Stable) public class CfnGatewayRule extends CfnResource implements IInspectable, IGatewayRuleRef
Resource Type definition for AWS::BedrockAgentCore::GatewayRule.

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.bedrockagentcore.*;
 CfnGatewayRule cfnGatewayRule = CfnGatewayRule.Builder.create(this, "MyCfnGatewayRule")
         .actions(List.of(ActionProperty.builder()
                 .configurationBundle(ConfigurationBundleActionProperty.builder()
                         .staticOverride(StaticOverrideProperty.builder()
                                 .bundleArn("bundleArn")
                                 .bundleVersion("bundleVersion")
                                 .build())
                         .weightedOverride(WeightedOverrideProperty.builder()
                                 .trafficSplit(List.of(TrafficSplitEntryProperty.builder()
                                         .configurationBundle(ConfigurationBundleReferenceProperty.builder()
                                                 .bundleArn("bundleArn")
                                                 .bundleVersion("bundleVersion")
                                                 .build())
                                         .name("name")
                                         .weight(123)
                                         // the properties below are optional
                                         .description("description")
                                         .metadata(Map.of(
                                                 "metadataKey", "metadata"))
                                         .build()))
                                 .build())
                         .build())
                 .routeToTarget(RouteToTargetActionProperty.builder()
                         .staticRoute(StaticRouteProperty.builder()
                                 .targetName("targetName")
                                 .build())
                         .weightedRoute(WeightedRouteProperty.builder()
                                 .trafficSplit(List.of(TargetTrafficSplitEntryProperty.builder()
                                         .name("name")
                                         .targetName("targetName")
                                         .weight(123)
                                         // the properties below are optional
                                         .description("description")
                                         .metadata(Map.of(
                                                 "metadataKey", "metadata"))
                                         .build()))
                                 .build())
                         .build())
                 .build()))
         .priority(123)
         // the properties below are optional
         .conditions(List.of(ConditionProperty.builder()
                 .matchPaths(MatchPathsProperty.builder()
                         .anyOf(List.of("anyOf"))
                         .build())
                 .matchPrincipals(MatchPrincipalsProperty.builder()
                         .anyOf(List.of(MatchPrincipalEntryProperty.builder()
                                 .iamPrincipal(IamPrincipalProperty.builder()
                                         .arn("arn")
                                         // the properties below are optional
                                         .operator("operator")
                                         .build())
                                 .build()))
                         .build())
                 .build()))
         .description("description")
         .gatewayIdentifier("gatewayIdentifier")
         .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

    • CfnGatewayRule

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

    • CfnGatewayRule

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

    • CfnGatewayRule

      @Stability(Stable) public CfnGatewayRule(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnGatewayRuleProps props)
      Create a new AWS::BedrockAgentCore::GatewayRule.

      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

    • isCfnGatewayRule

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

      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.

    • getAttrCreatedAt

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

    • getAttrGatewayArn

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

    • getAttrRuleId

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

    • getAttrStatus

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

    • getAttrUpdatedAt

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

    • 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

    • getGatewayRuleRef

      @Stability(Stable) @NotNull public GatewayRuleReference getGatewayRuleRef()
      A reference to a GatewayRule resource.
      Specified by:
      getGatewayRuleRef in interface IGatewayRuleRef

    • getActions

      @Stability(Stable) @NotNull public Object getActions()
      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGatewayRule.ActionProperty>

    • setActions

      @Stability(Stable) public void setActions(@NotNull IResolvable value)

    • setActions

      @Stability(Stable) public void setActions(@NotNull List<Object> value)

    • getPriority

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

    • setPriority

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

    • getConditions

      @Stability(Stable) @Nullable public Object getConditions()
      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGatewayRule.ConditionProperty>

    • setConditions

      @Stability(Stable) public void setConditions(@Nullable IResolvable value)

    • setConditions

      @Stability(Stable) public void setConditions(@Nullable List<Object> value)

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)

    • getGatewayIdentifier

      @Stability(Stable) @Nullable public String getGatewayIdentifier()

    • setGatewayIdentifier

      @Stability(Stable) public void setGatewayIdentifier(@Nullable String value)