interface CfnUsageLimitProps

Language	Type name
.NET	Amazon.CDK.AWS.Redshift.CfnUsageLimitProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsredshift#CfnUsageLimitProps
Java	software.amazon.awscdk.services.redshift.CfnUsageLimitProps
Python	aws_cdk.aws_redshift.CfnUsageLimitProps
TypeScript	aws-cdk-lib » aws_redshift » CfnUsageLimitProps

Properties for defining a CfnUsageLimit.

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

Example

// 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

Name	Type	Description
amount	number	The limit amount.
clusterIdentifier	string	The identifier of the cluster that you want to limit usage.
featureType	string	The Amazon Redshift feature that you want to limit.
limitType	string	The type of limit.
breachAction?	string	The action that Amazon Redshift takes when the limit is reached.
period?	string	The time period that the amount applies to.
tags?	CfnTag[]	A list of tag instances.

---

amount

Type: number

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

---

clusterIdentifier

Type: string

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

---

featureType

Type: string

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

---

limitType

Type: string

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

---

breachAction?

Type: string (optional)

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

---

period?

Type: string (optional)

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

---

tags?

Type: CfnTag[] (optional)

A list of tag instances.

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