interface StackFiltersProperty

Language	Type name
.NET	`Amazon.CDK.AWS.CloudFormation.CfnGuardHook.StackFiltersProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscloudformation#CfnGuardHook_StackFiltersProperty`
Java	`software.amazon.awscdk.services.cloudformation.CfnGuardHook.StackFiltersProperty`
Python	`aws_cdk.aws_cloudformation.CfnGuardHook.StackFiltersProperty`
TypeScript	`aws-cdk-lib` » `aws_cloudformation` » `CfnGuardHook` » `StackFiltersProperty`

The StackFilters property type specifies stack level filters for a Hook.

The StackNames or StackRoles properties are optional. However, you must specify at least one of these properties.

For more information, see AWS CloudFormation Hooks stack level filters .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudformation as cloudformation } from 'aws-cdk-lib';
const stackFiltersProperty: cloudformation.CfnGuardHook.StackFiltersProperty = {
  filteringCriteria: 'filteringCriteria',

  // the properties below are optional
  stackNames: {
    exclude: ['exclude'],
    include: ['include'],
  },
  stackRoles: {
    exclude: ['exclude'],
    include: ['include'],
  },
};

Properties

Name	Type	Description
filteringCriteria	`string`	The filtering criteria.
stackNames?	`IResolvable` `\|` `StackNamesProperty`	Includes or excludes specific stacks from Hook invocations.
stackRoles?	`IResolvable` `\|` `StackRolesProperty`	Includes or excludes specific stacks from Hook invocations based on their associated IAM roles.

filteringCriteria

Type: string

The filtering criteria.

All stack names and stack roles ( All ): The Hook will only be invoked when all specified filters match.
Any stack names and stack roles ( Any ): The Hook will be invoked if at least one of the specified filters match.

stackNames?

Type: IResolvable | StackNamesProperty (optional)

Includes or excludes specific stacks from Hook invocations.

stackRoles?

Type: IResolvable | StackRolesProperty (optional)

Includes or excludes specific stacks from Hook invocations based on their associated IAM roles.