Package software.amazon.awscdk

Interface IPolicyValidationPluginBeta1.Jsii$Default

All Superinterfaces:

IPolicyValidationPluginBeta1, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IPolicyValidationPluginBeta1.Jsii$Proxy

Enclosing interface:

IPolicyValidationPluginBeta1

@Internal
public static interface IPolicyValidationPluginBeta1.Jsii$Default
extends IPolicyValidationPluginBeta1

Internal default implementation for IPolicyValidationPluginBeta1.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.IPolicyValidationPluginBeta1

IPolicyValidationPluginBeta1.Jsii$Default, IPolicyValidationPluginBeta1.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default String	getName()	The name of the plugin that will be displayed in the validation report.
default List<String>	getRuleIds()	The list of rule IDs that the plugin will evaluate.
default String	getVersion()	The version of the plugin, following the Semantic Versioning specification (see https://semver.org/).
default PolicyValidationPluginReportBeta1	validate(IPolicyValidationContextBeta1 context)	The method that will be called by the CDK framework to perform validations.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
default String getName()

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

Specified by:

getName in interface IPolicyValidationPluginBeta1

getRuleIds

@Stability(Stable)
@Nullable
default List<String> getRuleIds()

The list of rule IDs that the plugin will evaluate.

Used for analytics purposes.

Default: - No rule is reported

Specified by:

getRuleIds in interface IPolicyValidationPluginBeta1

getVersion

@Stability(Stable)
@Nullable
default String getVersion()

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.

Specified by:

getVersion in interface IPolicyValidationPluginBeta1

validate

@Stability(Stable)
@NotNull
default PolicyValidationPluginReportBeta1 validate(@NotNull
 IPolicyValidationContextBeta1 context)

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

Specified by:

validate in interface IPolicyValidationPluginBeta1

Parameters:

context - This parameter is required.