Class: AWSCDK::PolicyValidationPluginReport

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
policy_validation_plugin_report.rb

Overview

The report emitted by the plugin after evaluation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(success:, violations:, metadata: nil, plugin_version: nil) ⇒ PolicyValidationPluginReport

Returns a new instance of PolicyValidationPluginReport.

Parameters:

  • success (Boolean) —

    Whether or not the report was successful.

  • violations (Array<AWSCDK::PolicyViolation>) —

    List of violations in the report.

  • metadata (Hash{String => String}, nil) (defaults to: nil) —

    Arbitrary information about the report.

  • plugin_version (String, nil) (defaults to: nil) —

    The version of the plugin that created the report.



11
12
13
14
15
16
17
18
19
20
 
# File 'policy_validation_plugin_report.rb', line 11

def initialize(success:, violations:, metadata: nil, plugin_version: nil)
  @success = success
  Jsii::Type.check_type(@success, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "success")
  @violations = violations.is_a?(Array) ? violations.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::PolicyViolation.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : violations
  Jsii::Type.check_type(@violations, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLlBvbGljeVZpb2xhdGlvbiJ9LCJraW5kIjoiYXJyYXkifX0=")), "violations")
  @metadata = metadata
  Jsii::Type.check_type(@metadata, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "metadata") unless @metadata.nil?
  @plugin_version = plugin_version
  Jsii::Type.check_type(@plugin_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pluginVersion") unless @plugin_version.nil?
end

Instance Attribute Details

#metadata ⇒ Hash{String => String}? (readonly)

Note:

Default: - no metadata

Arbitrary information about the report.

Returns:

  • (Hash{String => String}, nil) 


34
35
36
 
# File 'policy_validation_plugin_report.rb', line 34

def metadata
  @metadata
end

#plugin_version ⇒ String? (readonly)

Note:

Default: - no version

The version of the plugin that created the report.

Returns:

  • (String, nil) 


39
40
41
 
# File 'policy_validation_plugin_report.rb', line 39

def plugin_version
  @plugin_version
end

#success ⇒ Boolean (readonly)

Whether or not the report was successful.

Returns:

  • (Boolean) 


25
26
27
 
# File 'policy_validation_plugin_report.rb', line 25

def success
  @success
end

#violations ⇒ Array<AWSCDK::PolicyViolation> (readonly)

List of violations in the report.

Returns:



29
30
31
 
# File 'policy_validation_plugin_report.rb', line 29

def violations
  @violations
end

Class Method Details

.jsii_properties ⇒ Object 



41
42
43
44
45
46
47
48
 
# File 'policy_validation_plugin_report.rb', line 41

def self.jsii_properties
  {
    :success => "success",
    :violations => "violations",
    :metadata => "metadata",
    :plugin_version => "pluginVersion",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



50
51
52
53
54
55
56
57
58
59
 
# File 'policy_validation_plugin_report.rb', line 50

def to_jsii
  result = {}
  result.merge!({
    "success" => @success,
    "violations" => @violations,
    "metadata" => @metadata,
    "pluginVersion" => @plugin_version,
  })
  result.compact
end