software.amazon.awscdk.core

Class Aspects

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Aspects

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:52.880Z")
public class Aspects
extends software.amazon.jsii.JsiiObject

Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis.

Example:

 import software.amazon.awscdk.core.*;
 import software.constructs.Construct;
 import software.constructs.IConstruct;
 public class MyAspect implements IAspect {
     public void visit(IConstruct node) {
         if (node instanceof CfnResource && node.getCfnResourceType() == "Foo::Bar") {
             this.error(node, "we do not want a Foo::Bar resource");
         }
     }
     public void error(IConstruct node, String message) {
         Annotations.of(node).addError(message);
     }
 }
 public class MyStack extends Stack {
     public MyStack(Construct scope, String id) {
         super(scope, id);
         Stack stack = new Stack();
         CfnResource.Builder.create(stack, "Foo")
                 .type("Foo::Bar")
                 .properties(Map.of(
                         "Fred", "Thud"))
                 .build();
         Aspects.of(stack).add(new MyAspect());
     }
 }
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Aspects(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Aspects(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	add(IAspect aspect) Adds an aspect to apply this scope before synthesis.
java.util.List<IAspect>	getAspects() The list of aspects which were directly applied on this scope.
static Aspects	of(IConstruct scope) Returns the `Aspects` object associated with a construct scope.

Methods inherited from class java.lang.Object

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

Constructor Detail

Aspects

protected Aspects(software.amazon.jsii.JsiiObjectRef objRef)

Aspects

protected Aspects(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

of

public static Aspects of(IConstruct scope)

Returns the `Aspects` object associated with a construct scope.

Parameters:

scope - The scope for which these aspects will apply. This parameter is required.

add

public void add(IAspect aspect)

Adds an aspect to apply this scope before synthesis.

Parameters:

aspect - The aspect to add. This parameter is required.

getAspects

public java.util.List<IAspect> getAspects()

The list of aspects which were directly applied on this scope.