Module: AWSCDK::IPolicyValidationPluginBeta1 Deprecated

Defined in:
i_policy_validation_plugin_beta1.rb

Overview

Deprecated.

Use IPolicyValidationPlugin instead.

Represents a validation plugin that will be executed during synthesis.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



46
47
48
49
50
51
52
53
 
# File 'i_policy_validation_plugin_beta1.rb', line 46

def self.jsii_overridable_methods
  {
    :name => { kind: :property, name: "name", is_optional: false },
    :rule_ids => { kind: :property, name: "ruleIds", is_optional: true },
    :version => { kind: :property, name: "version", is_optional: true },
    :validate => { kind: :method, name: "validate", is_optional: false },
  }
end

Instance Method Details

#name ⇒ String

The name of the plugin that will be displayed in the validation report.

Returns:

  • (String) 


12
13
14
 
# File 'i_policy_validation_plugin_beta1.rb', line 12

def name()
  jsii_get_property("name")
end

#rule_ids ⇒ Array<String>?

Note:

Default: - No rule is reported

The list of rule IDs that the plugin will evaluate.

Used for analytics purposes.

Returns:

  • (Array<String>, nil) 


23
24
25
 
# File 'i_policy_validation_plugin_beta1.rb', line 23

def rule_ids()
  jsii_get_property("ruleIds")
end

#validate(context) ⇒ AWSCDK::PolicyValidationPluginReportBeta1

The method that will be called by the CDK framework to perform validations.

This is where the plugin will evaluate the CloudFormation templates for compliance and report and violations

Parameters:

Returns:



41
42
43
44
 
# File 'i_policy_validation_plugin_beta1.rb', line 41

def validate(context)
  Jsii::Type.check_type(context, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5JUG9saWN5VmFsaWRhdGlvbkNvbnRleHRCZXRhMSJ9")), "context")
  jsii_call_method("validate", [context])
end

#version ⇒ String?

The version of the plugin, following the Semantic Versioning specification (see https://semver.org/). This version is used for analytics purposes, to measure the usage of different plugins and different versions. The value of this property should be kept in sync with the actual version of the software package. If the version is not provided or is not a valid semantic version, it will be reported as 0.0.0.

Returns:

  • (String, nil) 


30
31
32
 
# File 'i_policy_validation_plugin_beta1.rb', line 30

def version()
  jsii_get_property("version")
end