Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Redshift.CreateUsageLimit

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.

Synopsis

data CreateUsageLimit = CreateUsageLimit' {
- period :: Maybe UsageLimitPeriod
- breachAction :: Maybe UsageLimitBreachAction
- tags :: Maybe [Tag]
- clusterIdentifier :: Text
- featureType :: UsageLimitFeatureType
- limitType :: UsageLimitLimitType
- amount :: Integer
}
newCreateUsageLimit :: Text -> UsageLimitFeatureType -> UsageLimitLimitType -> Integer -> CreateUsageLimit
createUsageLimit_period :: Lens' CreateUsageLimit (Maybe UsageLimitPeriod)
createUsageLimit_breachAction :: Lens' CreateUsageLimit (Maybe UsageLimitBreachAction)
createUsageLimit_tags :: Lens' CreateUsageLimit (Maybe [Tag])
createUsageLimit_clusterIdentifier :: Lens' CreateUsageLimit Text
createUsageLimit_featureType :: Lens' CreateUsageLimit UsageLimitFeatureType
createUsageLimit_limitType :: Lens' CreateUsageLimit UsageLimitLimitType
createUsageLimit_amount :: Lens' CreateUsageLimit Integer
data UsageLimit = UsageLimit' {
- amount :: Maybe Integer
- limitType :: Maybe UsageLimitLimitType
- usageLimitId :: Maybe Text
- period :: Maybe UsageLimitPeriod
- clusterIdentifier :: Maybe Text
- breachAction :: Maybe UsageLimitBreachAction
- featureType :: Maybe UsageLimitFeatureType
- tags :: Maybe [Tag]
}
newUsageLimit :: UsageLimit
usageLimit_amount :: Lens' UsageLimit (Maybe Integer)
usageLimit_limitType :: Lens' UsageLimit (Maybe UsageLimitLimitType)
usageLimit_usageLimitId :: Lens' UsageLimit (Maybe Text)
usageLimit_period :: Lens' UsageLimit (Maybe UsageLimitPeriod)
usageLimit_clusterIdentifier :: Lens' UsageLimit (Maybe Text)
usageLimit_breachAction :: Lens' UsageLimit (Maybe UsageLimitBreachAction)
usageLimit_featureType :: Lens' UsageLimit (Maybe UsageLimitFeatureType)
usageLimit_tags :: Lens' UsageLimit (Maybe [Tag])

Creating a Request

data CreateUsageLimit Source #

See: newCreateUsageLimit smart constructor.

Constructors

CreateUsageLimit'

Fields

period :: Maybe UsageLimitPeriod
The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
breachAction :: Maybe UsageLimitBreachAction
The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.
tags :: Maybe [Tag]
A list of tag instances.
clusterIdentifier :: Text
The identifier of the cluster that you want to limit usage.
featureType :: UsageLimitFeatureType
The Amazon Redshift feature that you want to limit.
limitType :: UsageLimitLimitType
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.
amount :: Integer
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.

Instances

Instances details

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

newCreateUsageLimit Source #

Arguments

:: Text	`$sel:clusterIdentifier:CreateUsageLimit'`
-> UsageLimitFeatureType	`$sel:featureType:CreateUsageLimit'`
-> UsageLimitLimitType	`$sel:limitType:CreateUsageLimit'`
-> Integer	`$sel:amount:CreateUsageLimit'`
-> CreateUsageLimit

Create a value of CreateUsageLimit 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:period:CreateUsageLimit', createUsageLimit_period - The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

$sel:breachAction:CreateUsageLimit', createUsageLimit_breachAction - The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.

$sel:tags:CreateUsageLimit', createUsageLimit_tags - A list of tag instances.

$sel:clusterIdentifier:CreateUsageLimit', createUsageLimit_clusterIdentifier - The identifier of the cluster that you want to limit usage.

$sel:featureType:CreateUsageLimit', createUsageLimit_featureType - The Amazon Redshift feature that you want to limit.

$sel:limitType:CreateUsageLimit', createUsageLimit_limitType - 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.

$sel:amount:CreateUsageLimit', createUsageLimit_amount - 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.

Request Lenses

createUsageLimit_period :: Lens' CreateUsageLimit (Maybe UsageLimitPeriod) Source #

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

createUsageLimit_breachAction :: Lens' CreateUsageLimit (Maybe UsageLimitBreachAction) Source #

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

createUsageLimit_tags :: Lens' CreateUsageLimit (Maybe [Tag]) Source #

A list of tag instances.

createUsageLimit_clusterIdentifier :: Lens' CreateUsageLimit Text Source #

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

createUsageLimit_featureType :: Lens' CreateUsageLimit UsageLimitFeatureType Source #

The Amazon Redshift feature that you want to limit.

createUsageLimit_limitType :: Lens' CreateUsageLimit UsageLimitLimitType Source #

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.

createUsageLimit_amount :: Lens' CreateUsageLimit Integer Source #

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.

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

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.

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