Package software.amazon.awscdk.services.bedrockagentcore

Class CfnGatewayRateLimit

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.CfnGatewayRateLimit
All Implemented Interfaces:
IInspectable, IGatewayRateLimitRef, 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.605Z") @Stability(Stable) public class CfnGatewayRateLimit extends CfnResource implements IInspectable, IGatewayRateLimitRef
Definition of AWS::BedrockAgentCore::GatewayRateLimit Resource Type.

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.*;
 CfnGatewayRateLimit cfnGatewayRateLimit = CfnGatewayRateLimit.Builder.create(this, "MyCfnGatewayRateLimit")
         .dimensionKeys(List.of("dimensionKeys"))
         .entries(List.of(LimitEntryProperty.builder()
                 .dimensions(Map.of(
                         "dimensionsKey", "dimensions"))
                 // the properties below are optional
                 .connections(List.of(RateConfigProperty.builder()
                         .period("period")
                         .rate(123)
                         .build()))
                 .requests(List.of(RateConfigProperty.builder()
                         .period("period")
                         .rate(123)
                         .build()))
                 .tokens(List.of(RateConfigProperty.builder()
                         .period("period")
                         .rate(123)
                         .build()))
                 .build()))
         // the properties below are optional
         .description("description")
         .gatewayIdentifier("gatewayIdentifier")
         .rateLimitId("rateLimitId")
         .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

    • CfnGatewayRateLimit

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

    • CfnGatewayRateLimit

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

    • CfnGatewayRateLimit

      @Stability(Stable) public CfnGatewayRateLimit(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnGatewayRateLimitProps props)
      Create a new AWS::BedrockAgentCore::GatewayRateLimit.

      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

    • isCfnGatewayRateLimit

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

      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()

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      Status of a gateway limit.

    • 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

    • getGatewayRateLimitRef

      @Stability(Stable) @NotNull public GatewayRateLimitReference getGatewayRateLimitRef()
      A reference to a GatewayRateLimit resource.
      Specified by:
      getGatewayRateLimitRef in interface IGatewayRateLimitRef

    • getDimensionKeys

      @Stability(Stable) @NotNull public List<String> getDimensionKeys()
      Ordered list of dimension names defining the scope of this limit.

    • setDimensionKeys

      @Stability(Stable) public void setDimensionKeys(@NotNull List<String> value)
      Ordered list of dimension names defining the scope of this limit.

    • getEntries

      @Stability(Stable) @NotNull public Object getEntries()
      Rule entries mapping dimension values to rate configurations.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGatewayRateLimit.LimitEntryProperty>

    • setEntries

      @Stability(Stable) public void setEntries(@NotNull IResolvable value)
      Rule entries mapping dimension values to rate configurations.

    • setEntries

      @Stability(Stable) public void setEntries(@NotNull List<Object> value)
      Rule entries mapping dimension values to rate configurations.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      Optional human-readable description for this limit.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      Optional human-readable description for this limit.

    • getGatewayIdentifier

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

    • setGatewayIdentifier

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

    • getRateLimitId

      @Stability(Stable) @Nullable public String getRateLimitId()
      Limit identifier.

    • setRateLimitId

      @Stability(Stable) public void setRateLimitId(@Nullable String value)
      Limit identifier.