Package software.amazon.awscdk

Class PolicyViolatingResource.Builder

java.lang.Object

software.amazon.awscdk.PolicyViolatingResource.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PolicyViolatingResource>

Enclosing interface:

PolicyViolatingResource

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

A builder for PolicyViolatingResource

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PolicyViolatingResource	build()	Builds the configured instance.
PolicyViolatingResource.Builder	constructPath(String constructPath)	Sets the value of PolicyViolatingResource.getConstructPath()
PolicyViolatingResource.Builder	locations(List<String> locations)	Sets the value of PolicyViolatingResource.getLocations()
PolicyViolatingResource.Builder	resourceLogicalId(String resourceLogicalId)	Sets the value of PolicyViolatingResource.getResourceLogicalId()
PolicyViolatingResource.Builder	templatePath(String templatePath)	Sets the value of PolicyViolatingResource.getTemplatePath()

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

locations

@Stability(Stable)
public PolicyViolatingResource.Builder locations(List<String> locations)

Sets the value of PolicyViolatingResource.getLocations()

Parameters:

locations - The locations in the CloudFormation template that pose the violations. This parameter is required.

Returns:

this

constructPath

@Stability(Stable)
public PolicyViolatingResource.Builder constructPath(String constructPath)

Sets the value of PolicyViolatingResource.getConstructPath()

Parameters:

constructPath - The construct path of the violating construct. Use this for violations that originate from constructs rather than CloudFormation resources (e.g. annotations added via Annotations.of() or Validations.of()). When provided, the report will use this path directly instead of deriving it from the resource logical ID. Mutually exclusive with resourceLogicalId.

Returns:

this

resourceLogicalId

@Stability(Stable)
public PolicyViolatingResource.Builder resourceLogicalId(String resourceLogicalId)

Sets the value of PolicyViolatingResource.getResourceLogicalId()

Parameters:

resourceLogicalId - The logical ID of the resource in the CloudFormation template. Required for plugin-sourced violations that operate on CloudFormation templates. Mutually exclusive with constructPath.

Returns:

this

templatePath

@Stability(Stable)
public PolicyViolatingResource.Builder templatePath(String templatePath)

Sets the value of PolicyViolatingResource.getTemplatePath()

Parameters:

templatePath - The path to the CloudFormation template that contains this resource.

Returns:

this

build

@Stability(Stable)
public PolicyViolatingResource build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of PolicyViolatingResource

Throws:

NullPointerException - if any required attribute was not provided