amazonka-sagemaker-2.0: Amazon SageMaker Service 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.SageMaker.Types.TrafficRoutingConfig

Description

 
Synopsis

Documentation

data TrafficRoutingConfig Source #

Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.

See: newTrafficRoutingConfig smart constructor.

Constructors

TrafficRoutingConfig' 

Fields

  • canarySize :: Maybe CapacitySize

    Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than or equal to 50% of the variant's total instance count.

  • linearStepSize :: Maybe CapacitySize

    Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant's total instance count.

  • type' :: TrafficRoutingConfigType

    Traffic routing strategy type.

    • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.
    • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.
    • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.
  • waitIntervalInSeconds :: Natural

    The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.

Instances

Instances details
FromJSON TrafficRoutingConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TrafficRoutingConfig

ToJSON TrafficRoutingConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TrafficRoutingConfig

Generic TrafficRoutingConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TrafficRoutingConfig

Associated Types

type Rep TrafficRoutingConfig :: Type -> Type #

Read TrafficRoutingConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TrafficRoutingConfig

Show TrafficRoutingConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TrafficRoutingConfig

NFData TrafficRoutingConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TrafficRoutingConfig

Methods

rnf :: TrafficRoutingConfig -> () #

Eq TrafficRoutingConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TrafficRoutingConfig

Hashable TrafficRoutingConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TrafficRoutingConfig

type Rep TrafficRoutingConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TrafficRoutingConfig

type Rep TrafficRoutingConfig = D1 ('MetaData "TrafficRoutingConfig" "Amazonka.SageMaker.Types.TrafficRoutingConfig" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "TrafficRoutingConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "canarySize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CapacitySize)) :*: S1 ('MetaSel ('Just "linearStepSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CapacitySize))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TrafficRoutingConfigType) :*: S1 ('MetaSel ('Just "waitIntervalInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newTrafficRoutingConfig Source #

Create a value of TrafficRoutingConfig 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:canarySize:TrafficRoutingConfig', trafficRoutingConfig_canarySize - Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than or equal to 50% of the variant's total instance count.

$sel:linearStepSize:TrafficRoutingConfig', trafficRoutingConfig_linearStepSize - Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant's total instance count.

TrafficRoutingConfig, trafficRoutingConfig_type - Traffic routing strategy type.

  • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.
  • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.
  • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.

$sel:waitIntervalInSeconds:TrafficRoutingConfig', trafficRoutingConfig_waitIntervalInSeconds - The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.

trafficRoutingConfig_canarySize :: Lens' TrafficRoutingConfig (Maybe CapacitySize) Source #

Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than or equal to 50% of the variant's total instance count.

trafficRoutingConfig_linearStepSize :: Lens' TrafficRoutingConfig (Maybe CapacitySize) Source #

Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant's total instance count.

trafficRoutingConfig_type :: Lens' TrafficRoutingConfig TrafficRoutingConfigType Source #

Traffic routing strategy type.

  • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.
  • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.
  • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.

trafficRoutingConfig_waitIntervalInSeconds :: Lens' TrafficRoutingConfig Natural Source #

The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.