Package software.amazon.awscdk.services.cloudformation

Interface CfnGuardHook.StackFiltersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGuardHook.StackFiltersProperty.Jsii$Proxy

Enclosing class:

CfnGuardHook

@Stability(Stable)
public static interface CfnGuardHook.StackFiltersProperty
extends software.amazon.jsii.JsiiSerializable

Filters to allow hooks to target specific stack attributes.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudformation.*;
 StackFiltersProperty stackFiltersProperty = StackFiltersProperty.builder()
         .filteringCriteria("filteringCriteria")
         // the properties below are optional
         .stackNames(StackNamesProperty.builder()
                 .exclude(List.of("exclude"))
                 .include(List.of("include"))
                 .build())
         .stackRoles(StackRolesProperty.builder()
                 .exclude(List.of("exclude"))
                 .include(List.of("include"))
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackfilters.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGuardHook.StackFiltersProperty.Builder	A builder for CfnGuardHook.StackFiltersProperty
static final class	CfnGuardHook.StackFiltersProperty.Jsii$Proxy	An implementation for CfnGuardHook.StackFiltersProperty

Method Summary

Modifier and Type	Method	Description
static CfnGuardHook.StackFiltersProperty.Builder	builder()
String	getFilteringCriteria()	Attribute to specify the filtering behavior.
default Object	getStackNames()	List of stack names as filters.
default Object	getStackRoles()	List of stack roles that are performing the stack operations.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFilteringCriteria

@Stability(Stable)
@NotNull
String getFilteringCriteria()

Attribute to specify the filtering behavior.

ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match

Default: - "ALL"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackfilters.html#cfn-cloudformation-guardhook-stackfilters-filteringcriteria

getStackNames

@Stability(Stable)
@Nullable
default Object getStackNames()

List of stack names as filters.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackfilters.html#cfn-cloudformation-guardhook-stackfilters-stacknames

getStackRoles

@Stability(Stable)
@Nullable
default Object getStackRoles()

List of stack roles that are performing the stack operations.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackfilters.html#cfn-cloudformation-guardhook-stackfilters-stackroles

builder

@Stability(Stable)
static CfnGuardHook.StackFiltersProperty.Builder builder()

Returns:

a CfnGuardHook.StackFiltersProperty.Builder of CfnGuardHook.StackFiltersProperty