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

Inherits:

Struct

• Object
• Struct
• Aws::Redshift::Types::UsageLimit

Includes:

Structure

Defined in:

lib/aws-sdk-redshift/types.rb

Overview

Describes a usage limit object for a cluster.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #amount ⇒ Integer

  The limit amount.

• #breach_action ⇒ String

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

• #cluster_identifier ⇒ String

  The identifier of the cluster with a usage limit.

• #feature_type ⇒ String

  The Amazon Redshift feature to which the limit applies.

• #limit_type ⇒ String

  The type of limit.

• #period ⇒ String

  The time period that the amount applies to.

• #tags ⇒ Array<Types::Tag>

  A list of tag instances.

• #usage_limit_id ⇒ String

  The identifier of the usage limit.

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)

# File 'lib/aws-sdk-redshift/types.rb', line 12365

class UsageLimit < Struct.new(
  :usage_limit_id,
  :cluster_identifier,
  :feature_type,
  :limit_type,
  :amount,
  :period,
  :breach_action,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 12365

class UsageLimit < Struct.new(
  :usage_limit_id,
  :cluster_identifier,
  :feature_type,
  :limit_type,
  :amount,
  :period,
  :breach_action,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_identifier ⇒ String

The identifier of the cluster with a usage limit.

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 12365

class UsageLimit < Struct.new(
  :usage_limit_id,
  :cluster_identifier,
  :feature_type,
  :limit_type,
  :amount,
  :period,
  :breach_action,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#feature_type ⇒ String

The Amazon Redshift feature to which the limit applies.

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 12365

class UsageLimit < Struct.new(
  :usage_limit_id,
  :cluster_identifier,
  :feature_type,
  :limit_type,
  :amount,
  :period,
  :breach_action,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#limit_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 12365

class UsageLimit < Struct.new(
  :usage_limit_id,
  :cluster_identifier,
  :feature_type,
  :limit_type,
  :amount,
  :period,
  :breach_action,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#period ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 12365

class UsageLimit < Struct.new(
  :usage_limit_id,
  :cluster_identifier,
  :feature_type,
  :limit_type,
  :amount,
  :period,
  :breach_action,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of tag instances.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-redshift/types.rb', line 12365

class UsageLimit < Struct.new(
  :usage_limit_id,
  :cluster_identifier,
  :feature_type,
  :limit_type,
  :amount,
  :period,
  :breach_action,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#usage_limit_id ⇒ String

The identifier of the usage limit.

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 12365

class UsageLimit < Struct.new(
  :usage_limit_id,
  :cluster_identifier,
  :feature_type,
  :limit_type,
  :amount,
  :period,
  :breach_action,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end