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

Description

Documentation

data CanarySettings Source #

Configuration settings of a canary deployment.

See: newCanarySettings smart constructor.

Constructors

CanarySettings'

Fields

deploymentId :: Maybe Text
The ID of the canary deployment.
percentTraffic :: Maybe Double
The percent (0-100) of traffic diverted to a canary deployment.
stageVariableOverrides :: Maybe (HashMap Text Text)
Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
useStageCache :: Maybe Bool
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

Instances

Instances details

FromJSON CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Methods parseJSON :: Value -> Parser CanarySettings # parseJSONList :: Value -> Parser [CanarySettings] #
ToJSON CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Methods toJSON :: CanarySettings -> Value # toEncoding :: CanarySettings -> Encoding # toJSONList :: [CanarySettings] -> Value # toEncodingList :: [CanarySettings] -> Encoding #
Generic CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Associated Types type Rep CanarySettings :: Type -> Type # Methods from :: CanarySettings -> Rep CanarySettings x # to :: Rep CanarySettings x -> CanarySettings #
Read CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Methods readsPrec :: Int -> ReadS CanarySettings # readList :: ReadS [CanarySettings] # readPrec :: ReadPrec CanarySettings # readListPrec :: ReadPrec [CanarySettings] #
Show CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Methods showsPrec :: Int -> CanarySettings -> ShowS # show :: CanarySettings -> String # showList :: [CanarySettings] -> ShowS #
NFData CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Methods rnf :: CanarySettings -> () #
Eq CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Methods (==) :: CanarySettings -> CanarySettings -> Bool # (/=) :: CanarySettings -> CanarySettings -> Bool #
Hashable CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Methods hashWithSalt :: Int -> CanarySettings -> Int # hash :: CanarySettings -> Int #
type Rep CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings type Rep CanarySettings = D1 ('MetaData "CanarySettings" "Amazonka.APIGateway.Types.CanarySettings" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CanarySettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "percentTraffic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :: (S1 ('MetaSel ('Just "stageVariableOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "useStageCache") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newCanarySettings :: CanarySettings Source #

Create a value of CanarySettings 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:deploymentId:CanarySettings', canarySettings_deploymentId - The ID of the canary deployment.

$sel:percentTraffic:CanarySettings', canarySettings_percentTraffic - The percent (0-100) of traffic diverted to a canary deployment.

$sel:stageVariableOverrides:CanarySettings', canarySettings_stageVariableOverrides - Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

$sel:useStageCache:CanarySettings', canarySettings_useStageCache - A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

canarySettings_deploymentId :: Lens' CanarySettings (Maybe Text) Source #

The ID of the canary deployment.

canarySettings_percentTraffic :: Lens' CanarySettings (Maybe Double) Source #

The percent (0-100) of traffic diverted to a canary deployment.

canarySettings_stageVariableOverrides :: Lens' CanarySettings (Maybe (HashMap Text Text)) Source #

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

canarySettings_useStageCache :: Lens' CanarySettings (Maybe Bool) Source #

A Boolean flag to indicate whether the canary deployment uses the stage cache or not.