CfnGatewayRateLimitPropsMixin

class aws_cdk.cfn_property_mixins.aws_bedrockagentcore.CfnGatewayRateLimitPropsMixin(props, *, strategy=None)

Bases: Mixin

Definition of AWS::BedrockAgentCore::GatewayRateLimit Resource Type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewayratelimit.html
CloudformationResource:: AWS::BedrockAgentCore::GatewayRateLimit
Mixin:: true
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.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_gateway_rate_limit_props_mixin = bedrockagentcore.CfnGatewayRateLimitPropsMixin(bedrockagentcore.CfnGatewayRateLimitMixinProps(
    description="description",
    dimension_keys=["dimensionKeys"],
    entries=[bedrockagentcore.CfnGatewayRateLimitPropsMixin.LimitEntryProperty(
        connections=[bedrockagentcore.CfnGatewayRateLimitPropsMixin.RateConfigProperty(
            period="period",
            rate=123
        )],
        dimensions={
            "dimensions_key": "dimensions"
        },
        requests=[bedrockagentcore.CfnGatewayRateLimitPropsMixin.RateConfigProperty(
            period="period",
            rate=123
        )],
        tokens=[bedrockagentcore.CfnGatewayRateLimitPropsMixin.RateConfigProperty(
            period="period",
            rate=123
        )]
    )],
    gateway_identifier="gatewayIdentifier",
    rate_limit_id="rateLimitId"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::BedrockAgentCore::GatewayRateLimit.

Parameters:

props (Union[CfnGatewayRateLimitMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'dimensionKeys', 'entries', 'gatewayIdentifier', 'rateLimitId']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

LimitEntryProperty

class CfnGatewayRateLimitPropsMixin.LimitEntryProperty(*, connections=None, dimensions=None, requests=None, tokens=None)

Bases: object

A single rule entry within a limit, mapping dimension values to rate configurations.

Parameters:

connections (Union[IResolvable, Sequence[Union[IResolvable, RateConfigProperty, Dict[str, Any]]], None]) – Connection rate limits (per second only). Limited to 1 entry for now. — P2
dimensions (Union[IResolvable, Mapping[str, str], None]) – Map of dimension name to dimension value for a rule entry.
requests (Union[IResolvable, Sequence[Union[IResolvable, RateConfigProperty, Dict[str, Any]]], None]) – Request rate limits (RPS or RPM). Limited to 1 entry for now.
tokens (Union[IResolvable, Sequence[Union[IResolvable, RateConfigProperty, Dict[str, Any]]], None]) – Token rate limits (TPM). Limited to 1 entry for now. — P1

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewayratelimit-limitentry.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.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore

limit_entry_property = bedrockagentcore.CfnGatewayRateLimitPropsMixin.LimitEntryProperty(
    connections=[bedrockagentcore.CfnGatewayRateLimitPropsMixin.RateConfigProperty(
        period="period",
        rate=123
    )],
    dimensions={
        "dimensions_key": "dimensions"
    },
    requests=[bedrockagentcore.CfnGatewayRateLimitPropsMixin.RateConfigProperty(
        period="period",
        rate=123
    )],
    tokens=[bedrockagentcore.CfnGatewayRateLimitPropsMixin.RateConfigProperty(
        period="period",
        rate=123
    )]
)

Attributes

connections

Connection rate limits (per second only).

Limited to 1 entry for now. — P2

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewayratelimit-limitentry.html#cfn-bedrockagentcore-gatewayratelimit-limitentry-connections

dimensions

Map of dimension name to dimension value for a rule entry.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewayratelimit-limitentry.html#cfn-bedrockagentcore-gatewayratelimit-limitentry-dimensions

requests

Request rate limits (RPS or RPM).

Limited to 1 entry for now.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewayratelimit-limitentry.html#cfn-bedrockagentcore-gatewayratelimit-limitentry-requests

tokens

Token rate limits (TPM).

Limited to 1 entry for now. — P1

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewayratelimit-limitentry.html#cfn-bedrockagentcore-gatewayratelimit-limitentry-tokens

RateConfigProperty

class CfnGatewayRateLimitPropsMixin.RateConfigProperty(*, period=None, rate=None)

Bases: object

Rate configuration for a metric (requests or tokens).

Parameters:

period (Optional[str]) – Time period for rate limiting.
rate (Union[int, float, None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewayratelimit-rateconfig.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.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore

rate_config_property = bedrockagentcore.CfnGatewayRateLimitPropsMixin.RateConfigProperty(
    period="period",
    rate=123
)

Attributes

period

Time period for rate limiting.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewayratelimit-rateconfig.html#cfn-bedrockagentcore-gatewayratelimit-rateconfig-period

rate

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewayratelimit-rateconfig.html#cfn-bedrockagentcore-gatewayratelimit-rateconfig-rate

Type:: see