Package software.amazon.awscdk.cloudassembly.schema

Class SuppressedViolationJson.Builder

java.lang.Object

software.amazon.awscdk.cloudassembly.schema.SuppressedViolationJson.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SuppressedViolationJson>

Enclosing interface:

SuppressedViolationJson

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

A builder for SuppressedViolationJson

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SuppressedViolationJson.Builder	acknowledgedAt(String acknowledgedAt)	Sets the value of SuppressedViolationJson.getAcknowledgedAt()
SuppressedViolationJson.Builder	acknowledgedId(String acknowledgedId)	Sets the value of SuppressedViolationJson.getAcknowledgedId()
SuppressedViolationJson.Builder	acknowledgedStackTrace(String acknowledgedStackTrace)	Sets the value of SuppressedViolationJson.getAcknowledgedStackTrace()
SuppressedViolationJson	build()	Builds the configured instance.
SuppressedViolationJson.Builder	customSeverity(String customSeverity)	Sets the value of PolicyViolationJson.getCustomSeverity()
SuppressedViolationJson.Builder	description(String description)	Sets the value of PolicyViolationJson.getDescription()
SuppressedViolationJson.Builder	reason(String reason)	Sets the value of SuppressedViolationJson.getReason()
SuppressedViolationJson.Builder	ruleMetadata(Map<String,String> ruleMetadata)	Sets the value of PolicyViolationJson.getRuleMetadata()
SuppressedViolationJson.Builder	ruleName(String ruleName)	Sets the value of PolicyViolationJson.getRuleName()
SuppressedViolationJson.Builder	severity(String severity)	Sets the value of PolicyViolationJson.getSeverity()
SuppressedViolationJson.Builder	suggestedFix(String suggestedFix)	Sets the value of PolicyViolationJson.getSuggestedFix()
SuppressedViolationJson.Builder	violatingConstructs(List<? extends ViolatingConstructJson> violatingConstructs)	Sets the value of PolicyViolationJson.getViolatingConstructs()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

acknowledgedId

@Stability(Stable)
public SuppressedViolationJson.Builder acknowledgedId(String acknowledgedId)

Sets the value of SuppressedViolationJson.getAcknowledgedId()

Parameters:

acknowledgedId - The acknowledgement ID that caused this violation to be suppressed. This parameter is required. Format: <plugin-name>::<rule-name> (spaces replaced with hyphens).

Returns:

this

acknowledgedAt

@Stability(Stable)
public SuppressedViolationJson.Builder acknowledgedAt(String acknowledgedAt)

Sets the value of SuppressedViolationJson.getAcknowledgedAt()

Parameters:

acknowledgedAt - The construct path where the acknowledgement was declared.

Returns:

this

acknowledgedStackTrace

@Stability(Stable)
public SuppressedViolationJson.Builder acknowledgedStackTrace(String acknowledgedStackTrace)

Sets the value of SuppressedViolationJson.getAcknowledgedStackTrace()

Parameters:

acknowledgedStackTrace - Stack trace showing where the acknowledgement was declared. A \n-delimited string of stack frames.

Returns:

this

reason

@Stability(Stable)
public SuppressedViolationJson.Builder reason(String reason)

Sets the value of SuppressedViolationJson.getReason()

Parameters:

reason - The reason given for the acknowledgement, if provided.

Returns:

this

description

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

Sets the value of PolicyViolationJson.getDescription()

Parameters:

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

Returns:

this

ruleName

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

Sets the value of PolicyViolationJson.getRuleName()

Parameters:

ruleName - The name of the rule that was violated. This parameter is required. This may include a namespace: '<namespace>::<rule-name>'. If it does not, the plugin name will be used as the namespace.

The namespace must be included when acknowledging the violation.

Returns:

this

severity

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

Sets the value of PolicyViolationJson.getSeverity()

Parameters:

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

Returns:

this

violatingConstructs

@Stability(Stable)
public SuppressedViolationJson.Builder violatingConstructs(List<? extends ViolatingConstructJson> violatingConstructs)

Sets the value of PolicyViolationJson.getViolatingConstructs()

Parameters:

violatingConstructs - Constructs that violated the rule. This parameter is required.

Returns:

this

customSeverity

@Stability(Stable)
public SuppressedViolationJson.Builder customSeverity(String customSeverity)

Sets the value of PolicyViolationJson.getCustomSeverity()

Parameters:

customSeverity - If the plugin wants to report using a non-standard severity, put it here.

Returns:

this

ruleMetadata

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

Sets the value of PolicyViolationJson.getRuleMetadata()

Parameters:

ruleMetadata - Additional rule-specific metadata.

Returns:

this

suggestedFix

@Stability(Stable)
public SuppressedViolationJson.Builder suggestedFix(String suggestedFix)

Sets the value of PolicyViolationJson.getSuggestedFix()

Parameters:

suggestedFix - How to fix the violation.

Returns:

this

build

@Stability(Stable)
public SuppressedViolationJson build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SuppressedViolationJson

Throws:

NullPointerException - if any required attribute was not provided