Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Redshift.ModifyUsageLimit

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.

Synopsis

data ModifyUsageLimit = ModifyUsageLimit' {
- amount :: Maybe Integer
- breachAction :: Maybe UsageLimitBreachAction
- usageLimitId :: Text
}
newModifyUsageLimit :: Text -> ModifyUsageLimit
modifyUsageLimit_amount :: Lens' ModifyUsageLimit (Maybe Integer)
modifyUsageLimit_breachAction :: Lens' ModifyUsageLimit (Maybe UsageLimitBreachAction)
modifyUsageLimit_usageLimitId :: Lens' ModifyUsageLimit Text
data UsageLimit = UsageLimit' {
- amount :: Maybe Integer
- breachAction :: Maybe UsageLimitBreachAction
- clusterIdentifier :: Maybe Text
- featureType :: Maybe UsageLimitFeatureType
- limitType :: Maybe UsageLimitLimitType
- period :: Maybe UsageLimitPeriod
- tags :: Maybe [Tag]
- usageLimitId :: Maybe Text
}
newUsageLimit :: UsageLimit
usageLimit_amount :: Lens' UsageLimit (Maybe Integer)
usageLimit_breachAction :: Lens' UsageLimit (Maybe UsageLimitBreachAction)
usageLimit_clusterIdentifier :: Lens' UsageLimit (Maybe Text)
usageLimit_featureType :: Lens' UsageLimit (Maybe UsageLimitFeatureType)
usageLimit_limitType :: Lens' UsageLimit (Maybe UsageLimitLimitType)
usageLimit_period :: Lens' UsageLimit (Maybe UsageLimitPeriod)
usageLimit_tags :: Lens' UsageLimit (Maybe [Tag])
usageLimit_usageLimitId :: Lens' UsageLimit (Maybe Text)

Creating a Request

data ModifyUsageLimit Source #

See: newModifyUsageLimit smart constructor.

Constructors

ModifyUsageLimit'
Fields amount :: Maybe Integer The new limit amount. For more information about this parameter, see UsageLimit. breachAction :: Maybe UsageLimitBreachAction The new action that Amazon Redshift takes when the limit is reached. For more information about this parameter, see UsageLimit. usageLimitId :: Text The identifier of the usage limit to modify.

Instances

Instances details

