Amazonka.APIGateway.Types.DeploymentCanarySettings

Documentation

data DeploymentCanarySettings

The input configuration for a canary deployment.

See: newDeploymentCanarySettings smart constructor.

Constructors

DeploymentCanarySettings'

Fields

• percentTraffic :: Maybe Double

  The percentage (0.0-100.0) of traffic routed to the canary deployment.

• stageVariableOverrides :: Maybe (HashMap Text Text)

  A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. 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 release deployment uses the stage cache or not.

Instances

ToJSON DeploymentCanarySettings

Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings

Methods

toJSON :: DeploymentCanarySettings -> Value

toEncoding :: DeploymentCanarySettings -> Encoding

toJSONList :: [DeploymentCanarySettings] -> Value

toEncodingList :: [DeploymentCanarySettings] -> Encoding

Generic DeploymentCanarySettings

Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings

Associated Types

type Rep DeploymentCanarySettings :: Type -> Type

Methods

from :: DeploymentCanarySettings -> Rep DeploymentCanarySettings x

to :: Rep DeploymentCanarySettings x -> DeploymentCanarySettings

Read DeploymentCanarySettings

Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings

Methods

readsPrec :: Int -> ReadS DeploymentCanarySettings

readList :: ReadS [DeploymentCanarySettings]

readPrec :: ReadPrec DeploymentCanarySettings

readListPrec :: ReadPrec [DeploymentCanarySettings]

Show DeploymentCanarySettings

Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings

Methods

showsPrec :: Int -> DeploymentCanarySettings -> ShowS

show :: DeploymentCanarySettings -> String

showList :: [DeploymentCanarySettings] -> ShowS

NFData DeploymentCanarySettings

Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings

Methods

rnf :: DeploymentCanarySettings -> ()

Eq DeploymentCanarySettings

Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings

Methods

(==) :: DeploymentCanarySettings -> DeploymentCanarySettings -> Bool

(/=) :: DeploymentCanarySettings -> DeploymentCanarySettings -> Bool

Hashable DeploymentCanarySettings

Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings

Methods

hashWithSalt :: Int -> DeploymentCanarySettings -> Int

hash :: DeploymentCanarySettings -> Int

type Rep DeploymentCanarySettings

Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings

type Rep DeploymentCanarySettings = D1 ('MetaData "DeploymentCanarySettings" "Amazonka.APIGateway.Types.DeploymentCanarySettings" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeploymentCanarySettings'" 'PrefixI 'True) (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)))))

newDeploymentCanarySettings :: DeploymentCanarySettings

Create a value of DeploymentCanarySettings 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:percentTraffic:DeploymentCanarySettings', deploymentCanarySettings_percentTraffic - The percentage (0.0-100.0) of traffic routed to the canary deployment.

$sel:stageVariableOverrides:DeploymentCanarySettings', deploymentCanarySettings_stageVariableOverrides - A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.

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

deploymentCanarySettings_percentTraffic :: Lens' DeploymentCanarySettings (Maybe Double)

The percentage (0.0-100.0) of traffic routed to the canary deployment.

deploymentCanarySettings_stageVariableOverrides :: Lens' DeploymentCanarySettings (Maybe (HashMap Text Text))

A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.

deploymentCanarySettings_useStageCache :: Lens' DeploymentCanarySettings (Maybe Bool)

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