Package software.amazon.awscdk.services.redshift

Interface CfnUsageLimitProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUsageLimitProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:04:59.727Z")
@Stability(Stable)
public interface CfnUsageLimitProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUsageLimit.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.redshift.*;
 CfnUsageLimitProps cfnUsageLimitProps = CfnUsageLimitProps.builder()
         .amount(123)
         .clusterIdentifier("clusterIdentifier")
         .featureType("featureType")
         .limitType("limitType")
         // the properties below are optional
         .breachAction("breachAction")
         .period("period")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUsageLimitProps.Builder	A builder for CfnUsageLimitProps
static final class	CfnUsageLimitProps.Jsii$Proxy	An implementation for CfnUsageLimitProps

Method Summary

Modifier and Type	Method	Description
static CfnUsageLimitProps.Builder	builder()
Number	getAmount()	The limit amount.
default String	getBreachAction()	The action that Amazon Redshift takes when the limit is reached.
String	getClusterIdentifier()	The identifier of the cluster that you want to limit usage.
String	getFeatureType()	The Amazon Redshift feature that you want to limit.
String	getLimitType()	The type of limit.
default String	getPeriod()	The time period that the amount applies to.
default List<CfnTag>	getTags()	A list of tag instances.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAmount

@Stability(Stable)
@NotNull
Number getAmount()

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

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

getClusterIdentifier

@Stability(Stable)
@NotNull
String getClusterIdentifier()

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

See Also:

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

getFeatureType

@Stability(Stable)
@NotNull
String getFeatureType()

The Amazon Redshift feature that you want to limit.

See Also:

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

getLimitType

@Stability(Stable)
@NotNull
String getLimitType()

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

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

getBreachAction

@Stability(Stable)
@Nullable
default String getBreachAction()

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

The default is log.

See Also:

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

getPeriod

@Stability(Stable)
@Nullable
default String getPeriod()

The time period that the amount applies to.

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of tag instances.

See Also:

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

builder

@Stability(Stable)
static CfnUsageLimitProps.Builder builder()

Returns:

a CfnUsageLimitProps.Builder of CfnUsageLimitProps