Class: AWSCDK::Greengrassv2::CfnDeployment::IoTJobExponentialRolloutRateProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
greengrassv2/cfn_deployment.rb

Overview

Contains information about an exponential rollout rate for a configuration deployment job.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_rate_per_minute:, increment_factor:, rate_increase_criteria:) ⇒ IoTJobExponentialRolloutRateProperty

Returns a new instance of IoTJobExponentialRolloutRateProperty.

Parameters:

  • base_rate_per_minute (Numeric) —

    The minimum number of devices that receive a pending job notification, per minute, when the job starts.

  • increment_factor (Numeric) —

    The exponential factor to increase the rollout rate for the job.

  • rate_increase_criteria (Object) —

    The criteria to increase the rollout rate for the job.



1157
1158
1159
1160
1161
1162
1163
1164
 
# File 'greengrassv2/cfn_deployment.rb', line 1157

def initialize(base_rate_per_minute:, increment_factor:, rate_increase_criteria:)
  @base_rate_per_minute = base_rate_per_minute
  Jsii::Type.check_type(@base_rate_per_minute, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "baseRatePerMinute")
  @increment_factor = increment_factor
  Jsii::Type.check_type(@increment_factor, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "incrementFactor")
  @rate_increase_criteria = rate_increase_criteria
  Jsii::Type.check_type(@rate_increase_criteria, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "rateIncreaseCriteria")
end

Instance Attribute Details

#base_rate_per_minute ⇒ Numeric (readonly)

The minimum number of devices that receive a pending job notification, per minute, when the job starts.

This parameter defines the initial rollout rate of the job.

Returns:

  • (Numeric)

See Also:



1172
1173
1174
 
# File 'greengrassv2/cfn_deployment.rb', line 1172

def base_rate_per_minute
  @base_rate_per_minute
end

#increment_factor ⇒ Numeric (readonly)

The exponential factor to increase the rollout rate for the job.

This parameter supports up to one digit after the decimal (for example, you can specify 1.5 , but not 1.55 ).

Returns:

  • (Numeric)

See Also:



1179
1180
1181
 
# File 'greengrassv2/cfn_deployment.rb', line 1179

def increment_factor
  @increment_factor
end

#rate_increase_criteria ⇒ Object (readonly)

The criteria to increase the rollout rate for the job.

Returns:

  • (Object)

See Also:



1184
1185
1186
 
# File 'greengrassv2/cfn_deployment.rb', line 1184

def rate_increase_criteria
  @rate_increase_criteria
end

Class Method Details

.jsii_properties ⇒ Object 



1186
1187
1188
1189
1190
1191
1192
 
# File 'greengrassv2/cfn_deployment.rb', line 1186

def self.jsii_properties
  {
    :base_rate_per_minute => "baseRatePerMinute",
    :increment_factor => "incrementFactor",
    :rate_increase_criteria => "rateIncreaseCriteria",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'greengrassv2/cfn_deployment.rb', line 1194

def to_jsii
  result = {}
  result.merge!({
    "baseRatePerMinute" => @base_rate_per_minute,
    "incrementFactor" => @increment_factor,
    "rateIncreaseCriteria" => @rate_increase_criteria,
  })
  result.compact
end