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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb

Overview

Note:

When making an API call, you may pass CreateUsageLimitMessage data as a 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",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#amountInteger

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)


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3191

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

#breach_actionString

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

Returns:

  • (String)


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3191

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

#cluster_identifierString

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

Returns:

  • (String)


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3191

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

#feature_typeString

The Amazon Redshift feature that you want to limit.

Returns:

  • (String)


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3191

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

#limit_typeString

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.

Returns:

  • (String)


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3191

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

#periodString

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

Returns:

  • (String)


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3191

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

#tagsArray<Types::Tag>

A list of tag instances.

Returns:



3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3191

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