Package software.amazon.awscdk.services.bedrockagentcore

Interface CfnGatewayRateLimitProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGatewayRateLimitProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:04.607Z")
@Stability(Stable)
public interface CfnGatewayRateLimitProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGatewayRateLimit.

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.*;
 CfnGatewayRateLimitProps cfnGatewayRateLimitProps = CfnGatewayRateLimitProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewayratelimit.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnGatewayRateLimitProps.Builder	builder()
default String	getDescription()	Optional human-readable description for this limit.
List<String>	getDimensionKeys()	Ordered list of dimension names defining the scope of this limit.
Object	getEntries()	Rule entries mapping dimension values to rate configurations.
default String	getGatewayIdentifier()
default String	getRateLimitId()	Limit identifier.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDimensionKeys

@Stability(Stable)
@NotNull
List<String> getDimensionKeys()

Ordered list of dimension names defining the scope of this limit.

Unique per gateway — no two limits can share the same dimensionKeys.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewayratelimit.html#cfn-bedrockagentcore-gatewayratelimit-dimensionkeys

getEntries

@Stability(Stable)
@NotNull
Object getEntries()

Rule entries mapping dimension values to rate configurations.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewayratelimit.html#cfn-bedrockagentcore-gatewayratelimit-entries

getDescription

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

Optional human-readable description for this limit.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewayratelimit.html#cfn-bedrockagentcore-gatewayratelimit-description

getGatewayIdentifier

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewayratelimit.html#cfn-bedrockagentcore-gatewayratelimit-gatewayidentifier

getRateLimitId

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

Limit identifier.

Optional on Create (system-generates if not provided by customer). Always present in responses.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewayratelimit.html#cfn-bedrockagentcore-gatewayratelimit-ratelimitid

builder

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

Returns:

a CfnGatewayRateLimitProps.Builder of CfnGatewayRateLimitProps