Skip to content

UsageLimit

Source code in docs_src/capo_redshift_serverless/types/usage_limit.py
class UsageLimit(TypedDict, closed=True):
    usage_limit_id: NotRequired["str"]
    """<p>The identifier of the usage limit.</p>"""
    usage_limit_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the resource associated with the usage limit.</p>"""
    resource_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.</p>"""
    usage_type: NotRequired[
        "capo_redshift_serverless.types.usage_limit_usage_type.UsageLimitUsageType"
    ]
    """<p>The Amazon Redshift Serverless feature to limit.</p>"""
    amount: NotRequired["int"]
    """<p>The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.</p>"""
    period: NotRequired[
        "capo_redshift_serverless.types.usage_limit_period.UsageLimitPeriod"
    ]
    """<p>The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.</p>"""
    breach_action: NotRequired[
        "capo_redshift_serverless.types.usage_limit_breach_action.UsageLimitBreachAction"
    ]
    """<p>The action that Amazon Redshift Serverless takes when the limit is reached.</p>"""

amount instance-attribute

amount: NotRequired[int]

The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.

breach_action instance-attribute

breach_action: NotRequired[UsageLimitBreachAction]

The action that Amazon Redshift Serverless takes when the limit is reached.

period instance-attribute

period: NotRequired[UsageLimitPeriod]

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

resource_arn instance-attribute

resource_arn: NotRequired[str]

The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.

usage_limit_arn instance-attribute

usage_limit_arn: NotRequired[str]

The Amazon Resource Name (ARN) of the resource associated with the usage limit.

usage_limit_id instance-attribute

usage_limit_id: NotRequired[str]

The identifier of the usage limit.

usage_type instance-attribute

usage_type: NotRequired[UsageLimitUsageType]

The Amazon Redshift Serverless feature to limit.