Skip to content
v2.274.0

CfnUsageLimitProps Struct ​

Properties for defining a CfnUsageLimit.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_redshift as redshift } from 'aws-cdk-lib';
const cfnUsageLimitProps: redshift.CfnUsageLimitProps = {
  amount: 123,
  clusterIdentifier: 'clusterIdentifier',
  featureType: 'featureType',
  limitType: 'limitType',

  // the properties below are optional
  breachAction: 'breachAction',
  period: 'period',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

amountnumberamountint | floatamountNumberAmountdoubleAmount*float64required#
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.

breachActionstringbreach_actionstrbreachActionStringBreachActionstringBreachAction*string#
The action that Amazon Redshift takes when the limit is reached.

The default is log.

clusterIdentifierstringcluster_identifierstrclusterIdentifierStringClusterIdentifierstringClusterIdentifier*stringrequired#
The identifier of the cluster that you want to limit usage.
featureTypestringfeature_typestrfeatureTypeStringFeatureTypestringFeatureType*stringrequired#
The Amazon Redshift feature that you want to limit.
limitTypestringlimit_typestrlimitTypeStringLimitTypestringLimitType*stringrequired#
The type of limit.
notes

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.

periodstringperiodstrperiodStringPeriodstringPeriod*string#
The time period that the amount applies to.

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

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
A list of tag instances.

Used as props by ​