libZSservicesZSamazonka-redshiftZSamazonka-redshift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Redshift.Types.UsageLimit

Description

 
Synopsis

Documentation

data UsageLimit Source #

Describes a usage limit object for a cluster.

See: newUsageLimit smart constructor.

Constructors

UsageLimit' 

Fields

Instances

Instances details
Eq UsageLimit Source # 
Instance details

Defined in Amazonka.Redshift.Types.UsageLimit

Methods

(==) :: UsageLimit -> UsageLimit -> Bool #

(/=) :: UsageLimit -> UsageLimit -> Bool #

Read UsageLimit Source # 
Instance details

Defined in Amazonka.Redshift.Types.UsageLimit

Methods

readsPrec :: Int -> ReadS UsageLimit #

readList :: ReadS [UsageLimit] #

readPrec :: ReadPrec UsageLimit #

readListPrec :: ReadPrec [UsageLimit] #

Show UsageLimit Source # 
Instance details

Defined in Amazonka.Redshift.Types.UsageLimit

Methods

showsPrec :: Int -> UsageLimit -> ShowS #

show :: UsageLimit -> String #

showList :: [UsageLimit] -> ShowS #

Generic UsageLimit Source # 
Instance details

Defined in Amazonka.Redshift.Types.UsageLimit

Associated Types

type Rep UsageLimit :: Type -> Type #

Methods

from :: UsageLimit -> Rep UsageLimit x #

to :: Rep UsageLimit x -> UsageLimit #

NFData UsageLimit Source # 
Instance details

Defined in Amazonka.Redshift.Types.UsageLimit

Methods

rnf :: UsageLimit -> () #

Hashable UsageLimit Source # 
Instance details

Defined in Amazonka.Redshift.Types.UsageLimit

Methods

hashWithSalt :: Int -> UsageLimit -> Int #

hash :: UsageLimit -> Int #

FromXML UsageLimit Source # 
Instance details

Defined in Amazonka.Redshift.Types.UsageLimit

Methods

parseXML :: [Node] -> Either String UsageLimit #

type Rep UsageLimit Source # 
Instance details

Defined in Amazonka.Redshift.Types.UsageLimit

type Rep UsageLimit = D1 ('MetaData "UsageLimit" "Amazonka.Redshift.Types.UsageLimit" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "UsageLimit'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "amount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "limitType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageLimitLimitType))) :*: (S1 ('MetaSel ('Just "usageLimitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageLimitPeriod)))) :*: ((S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "breachAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageLimitBreachAction))) :*: (S1 ('MetaSel ('Just "featureType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageLimitFeatureType)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))))))

newUsageLimit :: UsageLimit Source #

Create a value of UsageLimit with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:amount:UsageLimit', usageLimit_amount - The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

$sel:limitType:UsageLimit', usageLimit_limitType - The type of limit. Depending on the feature type, this can be based on a time duration or data size.

$sel:usageLimitId:UsageLimit', usageLimit_usageLimitId - The identifier of the usage limit.

$sel:period:UsageLimit', usageLimit_period - The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

$sel:clusterIdentifier:UsageLimit', usageLimit_clusterIdentifier - The identifier of the cluster with a usage limit.

$sel:breachAction:UsageLimit', usageLimit_breachAction - 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.

$sel:featureType:UsageLimit', usageLimit_featureType - The Amazon Redshift feature to which the limit applies.

$sel:tags:UsageLimit', usageLimit_tags - A list of tag instances.

usageLimit_amount :: Lens' UsageLimit (Maybe Integer) Source #

The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

usageLimit_limitType :: Lens' UsageLimit (Maybe UsageLimitLimitType) Source #

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

usageLimit_usageLimitId :: Lens' UsageLimit (Maybe Text) Source #

The identifier of the usage limit.

usageLimit_period :: Lens' UsageLimit (Maybe UsageLimitPeriod) Source #

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

usageLimit_clusterIdentifier :: Lens' UsageLimit (Maybe Text) Source #

The identifier of the cluster with a usage limit.

usageLimit_breachAction :: Lens' UsageLimit (Maybe UsageLimitBreachAction) Source #

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.

usageLimit_featureType :: Lens' UsageLimit (Maybe UsageLimitFeatureType) Source #

The Amazon Redshift feature to which the limit applies.

usageLimit_tags :: Lens' UsageLimit (Maybe [Tag]) Source #

A list of tag instances.