UsageLimit
Describes a usage limit object for a cluster.
Contents
Note
In the following list, the required parameters are described first.
- Amount
-
The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).
Type: Long
Required: No
- BreachAction
-
The action that Amazon Redshift takes when the limit is reached. Possible values are:
-
log - To log an event in a system table. The default is log.
-
emit-metric - To emit CloudWatch metrics.
-
disable - To disable the feature until the next usage period begins.
Type: String
Valid Values:
log | emit-metric | disableRequired: No
-
- ClusterIdentifier
-
The identifier of the cluster with a usage limit.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
- FeatureType
-
The Amazon Redshift feature to which the limit applies.
Type: String
Valid Values:
spectrum | concurrency-scaling | cross-region-datasharingRequired: No
- LimitType
-
The type of limit. Depending on the feature type, this can be based on a time duration or data size.
Type: String
Valid Values:
time | data-scannedRequired: No
- Period
-
The time period that the amount applies to. A
weeklyperiod begins on Sunday. The default ismonthly.Type: String
Valid Values:
daily | weekly | monthlyRequired: No
- Tags.Tag.N
-
A list of tag instances.
Type: Array of Tag objects
Required: No
- UsageLimitId
-
The identifier of the usage limit.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
