View a markdown version of this page

AWS::BedrockAgentCore::GatewayRateLimit - AWS CloudFormation

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::BedrockAgentCore::GatewayRateLimit

Creates a rate limit for a gateway. Rate limits define throttling rules for each dimension that control request rates, token consumption rates, and concurrent connections through the gateway.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::BedrockAgentCore::GatewayRateLimit", "Properties" : { "Description" : String, "DimensionKeys" : [ String, ... ], "Entries" : [ LimitEntry, ... ], "GatewayIdentifier" : String, "RateLimitId" : String } }

YAML

Type: AWS::BedrockAgentCore::GatewayRateLimit Properties: Description: String DimensionKeys: - String Entries: - LimitEntry GatewayIdentifier: String RateLimitId: String

Properties

Description

The human-readable description of the rate limit.

Required: No

Type: String

Minimum: 0

Maximum: 512

Update requires: No interruption

DimensionKeys

The ordered list of dimension key names that define the scope of this rate limit.

Required: Yes

Type: Array of String

Minimum: 1 | 1

Maximum: 80 | 10

Update requires: Replacement

Entries

The list of rule entries that map dimension values to rate configurations.

Required: Yes

Type: Array of LimitEntry

Minimum: 1

Maximum: 1000

Update requires: No interruption

GatewayIdentifier

The unique identifier of the gateway.

Required: No

Type: String

Pattern: ^([0-9a-z][-]?){1,100}-[0-9a-z]{10}$

Update requires: Replacement

RateLimitId

The unique identifier of the rate limit.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_\.]{0,62}[a-zA-Z0-9]$

Minimum: 2

Maximum: 64

Update requires: Replacement

Return values

Ref

Fn::GetAtt

CreatedAt

The timestamp when the rate limit was created.

Status

The current status of the rate limit.

UpdatedAt

The timestamp when the rate limit was last updated.