amazonka-redshift-serverless-2.0: Amazon Redshift Serverless SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RedshiftServerLess.CreateUsageLimit

Description

Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.

Synopsis

Creating a Request

data CreateUsageLimit Source #

See: newCreateUsageLimit smart constructor.

Constructors

CreateUsageLimit' 

Fields

  • breachAction :: Maybe UsageLimitBreachAction

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

  • period :: Maybe UsageLimitPeriod

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

  • amount :: Integer

    The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.

  • resourceArn :: Text

    The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.

  • usageType :: UsageLimitUsageType

    The type of Amazon Redshift Serverless usage to create a usage limit for.

Instances

Instances details
ToJSON CreateUsageLimit Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

ToHeaders CreateUsageLimit Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

ToPath CreateUsageLimit Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

ToQuery CreateUsageLimit Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

AWSRequest CreateUsageLimit Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

Associated Types

type AWSResponse CreateUsageLimit #

Generic CreateUsageLimit Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

Associated Types

type Rep CreateUsageLimit :: Type -> Type #

Read CreateUsageLimit Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

Show CreateUsageLimit Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

NFData CreateUsageLimit Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

Methods

rnf :: CreateUsageLimit -> () #

Eq CreateUsageLimit Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

Hashable CreateUsageLimit Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

type AWSResponse CreateUsageLimit Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

type Rep CreateUsageLimit Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

type Rep CreateUsageLimit = D1 ('MetaData "CreateUsageLimit" "Amazonka.RedshiftServerLess.CreateUsageLimit" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "CreateUsageLimit'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "breachAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageLimitBreachAction)) :*: S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageLimitPeriod))) :*: (S1 ('MetaSel ('Just "amount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :*: (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "usageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UsageLimitUsageType)))))

newCreateUsageLimit Source #

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:

CreateUsageLimit, createUsageLimit_breachAction - The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.

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

CreateUsageLimit, createUsageLimit_amount - The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.

CreateUsageLimit, createUsageLimit_resourceArn - The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.

CreateUsageLimit, createUsageLimit_usageType - The type of Amazon Redshift Serverless usage to create a usage limit for.

Request Lenses

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

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

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_amount :: Lens' CreateUsageLimit Integer Source #

The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.

createUsageLimit_resourceArn :: Lens' CreateUsageLimit Text Source #

The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.

createUsageLimit_usageType :: Lens' CreateUsageLimit UsageLimitUsageType Source #

The type of Amazon Redshift Serverless usage to create a usage limit for.

Destructuring the Response

data CreateUsageLimitResponse Source #

See: newCreateUsageLimitResponse smart constructor.

Constructors

CreateUsageLimitResponse' 

Fields

Instances

Instances details
Generic CreateUsageLimitResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

Associated Types

type Rep CreateUsageLimitResponse :: Type -> Type #

Read CreateUsageLimitResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

Show CreateUsageLimitResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

NFData CreateUsageLimitResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

Eq CreateUsageLimitResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

type Rep CreateUsageLimitResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.CreateUsageLimit

type Rep CreateUsageLimitResponse = D1 ('MetaData "CreateUsageLimitResponse" "Amazonka.RedshiftServerLess.CreateUsageLimit" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "CreateUsageLimitResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "usageLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageLimit)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateUsageLimitResponse Source #

Create a value of CreateUsageLimitResponse 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:usageLimit:CreateUsageLimitResponse', createUsageLimitResponse_usageLimit - The returned usage limit object.

$sel:httpStatus:CreateUsageLimitResponse', createUsageLimitResponse_httpStatus - The response's http status code.

Response Lenses