ToHeaders ModifyUsageLimit Source #
Instance details Defined in Amazonka.Redshift.ModifyUsageLimit Methods toHeaders :: ModifyUsageLimit -> [Header] #
ToPath ModifyUsageLimit Source #
Instance details Defined in Amazonka.Redshift.ModifyUsageLimit Methods toPath :: ModifyUsageLimit -> ByteString #
ToQuery ModifyUsageLimit Source #
Instance details Defined in Amazonka.Redshift.ModifyUsageLimit Methods toQuery :: ModifyUsageLimit -> QueryString #
AWSRequest ModifyUsageLimit Source #
Instance details Defined in Amazonka.Redshift.ModifyUsageLimit Associated Types type AWSResponse ModifyUsageLimit # Methods request :: (Service -> Service) -> ModifyUsageLimit -> Request ModifyUsageLimit # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyUsageLimit -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyUsageLimit))) #
Generic ModifyUsageLimit Source #
Instance details Defined in Amazonka.Redshift.ModifyUsageLimit Associated Types type Rep ModifyUsageLimit :: Type -> Type # Methods from :: ModifyUsageLimit -> Rep ModifyUsageLimit x # to :: Rep ModifyUsageLimit x -> ModifyUsageLimit #
Read ModifyUsageLimit Source #
Instance details Defined in Amazonka.Redshift.ModifyUsageLimit Methods readsPrec :: Int -> ReadS ModifyUsageLimit # readList :: ReadS [ModifyUsageLimit] # readPrec :: ReadPrec ModifyUsageLimit # readListPrec :: ReadPrec [ModifyUsageLimit] #
Show ModifyUsageLimit Source #
Instance details Defined in Amazonka.Redshift.ModifyUsageLimit Methods showsPrec :: Int -> ModifyUsageLimit -> ShowS # show :: ModifyUsageLimit -> String # showList :: [ModifyUsageLimit] -> ShowS #
NFData ModifyUsageLimit Source #
Instance details Defined in Amazonka.Redshift.ModifyUsageLimit Methods rnf :: ModifyUsageLimit -> () #
Eq ModifyUsageLimit Source #
Instance details Defined in Amazonka.Redshift.ModifyUsageLimit Methods (==) :: ModifyUsageLimit -> ModifyUsageLimit -> Bool # (/=) :: ModifyUsageLimit -> ModifyUsageLimit -> Bool #
Hashable ModifyUsageLimit Source #
Instance details Defined in Amazonka.Redshift.ModifyUsageLimit Methods hashWithSalt :: Int -> ModifyUsageLimit -> Int # hash :: ModifyUsageLimit -> Int #
type AWSResponse ModifyUsageLimit Source #
Instance details Defined in Amazonka.Redshift.ModifyUsageLimit type AWSResponse ModifyUsageLimit = UsageLimit
type Rep ModifyUsageLimit Source #
Instance details Defined in Amazonka.Redshift.ModifyUsageLimit type Rep ModifyUsageLimit = D1 ('MetaData "ModifyUsageLimit" "Amazonka.Redshift.ModifyUsageLimit" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "ModifyUsageLimit'" 'PrefixI 'True) (S1 ('MetaSel ('Just "amount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "breachAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageLimitBreachAction)) :: S1 ('MetaSel ('Just "usageLimitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newModifyUsageLimit Source #

Arguments

:: Text	`ModifyUsageLimit`
-> ModifyUsageLimit

Create a value of ModifyUsageLimit 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:

ModifyUsageLimit, modifyUsageLimit_amount - The new limit amount. For more information about this parameter, see UsageLimit.

ModifyUsageLimit, modifyUsageLimit_breachAction - The new action that Amazon Redshift takes when the limit is reached. For more information about this parameter, see UsageLimit.

ModifyUsageLimit, modifyUsageLimit_usageLimitId - The identifier of the usage limit to modify.

Request Lenses

modifyUsageLimit_amount :: Lens' ModifyUsageLimit (Maybe Integer) Source #

The new limit amount. For more information about this parameter, see UsageLimit.

modifyUsageLimit_breachAction :: Lens' ModifyUsageLimit (Maybe UsageLimitBreachAction) Source #

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

modifyUsageLimit_usageLimitId :: Lens' ModifyUsageLimit Text Source #

The identifier of the usage limit to modify.

Destructuring the Response

data UsageLimit Source #

Describes a usage limit object for a cluster.

See: newUsageLimit smart constructor.

Constructors

UsageLimit'

Fields

amount :: Maybe Integer
The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).
breachAction :: Maybe UsageLimitBreachAction
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.
clusterIdentifier :: Maybe Text
The identifier of the cluster with a usage limit.
featureType :: Maybe UsageLimitFeatureType
The Amazon Redshift feature to which the limit applies.
limitType :: Maybe UsageLimitLimitType
The type of limit. Depending on the feature type, this can be based on a time duration or data size.
period :: Maybe UsageLimitPeriod
The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
tags :: Maybe [Tag]
A list of tag instances.
usageLimitId :: Maybe Text
The identifier of the usage limit.

Instances

Instances details

FromXML UsageLimit Source #
Instance details Defined in Amazonka.Redshift.Types.UsageLimit Methods parseXML :: [Node] -> Either String UsageLimit #
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 #
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 #
NFData UsageLimit Source #
Instance details Defined in Amazonka.Redshift.Types.UsageLimit Methods rnf :: UsageLimit -> () #
Eq UsageLimit Source #
Instance details Defined in Amazonka.Redshift.Types.UsageLimit Methods (==) :: UsageLimit -> UsageLimit -> Bool # (/=) :: UsageLimit -> UsageLimit -> Bool #
Hashable UsageLimit Source #
Instance details Defined in Amazonka.Redshift.Types.UsageLimit Methods hashWithSalt :: Int -> UsageLimit -> Int # hash :: UsageLimit -> Int #
type Rep UsageLimit Source #
Instance details Defined in Amazonka.Redshift.Types.UsageLimit type Rep UsageLimit = D1 ('MetaData "UsageLimit" "Amazonka.Redshift.Types.UsageLimit" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "UsageLimit'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "amount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "breachAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageLimitBreachAction))) :: (S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "featureType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageLimitFeatureType)))) :: ((S1 ('MetaSel ('Just "limitType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageLimitLimitType)) :: S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageLimitPeriod))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "usageLimitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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: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:clusterIdentifier:UsageLimit', usageLimit_clusterIdentifier - The identifier of the cluster with a usage limit.

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

$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:period:UsageLimit', usageLimit_period - The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

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

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

Response Lenses

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_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_clusterIdentifier :: Lens' UsageLimit (Maybe Text) Source #

The identifier of the cluster with a usage limit.

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

The Amazon Redshift feature to which the limit applies.

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_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_tags :: Lens' UsageLimit (Maybe [Tag]) Source #

A list of tag instances.

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

The identifier of the usage limit.