You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Redshift::Types::CreateUsageLimitMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateUsageLimitMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  cluster_identifier: "String", # required
  feature_type: "spectrum", # required, accepts spectrum, concurrency-scaling
  limit_type: "time", # required, accepts time, data-scanned
  amount: 1, # required
  period: "daily", # accepts daily, weekly, monthly
  breach_action: "log", # accepts log, emit-metric, disable
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#amount ⇒ Integer

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.

Returns:

  • (Integer) —

    The limit amount.

#breach_action ⇒ String

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

Possible values:

  • log
  • emit-metric
  • disable

Returns:

  • (String) —

    The action that Amazon Redshift takes when the limit is reached.

#cluster_identifier ⇒ String

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

Returns:

  • (String) —

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

#feature_type ⇒ String

The Amazon Redshift feature that you want to limit.

Possible values:

  • spectrum
  • concurrency-scaling

Returns:

  • (String) —

    The Amazon Redshift feature that you want to limit.

#limit_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.

Possible values:

  • time
  • data-scanned

Returns:

  • (String) —

    The type of limit.

#period ⇒ String

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

Possible values:

  • daily
  • weekly
  • monthly

Returns:

  • (String) —

    The time period that the amount applies to.

#tags ⇒ Array<Types::Tag>

A list of tag instances.

Returns:

  • (Array<Types::Tag>) —

    A list of tag instances.