Create Usage Limit

redshift_create_usage_limit

R Documentation

Creates a usage limit for a specified Amazon Redshift feature on a cluster

Description

Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.

Usage

redshift_create_usage_limit(ClusterIdentifier, FeatureType, LimitType,
  Amount, Period, BreachAction, Tags)

Arguments

ClusterIdentifier

[required] The identifier of the cluster that you want to limit usage.

FeatureType

[required] The Amazon Redshift feature that you want to limit.

LimitType

[required] 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.

Amount

[required] 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.

Period

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

BreachAction

The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.

Tags

A list of tag instances.

Value

A list with the following syntax:

list(
  UsageLimitId = "string",
  ClusterIdentifier = "string",
  FeatureType = "spectrum"|"concurrency-scaling"|"cross-region-datasharing",
  LimitType = "time"|"data-scanned",
  Amount = 123,
  Period = "daily"|"weekly"|"monthly",
  BreachAction = "log"|"emit-metric"|"disable",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Request syntax

svc$create_usage_limit(
  ClusterIdentifier = "string",
  FeatureType = "spectrum"|"concurrency-scaling"|"cross-region-datasharing",
  LimitType = "time"|"data-scanned",
  Amount = 123,
  Period = "daily"|"weekly"|"monthly",
  BreachAction = "log"|"emit-metric"|"disable",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)