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.APIGateway.Types.UsagePlan

Description

Synopsis

data UsagePlan = UsagePlan' {
- apiStages :: Maybe [ApiStage]
- name :: Maybe Text
- id :: Maybe Text
- throttle :: Maybe ThrottleSettings
- quota :: Maybe QuotaSettings
- description :: Maybe Text
- productCode :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newUsagePlan :: UsagePlan
usagePlan_apiStages :: Lens' UsagePlan (Maybe [ApiStage])
usagePlan_name :: Lens' UsagePlan (Maybe Text)
usagePlan_id :: Lens' UsagePlan (Maybe Text)
usagePlan_throttle :: Lens' UsagePlan (Maybe ThrottleSettings)
usagePlan_quota :: Lens' UsagePlan (Maybe QuotaSettings)
usagePlan_description :: Lens' UsagePlan (Maybe Text)
usagePlan_productCode :: Lens' UsagePlan (Maybe Text)
usagePlan_tags :: Lens' UsagePlan (Maybe (HashMap Text Text))

Documentation

data UsagePlan Source #

Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.

In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.

Create and Use Usage Plans

See: newUsagePlan smart constructor.

Constructors

UsagePlan'

Fields

apiStages :: Maybe [ApiStage]
The associated API stages of a usage plan.
name :: Maybe Text
The name of a usage plan.
id :: Maybe Text
The identifier of a UsagePlan resource.
throttle :: Maybe ThrottleSettings
The request throttle limits of a usage plan.
quota :: Maybe QuotaSettings
The maximum number of permitted requests per a given unit time interval.
description :: Maybe Text
The description of a usage plan.
productCode :: Maybe Text
The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
tags :: Maybe (HashMap Text Text)
The collection of tags. Each tag element is associated with a given resource.

Instances

Instances details

Eq UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods (==) :: UsagePlan -> UsagePlan -> Bool # (/=) :: UsagePlan -> UsagePlan -> Bool #
Read UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods readsPrec :: Int -> ReadS UsagePlan # readList :: ReadS [UsagePlan] # readPrec :: ReadPrec UsagePlan # readListPrec :: ReadPrec [UsagePlan] #
Show UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods showsPrec :: Int -> UsagePlan -> ShowS # show :: UsagePlan -> String # showList :: [UsagePlan] -> ShowS #
Generic UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Associated Types type Rep UsagePlan :: Type -> Type # Methods from :: UsagePlan -> Rep UsagePlan x # to :: Rep UsagePlan x -> UsagePlan #
NFData UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods rnf :: UsagePlan -> () #
Hashable UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods hashWithSalt :: Int -> UsagePlan -> Int # hash :: UsagePlan -> Int #
FromJSON UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods parseJSON :: Value -> Parser UsagePlan # parseJSONList :: Value -> Parser [UsagePlan] #
type Rep UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan type Rep UsagePlan = D1 ('MetaData "UsagePlan" "Amazonka.APIGateway.Types.UsagePlan" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "UsagePlan'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApiStage])) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "throttle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThrottleSettings)))) :: ((S1 ('MetaSel ('Just "quota") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuotaSettings)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "productCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))

newUsagePlan :: UsagePlan Source #

Create a value of UsagePlan 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:apiStages:UsagePlan', usagePlan_apiStages - The associated API stages of a usage plan.

$sel:name:UsagePlan', usagePlan_name - The name of a usage plan.

$sel:id:UsagePlan', usagePlan_id - The identifier of a UsagePlan resource.

$sel:throttle:UsagePlan', usagePlan_throttle - The request throttle limits of a usage plan.

$sel:quota:UsagePlan', usagePlan_quota - The maximum number of permitted requests per a given unit time interval.

$sel:description:UsagePlan', usagePlan_description - The description of a usage plan.

$sel:productCode:UsagePlan', usagePlan_productCode - The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

$sel:tags:UsagePlan', usagePlan_tags - The collection of tags. Each tag element is associated with a given resource.

usagePlan_apiStages :: Lens' UsagePlan (Maybe [ApiStage]) Source #

The associated API stages of a usage plan.

usagePlan_name :: Lens' UsagePlan (Maybe Text) Source #

The name of a usage plan.

usagePlan_id :: Lens' UsagePlan (Maybe Text) Source #

The identifier of a UsagePlan resource.

usagePlan_throttle :: Lens' UsagePlan (Maybe ThrottleSettings) Source #

The request throttle limits of a usage plan.

usagePlan_quota :: Lens' UsagePlan (Maybe QuotaSettings) Source #

The maximum number of permitted requests per a given unit time interval.

usagePlan_description :: Lens' UsagePlan (Maybe Text) Source #

The description of a usage plan.

usagePlan_productCode :: Lens' UsagePlan (Maybe Text) Source #

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

usagePlan_tags :: Lens' UsagePlan (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.