CfnGatewayRateLimitProps

class aws_cdk.aws_bedrockagentcore.CfnGatewayRateLimitProps(*, dimension_keys, entries, description=None, gateway_identifier=None, rate_limit_id=None)

Bases: object

Properties for defining a CfnGatewayRateLimit.

Parameters:
  • dimension_keys (Sequence[str]) – Ordered list of dimension names defining the scope of this limit. Unique per gateway — no two limits can share the same dimensionKeys.

  • entries (Union[IResolvable, Sequence[Union[IResolvable, LimitEntryProperty, Dict[str, Any]]]]) – Rule entries mapping dimension values to rate configurations.

  • description (Optional[str]) – Optional human-readable description for this limit.

  • gateway_identifier (Optional[str])

  • rate_limit_id (Optional[str]) – Limit identifier. Optional on Create (system-generates if not provided by customer). Always present in responses.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

cfn_gateway_rate_limit_props = bedrockagentcore.CfnGatewayRateLimitProps(
    dimension_keys=["dimensionKeys"],
    entries=[bedrockagentcore.CfnGatewayRateLimit.LimitEntryProperty(
        dimensions={
            "dimensions_key": "dimensions"
        },

        # the properties below are optional
        connections=[bedrockagentcore.CfnGatewayRateLimit.RateConfigProperty(
            period="period",
            rate=123
        )],
        requests=[bedrockagentcore.CfnGatewayRateLimit.RateConfigProperty(
            period="period",
            rate=123
        )],
        tokens=[bedrockagentcore.CfnGatewayRateLimit.RateConfigProperty(
            period="period",
            rate=123
        )]
    )],

    # the properties below are optional
    description="description",
    gateway_identifier="gatewayIdentifier",
    rate_limit_id="rateLimitId"
)

Attributes

description

Optional human-readable description for this limit.

See:

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

dimension_keys

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

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

See:

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

entries

Rule entries mapping dimension values to rate configurations.

See:

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

gateway_identifier

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

Type:

see

rate_limit_id

Limit identifier.

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

See:

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