Class: AWSCDK::Config::CfnRemediationConfiguration::SSMControlsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
config/cfn_remediation_configuration.rb

Overview

AWS Systems Manager (SSM) specific remediation controls.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(concurrent_execution_rate_percentage: nil, error_percentage: nil) ⇒ SSMControlsProperty

Returns a new instance of SSMControlsProperty.

Parameters:

  • concurrent_execution_rate_percentage (Numeric, nil) (defaults to: nil)

    The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule.

  • error_percentage (Numeric, nil) (defaults to: nil)

    The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule.



750
751
752
753
754
755
# File 'config/cfn_remediation_configuration.rb', line 750

def initialize(concurrent_execution_rate_percentage: nil, error_percentage: nil)
  @concurrent_execution_rate_percentage = concurrent_execution_rate_percentage
  Jsii::Type.check_type(@concurrent_execution_rate_percentage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "concurrentExecutionRatePercentage") unless @concurrent_execution_rate_percentage.nil?
  @error_percentage = error_percentage
  Jsii::Type.check_type(@error_percentage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "errorPercentage") unless @error_percentage.nil?
end

Instance Attribute Details

#concurrent_execution_rate_percentageNumeric? (readonly)

The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule.

You can specify a percentage, such as 10%. The default value is 10.



763
764
765
# File 'config/cfn_remediation_configuration.rb', line 763

def concurrent_execution_rate_percentage
  @concurrent_execution_rate_percentage
end

#error_percentageNumeric? (readonly)

The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule.

You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.



770
771
772
# File 'config/cfn_remediation_configuration.rb', line 770

def error_percentage
  @error_percentage
end

Class Method Details

.jsii_propertiesObject



772
773
774
775
776
777
# File 'config/cfn_remediation_configuration.rb', line 772

def self.jsii_properties
  {
    :concurrent_execution_rate_percentage => "concurrentExecutionRatePercentage",
    :error_percentage => "errorPercentage",
  }
end

Instance Method Details

#to_jsiiObject



779
780
781
782
783
784
785
786
# File 'config/cfn_remediation_configuration.rb', line 779

def to_jsii
  result = {}
  result.merge!({
    "concurrentExecutionRatePercentage" => @concurrent_execution_rate_percentage,
    "errorPercentage" => @error_percentage,
  })
  result.compact
end