Amazonka.IoT.Types.AwsJobExponentialRolloutRate

Documentation

data AwsJobExponentialRolloutRate

The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.

See: newAwsJobExponentialRolloutRate smart constructor.

Constructors

AwsJobExponentialRolloutRate'

Fields

• baseRatePerMinute :: Natural

  The minimum number of things that will be notified of a pending job, per minute, at the start of the job rollout. This is the initial rate of the rollout.

• incrementFactor :: Double

  The rate of increase for a job rollout. The number of things notified is multiplied by this factor.

• rateIncreaseCriteria :: AwsJobRateIncreaseCriteria

  The criteria to initiate the increase in rate of rollout for a job.

  Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

Instances

FromJSON AwsJobExponentialRolloutRate

Defined in Amazonka.IoT.Types.AwsJobExponentialRolloutRate

Methods

parseJSON :: Value -> Parser AwsJobExponentialRolloutRate

parseJSONList :: Value -> Parser [AwsJobExponentialRolloutRate]

ToJSON AwsJobExponentialRolloutRate

Defined in Amazonka.IoT.Types.AwsJobExponentialRolloutRate

Methods

toJSON :: AwsJobExponentialRolloutRate -> Value

toEncoding :: AwsJobExponentialRolloutRate -> Encoding

toJSONList :: [AwsJobExponentialRolloutRate] -> Value

toEncodingList :: [AwsJobExponentialRolloutRate] -> Encoding

Generic AwsJobExponentialRolloutRate

Defined in Amazonka.IoT.Types.AwsJobExponentialRolloutRate

Associated Types

type Rep AwsJobExponentialRolloutRate :: Type -> Type

Methods

from :: AwsJobExponentialRolloutRate -> Rep AwsJobExponentialRolloutRate x

to :: Rep AwsJobExponentialRolloutRate x -> AwsJobExponentialRolloutRate

Read AwsJobExponentialRolloutRate

Defined in Amazonka.IoT.Types.AwsJobExponentialRolloutRate

Methods

readsPrec :: Int -> ReadS AwsJobExponentialRolloutRate

readList :: ReadS [AwsJobExponentialRolloutRate]

readPrec :: ReadPrec AwsJobExponentialRolloutRate

readListPrec :: ReadPrec [AwsJobExponentialRolloutRate]

Show AwsJobExponentialRolloutRate

Defined in Amazonka.IoT.Types.AwsJobExponentialRolloutRate

Methods

showsPrec :: Int -> AwsJobExponentialRolloutRate -> ShowS

show :: AwsJobExponentialRolloutRate -> String

showList :: [AwsJobExponentialRolloutRate] -> ShowS

NFData AwsJobExponentialRolloutRate

Defined in Amazonka.IoT.Types.AwsJobExponentialRolloutRate

Methods

rnf :: AwsJobExponentialRolloutRate -> ()

Eq AwsJobExponentialRolloutRate

Defined in Amazonka.IoT.Types.AwsJobExponentialRolloutRate

Methods

(==) :: AwsJobExponentialRolloutRate -> AwsJobExponentialRolloutRate -> Bool

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

Hashable AwsJobExponentialRolloutRate

Defined in Amazonka.IoT.Types.AwsJobExponentialRolloutRate

Methods

hashWithSalt :: Int -> AwsJobExponentialRolloutRate -> Int

hash :: AwsJobExponentialRolloutRate -> Int

type Rep AwsJobExponentialRolloutRate

Defined in Amazonka.IoT.Types.AwsJobExponentialRolloutRate

type Rep AwsJobExponentialRolloutRate = D1 ('MetaData "AwsJobExponentialRolloutRate" "Amazonka.IoT.Types.AwsJobExponentialRolloutRate" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "AwsJobExponentialRolloutRate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "baseRatePerMinute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "incrementFactor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "rateIncreaseCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AwsJobRateIncreaseCriteria))))

newAwsJobExponentialRolloutRate

Arguments

:: Natural

$sel:baseRatePerMinute:AwsJobExponentialRolloutRate'

-> Double

$sel:incrementFactor:AwsJobExponentialRolloutRate'

-> AwsJobRateIncreaseCriteria

$sel:rateIncreaseCriteria:AwsJobExponentialRolloutRate'

-> AwsJobExponentialRolloutRate

Create a value of AwsJobExponentialRolloutRate 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:baseRatePerMinute:AwsJobExponentialRolloutRate', awsJobExponentialRolloutRate_baseRatePerMinute - The minimum number of things that will be notified of a pending job, per minute, at the start of the job rollout. This is the initial rate of the rollout.

$sel:incrementFactor:AwsJobExponentialRolloutRate', awsJobExponentialRolloutRate_incrementFactor - The rate of increase for a job rollout. The number of things notified is multiplied by this factor.

$sel:rateIncreaseCriteria:AwsJobExponentialRolloutRate', awsJobExponentialRolloutRate_rateIncreaseCriteria - The criteria to initiate the increase in rate of rollout for a job.

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

awsJobExponentialRolloutRate_baseRatePerMinute :: Lens' AwsJobExponentialRolloutRate Natural

The minimum number of things that will be notified of a pending job, per minute, at the start of the job rollout. This is the initial rate of the rollout.

awsJobExponentialRolloutRate_incrementFactor :: Lens' AwsJobExponentialRolloutRate Double

The rate of increase for a job rollout. The number of things notified is multiplied by this factor.

awsJobExponentialRolloutRate_rateIncreaseCriteria :: Lens' AwsJobExponentialRolloutRate AwsJobRateIncreaseCriteria

The criteria to initiate the increase in rate of rollout for a job.

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).