Skip to content

UsageLimit

Source code in docs_src/capo_redshift/types/usage_limit.py
class UsageLimit(TypedDict, closed=True):
    usage_limit_id: NotRequired["capo_redshift.types.string.String"]
    """<p>The identifier of the usage limit.</p>"""
    cluster_identifier: NotRequired["capo_redshift.types.string.String"]
    """<p>The identifier of the cluster with a usage limit.</p>"""
    feature_type: NotRequired[
        "capo_redshift.types.usage_limit_feature_type.UsageLimitFeatureType"
    ]
    """<p>The Amazon Redshift feature to which the limit applies.</p>"""
    limit_type: NotRequired[
        "capo_redshift.types.usage_limit_limit_type.UsageLimitLimitType"
    ]
    """<p>The type of limit. Depending on the feature type, this can be based on a time duration or data size.</p>"""
    amount: NotRequired["capo_redshift.types.long.Long"]
    """<p>The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).</p>"""
    period: NotRequired["capo_redshift.types.usage_limit_period.UsageLimitPeriod"]
    """<p>The time period that the amount applies to. A <code>weekly</code> period begins on Sunday. The default is <code>monthly</code>. </p>"""
    breach_action: NotRequired[
        "capo_redshift.types.usage_limit_breach_action.UsageLimitBreachAction"
    ]
    """<p>The action that Amazon Redshift takes when the limit is reached. Possible values are: </p> <ul> <li> <p> <b>log</b> - To log an event in a system table. The default is log.</p> </li> <li> <p> <b>emit-metric</b> - To emit CloudWatch metrics.</p> </li> <li> <p> <b>disable</b> - To disable the feature until the next usage period begins.</p> </li> </ul>"""
    tags: NotRequired["capo_redshift.types.tag_list.TagList"]
    """<p>A list of tag instances.</p>"""

amount instance-attribute

amount: NotRequired[Long]

The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

breach_action instance-attribute

breach_action: NotRequired[UsageLimitBreachAction]

The action that Amazon Redshift takes when the limit is reached. Possible values are:

  • log - To log an event in a system table. The default is log.

  • emit-metric - To emit CloudWatch metrics.

  • disable - To disable the feature until the next usage period begins.

cluster_identifier instance-attribute

cluster_identifier: NotRequired[String]

The identifier of the cluster with a usage limit.

feature_type instance-attribute

feature_type: NotRequired[UsageLimitFeatureType]

The Amazon Redshift feature to which the limit applies.

limit_type instance-attribute

limit_type: NotRequired[UsageLimitLimitType]

The type of limit. Depending on the feature type, this can be based on a time duration or data size.

period instance-attribute

period: NotRequired[UsageLimitPeriod]

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

tags instance-attribute

tags: NotRequired[TagList]

A list of tag instances.

usage_limit_id instance-attribute

usage_limit_id: NotRequired[String]

The identifier of the usage limit.