Skip to content

CreateUsageLimitRequest

Source code in docs_src/capo_redshift_serverless/types/create_usage_limit_request.py
class CreateUsageLimitRequest(TypedDict, closed=True):
    resource_arn: "str"
    """<p>The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.</p>"""
    usage_type: (
        "capo_redshift_serverless.types.usage_limit_usage_type.UsageLimitUsageType"
    )
    """<p>The type of Amazon Redshift Serverless usage to create a usage limit for.</p>"""
    amount: "int"
    """<p>The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. 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. The default is log.</p>"""

amount instance-attribute

amount: int

The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. 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. The default is log.

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: str

The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.

usage_type instance-attribute

usage_type: UsageLimitUsageType

The type of Amazon Redshift Serverless usage to create a usage limit for.