Package software.amazon.awscdk

Class PolicyViolation.Builder

java.lang.Object

software.amazon.awscdk.PolicyViolation.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PolicyViolation>

Enclosing interface:

PolicyViolation

@Stability(Stable)
public static final class PolicyViolation.Builder
extends Object
implements software.amazon.jsii.Builder<PolicyViolation>

A builder for PolicyViolation

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PolicyViolation	build()	Builds the configured instance.
PolicyViolation.Builder	description(String description)	Sets the value of PolicyViolation.getDescription()
PolicyViolation.Builder	fix(String fix)	Sets the value of PolicyViolation.getFix()
PolicyViolation.Builder	ruleMetadata(Map<String,String> ruleMetadata)	Sets the value of PolicyViolation.getRuleMetadata()
PolicyViolation.Builder	ruleName(String ruleName)	Sets the value of PolicyViolation.getRuleName()
PolicyViolation.Builder	severity(String severity)	Sets the value of PolicyViolation.getSeverity()
PolicyViolation.Builder	violatingResources(List<? extends PolicyViolatingResource> violatingResources)	Sets the value of PolicyViolation.getViolatingResources()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

description

@Stability(Stable)
public PolicyViolation.Builder description(String description)

Sets the value of PolicyViolation.getDescription()

Parameters:

description - The description of the violation. This parameter is required.

Returns:

this

ruleName

@Stability(Stable)
public PolicyViolation.Builder ruleName(String ruleName)

Sets the value of PolicyViolation.getRuleName()

Parameters:

ruleName - The name of the rule. This parameter is required.

Returns:

this

violatingResources

@Stability(Stable)
public PolicyViolation.Builder violatingResources(List<? extends PolicyViolatingResource> violatingResources)

Sets the value of PolicyViolation.getViolatingResources()

Parameters:

violatingResources - The resources violating this rule. This parameter is required.

Returns:

this

fix

@Stability(Stable)
public PolicyViolation.Builder fix(String fix)

Sets the value of PolicyViolation.getFix()

Parameters:

fix - How to fix the violation.

Returns:

this

ruleMetadata

@Stability(Stable)
public PolicyViolation.Builder ruleMetadata(Map<String,String> ruleMetadata)

Sets the value of PolicyViolation.getRuleMetadata()

Parameters:

ruleMetadata - Additional metadata to include with the rule results. This can be used to provide additional information that is plugin specific. The data provided here will be rendered as is.

Returns:

this

severity

@Stability(Stable)
public PolicyViolation.Builder severity(String severity)

Sets the value of PolicyViolation.getSeverity()

Parameters:

severity - The severity of the violation, only used for reporting purposes. This is useful for helping the user discriminate between warnings, errors, information, etc.

Returns:

this

build

@Stability(Stable)
public PolicyViolation build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<PolicyViolation>

Returns:

a new instance of PolicyViolation

Throws:

NullPointerException - if any required attribute was not provided