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

Class: Aws::Redshift::Types::UsageLimit

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

Overview

Describes a usage limit object for a cluster.

Returned by:

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).

Returns:

  • (Integer) —

    The limit amount.

#breach_action ⇒ String

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.

    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 with a usage limit.

Returns:

  • (String) —

    The identifier of the cluster with a usage limit.

#feature_type ⇒ String

The Amazon Redshift feature to which the limit applies.

Possible values:

  • spectrum
  • concurrency-scaling

Returns:

  • (String) —

    The Amazon Redshift feature to which the limit applies.

#limit_type ⇒ String

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

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.

#usage_limit_id ⇒ String

The identifier of the usage limit.

Returns:

  • (String) —

    The identifier of the usage limit.