Package software.amazon.awscdk.cfnpropertymixins.services.redshift

Interface CfnUsageLimitMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUsageLimitMixinProps.Jsii$Proxy

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

Properties for CfnUsageLimitPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.redshift.*;
 CfnUsageLimitMixinProps cfnUsageLimitMixinProps = CfnUsageLimitMixinProps.builder()
         .amount(123)
         .breachAction("breachAction")
         .clusterIdentifier("clusterIdentifier")
         .featureType("featureType")
         .limitType("limitType")
         .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	CfnUsageLimitMixinProps.Builder	A builder for CfnUsageLimitMixinProps
static final class	CfnUsageLimitMixinProps.Jsii$Proxy	An implementation for CfnUsageLimitMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnUsageLimitMixinProps.Builder	builder()
default Number	getAmount()	The limit amount.
default String	getBreachAction()	The action that Amazon Redshift takes when the limit is reached.
default String	getClusterIdentifier()	The identifier of the cluster that you want to limit usage.
default String	getFeatureType()	The Amazon Redshift feature that you want to limit.
default 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)
@Nullable
default 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

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

getClusterIdentifier

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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

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 CfnUsageLimitMixinProps.Builder builder()

Returns:

a CfnUsageLimitMixinProps.Builder of CfnUsageLimitMixinProps