Skip to content

CreateUsageLimitMessage

Source code in docs_src/capo_redshift/types/create_usage_limit_message.py
class CreateUsageLimitMessage(TypedDict, closed=True):
    cluster_identifier: NotRequired["capo_redshift.types.string.String"]
    """<p>The identifier of the cluster that you want to limit usage.</p>"""
    feature_type: NotRequired[
        "capo_redshift.types.usage_limit_feature_type.UsageLimitFeatureType"
    ]
    """<p>The Amazon Redshift feature that you want to limit.</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. If <code>FeatureType</code> is <code>spectrum</code>, then <code>LimitType</code> must be <code>data-scanned</code>. If <code>FeatureType</code> is <code>concurrency-scaling</code>, then <code>LimitType</code> must be <code>time</code>. If <code>FeatureType</code> is <code>cross-region-datasharing</code>, then <code>LimitType</code> must be <code>data-scanned</code>. If <code>FeatureType</code> is <code>extra-compute-for-automatic-optimization</code>, then <code>LimitType</code> must be <code>time</code>. </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). The value must be a positive number. </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. The default is log. For more information about this parameter, see <a>UsageLimit</a>.</p>"""
    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). The value must be a positive number.

breach_action instance-attribute

breach_action: NotRequired[UsageLimitBreachAction]

The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.

cluster_identifier instance-attribute

cluster_identifier: NotRequired[String]

The identifier of the cluster that you want to limit usage.

feature_type instance-attribute

feature_type: NotRequired[UsageLimitFeatureType]

The Amazon Redshift feature that you want to limit.

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. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time. If FeatureType is cross-region-datasharing, then LimitType must be data-scanned. If FeatureType is extra-compute-for-automatic-optimization, then LimitType must be time.

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.