Skip to content
v2.275.0

CfnGatewayRateLimitProps Struct ​

Properties for defining a CfnGatewayRateLimit.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrockagentcore as bedrockagentcore } from 'aws-cdk-lib';
const cfnGatewayRateLimitProps: bedrockagentcore.CfnGatewayRateLimitProps = {
  dimensionKeys: ['dimensionKeys'],
  entries: [{
    dimensions: {
      dimensionsKey: 'dimensions',
    },

    // the properties below are optional
    connections: [{
      period: 'period',
      rate: 123,
    }],
    requests: [{
      period: 'period',
      rate: 123,
    }],
    tokens: [{
      period: 'period',
      rate: 123,
    }],
  }],

  // the properties below are optional
  description: 'description',
  gatewayIdentifier: 'gatewayIdentifier',
  rateLimitId: 'rateLimitId',
};

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
Optional human-readable description for this limit.
dimensionKeysstring[]dimension_keystyping.List[str]dimensionKeysList<String>DimensionKeysstring[]DimensionKeys*[]*stringrequired#
Ordered list of dimension names defining the scope of this limit.

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

entriesIResolvable | IResolvable | CfnGatewayRateLimit.LimitEntryProperty[]entriestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LimitEntryProperty]]]entriesIResolvableEntriesIResolvableEntriesinterface{}required#
Rule entries mapping dimension values to rate configurations.
gatewayIdentifieroptionalstringgateway_identifieroptionalstrgatewayIdentifieroptionalStringGatewayIdentifieroptionalstringGatewayIdentifieroptional*string#
rateLimitIdoptionalstringrate_limit_idoptionalstrrateLimitIdoptionalStringRateLimitIdoptionalstringRateLimitIdoptional*string#
Limit identifier.

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