Package software.amazon.awscdk.cfnpropertymixins.services.cloudformation

Class CfnGuardHookPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.cloudformation.CfnGuardHookPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.934Z")
@Stability(Stable)
public class CfnGuardHookPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::CloudFormation::GuardHook resource creates and activates a Guard Hook.

Using the Guard domain specific language (DSL), you can author Guard Hooks to evaluate your resources before allowing stack operations.

For more information, see Guard Hooks in the CloudFormation Hooks User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cloudformation.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnGuardHookPropsMixin cfnGuardHookPropsMixin = CfnGuardHookPropsMixin.Builder.create(CfnGuardHookMixinProps.builder()
         .alias("alias")
         .executionRole("executionRole")
         .failureMode("failureMode")
         .hookStatus("hookStatus")
         .logBucket("logBucket")
         .options(OptionsProperty.builder()
                 .inputParams(S3LocationProperty.builder()
                         .uri("uri")
                         .versionId("versionId")
                         .build())
                 .build())
         .ruleLocation(S3LocationProperty.builder()
                 .uri("uri")
                 .versionId("versionId")
                 .build())
         .stackFilters(StackFiltersProperty.builder()
                 .filteringCriteria("filteringCriteria")
                 .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())
         .targetFilters(TargetFiltersProperty.builder()
                 .actions(List.of("actions"))
                 .invocationPoints(List.of("invocationPoints"))
                 .targetNames(List.of("targetNames"))
                 .targets(List.of(HookTargetProperty.builder()
                         .action("action")
                         .invocationPoint("invocationPoint")
                         .targetName("targetName")
                         .build()))
                 .build())
         .targetOperations(List.of("targetOperations"))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnGuardHookPropsMixin.Builder	A fluent builder for CfnGuardHookPropsMixin.
static interface	CfnGuardHookPropsMixin.HookTargetProperty	Hook targets are the destination where hooks will be invoked against.
static interface	CfnGuardHookPropsMixin.OptionsProperty	Specifies the input parameters for a Guard Hook.
static interface	CfnGuardHookPropsMixin.S3LocationProperty	Specifies the S3 location where your Guard rules or input parameters are located.
static interface	CfnGuardHookPropsMixin.StackFiltersProperty	The StackFilters property type specifies stack level filters for a Hook.
static interface	CfnGuardHookPropsMixin.StackNamesProperty	Specifies the stack names for the StackFilters property type to include or exclude specific stacks from Hook invocations.
static interface	CfnGuardHookPropsMixin.StackRolesProperty	Specifies the stack roles for the StackFilters property type to include or exclude specific stacks from Hook invocations based on their associated IAM roles.
static interface	CfnGuardHookPropsMixin.TargetFiltersProperty	The TargetFilters property type specifies the target filters for the Hook.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnGuardHookPropsMixin(CfnGuardHookMixinProps props)	Create a mixin to apply properties to AWS::CloudFormation::GuardHook.
	CfnGuardHookPropsMixin(CfnGuardHookMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::CloudFormation::GuardHook.
protected	CfnGuardHookPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGuardHookPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnGuardHookMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnGuardHookPropsMixin

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

CfnGuardHookPropsMixin

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

CfnGuardHookPropsMixin

@Stability(Stable)
public CfnGuardHookPropsMixin(@NotNull
 CfnGuardHookMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::CloudFormation::GuardHook.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnGuardHookPropsMixin

@Stability(Stable)
public CfnGuardHookPropsMixin(@NotNull
 CfnGuardHookMixinProps props)

Create a mixin to apply properties to AWS::CloudFormation::GuardHook.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnGuardHookMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()