CfnUsageLimitProps

class aws_cdk.aws_redshift.CfnUsageLimitProps(*, amount, cluster_identifier, feature_type, limit_type, breach_action=None, period=None, tags=None)

Bases: object

Properties for defining a CfnUsageLimit.

Parameters:

amount (Union[int, float]) – 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.
cluster_identifier (str) – The identifier of the cluster that you want to limit usage.
feature_type (str) – The Amazon Redshift feature that you want to limit.
limit_type (str) – 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.
breach_action (Optional[str]) – The action that Amazon Redshift takes when the limit is reached. The default is log.
period (Optional[str]) – The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tag instances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_redshift as redshift

cfn_usage_limit_props = redshift.CfnUsageLimitProps(
    amount=123,
    cluster_identifier="clusterIdentifier",
    feature_type="featureType",
    limit_type="limitType",

    # the properties below are optional
    breach_action="breachAction",
    period="period",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

amount

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html#cfn-redshift-usagelimit-amount

breach_action

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

The default is log.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html#cfn-redshift-usagelimit-breachaction

cluster_identifier

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html#cfn-redshift-usagelimit-clusteridentifier

feature_type

The Amazon Redshift feature that you want to limit.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html#cfn-redshift-usagelimit-featuretype

limit_type

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html#cfn-redshift-usagelimit-limittype

period

The time period that the amount applies to.

A weekly period begins on Sunday. The default is monthly.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html#cfn-redshift-usagelimit-period

tags

A list of tag instances.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html#cfn-redshift-usagelimit-tags