Interface StackValidationArgs

StackValidationArgs is the argument bag passed to a stack validation.

interface StackValidationArgs {
    resources: PolicyResource[];
    stackTags: ReadonlyMap<string, string>;
    getConfig<T extends object>(): T;
    notApplicable(reason?: string): never;
}

Index

Properties

resources stackTags

Methods

getConfig notApplicable

Properties

resources

resources: PolicyResource[]

The resources in the stack.

stackTags

stackTags: ReadonlyMap<string, string>

Tags associated with the stack.

Methods

getConfig

getConfig<T extends object>(): T
Returns configuration for the policy.
Type Parameters
- T extends object
Returns T
- Defined in policy.ts:661

notApplicable

notApplicable(reason?: string): never
Marks the policy as not applicable.
Parameters
- Optionalreason: string
  An optional reason why the policy is not applicable.
Returns never
- Defined in policy.ts:668