View a markdown version of this page

AWS::Redshift::UsageLimit - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Redshift::UsageLimit

Describes a usage limit object for a cluster.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Redshift::UsageLimit",
  "Properties" : {
      "Amount" : Number,
      "BreachAction" : String,
      "ClusterIdentifier" : String,
      "FeatureType" : String,
      "LimitType" : String,
      "Period" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Redshift::UsageLimit
Properties:
  Amount: Number
  BreachAction: String
  ClusterIdentifier: String
  FeatureType: String
  LimitType: String
  Period: String
  Tags: 
    - Tag

Properties

Amount

The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

Required: Yes

Type: Number

Update requires: No interruption

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.

Required: No

Type: String

Allowed values: log | emit-metric | disable

Update requires: No interruption

ClusterIdentifier

The identifier of the cluster with a usage limit.

Required: Yes

Type: String

Maximum: 2147483647

Update requires: Replacement

FeatureType

The Amazon Redshift feature to which the limit applies.

Required: Yes

Type: String

Allowed values: spectrum | concurrency-scaling | cross-region-datasharing | extra-compute-for-automatic-optimization

Update requires: Replacement

LimitType

The type of limit. Depending on the feature type, this can be based on a time duration or data size.

Required: Yes

Type: String

Allowed values: time | data-scanned

Update requires: Replacement

Period

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

Required: No

Type: String

Allowed values: daily | weekly | monthly

Update requires: Replacement

Tags

A list of tag instances.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

UsageLimitId

The identifier of the usage limit.