Skip to content
v2.277.0

AspectOptions Struct ​

Options when Applying an Aspect.

Example ​

ts
class MutatingAspect implements IAspect {
  visit(node: IConstruct) {
    // Modifies a resource in some way
  }
}

class ValidationAspect implements IAspect {
  visit(node: IConstruct) {
    // Perform some readonly validation on the cosntruct tree
  }
}

const stack = new Stack();

Aspects.of(stack).add(new MutatingAspect(), { priority: AspectPriority.MUTATING } );  // Run first (mutating aspects)
Aspects.of(stack).add(new ValidationAspect(), { priority: AspectPriority.READONLY } );  // Run later (readonly aspects)
python
@jsii.implements(IAspect)
class MutatingAspect:
    def visit(self, node):
        pass

@jsii.implements(IAspect)
class ValidationAspect:
    def visit(self, node):
        pass

stack = Stack()

Aspects.of(stack).add(MutatingAspect(), priority=AspectPriority.MUTATING) # Run first (mutating aspects)
Aspects.of(stack).add(ValidationAspect(), priority=AspectPriority.READONLY)
java
public class MutatingAspect implements IAspect {
    public void visit(IConstruct node) {
    }
}

public class ValidationAspect implements IAspect {
    public void visit(IConstruct node) {
    }
}

Stack stack = new Stack();

Aspects.of(stack).add(new MutatingAspect(), AspectOptions.builder().priority(AspectPriority.MUTATING).build()); // Run first (mutating aspects)
Aspects.of(stack).add(new ValidationAspect(), AspectOptions.builder().priority(AspectPriority.READONLY).build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
class MutatingAspect : IAspect
{
    public void Visit(IConstruct node)
    {
    }
}

class ValidationAspect : IAspect
{
    public void Visit(IConstruct node)
    {
    }
}

var stack = new Stack();

Aspects.Of(stack).Add(new MutatingAspect(), new AspectOptions { Priority = AspectPriority.MUTATING }); // Run first (mutating aspects)
Aspects.Of(stack).Add(new ValidationAspect(), new AspectOptions { Priority = AspectPriority.READONLY });
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
type mutatingAspect struct {
}

func (this *mutatingAspect) visit(node IConstruct) {}

type validationAspect struct {
}

func (this *validationAspect) visit(node IConstruct) {}

stack := awscdk.Newstack()

awscdk.Aspects_Of(stack).Add(newMutatingAspect(), &AspectOptions{
	Priority: awscdk.AspectPriority_MUTATING(),
}) // Run first (mutating aspects)
awscdk.Aspects_Of(stack).Add(newValidationAspect(), &AspectOptions{
	Priority: awscdk.AspectPriority_READONLY(),
})

Properties ​

priorityoptionalnumberpriorityoptionalint | floatpriorityoptionalNumberPriorityoptionaldoublePriorityoptional*float64 = AspectPriority.DEFAULT #
The priority value to apply on an Aspect. Priority must be a non-negative integer.

Aspects that have same priority value are not guaranteed to be executed in a consistent order.