Package software.amazon.awscdk.services.cloudformation

Class CfnGuardHookProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudformation.CfnGuardHookProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGuardHookProps>

Enclosing interface:

CfnGuardHookProps

@Stability(Stable)
public static final class CfnGuardHookProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnGuardHookProps>

A builder for CfnGuardHookProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnGuardHookProps.Builder	alias(String alias)	Sets the value of CfnGuardHookProps.getAlias()
CfnGuardHookProps	build()	Builds the configured instance.
CfnGuardHookProps.Builder	executionRole(String executionRole)	Sets the value of CfnGuardHookProps.getExecutionRole()
CfnGuardHookProps.Builder	failureMode(String failureMode)	Sets the value of CfnGuardHookProps.getFailureMode()
CfnGuardHookProps.Builder	hookStatus(String hookStatus)	Sets the value of CfnGuardHookProps.getHookStatus()
CfnGuardHookProps.Builder	logBucket(String logBucket)	Sets the value of CfnGuardHookProps.getLogBucket()
CfnGuardHookProps.Builder	options(IResolvable options)	Sets the value of CfnGuardHookProps.getOptions()
CfnGuardHookProps.Builder	options(CfnGuardHook.OptionsProperty options)	Sets the value of CfnGuardHookProps.getOptions()
CfnGuardHookProps.Builder	ruleLocation(IResolvable ruleLocation)	Sets the value of CfnGuardHookProps.getRuleLocation()
CfnGuardHookProps.Builder	ruleLocation(CfnGuardHook.S3LocationProperty ruleLocation)	Sets the value of CfnGuardHookProps.getRuleLocation()
CfnGuardHookProps.Builder	stackFilters(IResolvable stackFilters)	Sets the value of CfnGuardHookProps.getStackFilters()
CfnGuardHookProps.Builder	stackFilters(CfnGuardHook.StackFiltersProperty stackFilters)	Sets the value of CfnGuardHookProps.getStackFilters()
CfnGuardHookProps.Builder	targetFilters(IResolvable targetFilters)	Sets the value of CfnGuardHookProps.getTargetFilters()
CfnGuardHookProps.Builder	targetFilters(CfnGuardHook.TargetFiltersProperty targetFilters)	Sets the value of CfnGuardHookProps.getTargetFilters()
CfnGuardHookProps.Builder	targetOperations(List<String> targetOperations)	Sets the value of CfnGuardHookProps.getTargetOperations()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

alias

@Stability(Stable)
public CfnGuardHookProps.Builder alias(String alias)

Sets the value of CfnGuardHookProps.getAlias()

Parameters:

alias - The type name alias for the Hook. This alias must be unique per account and Region. This parameter is required. The alias must be in the form Name1::Name2::Name3 and must not begin with AWS . For example, Private::Guard::MyTestHook .

Returns:

this

executionRole

@Stability(Stable)
public CfnGuardHookProps.Builder executionRole(String executionRole)

Sets the value of CfnGuardHookProps.getExecutionRole()

Parameters:

executionRole - The IAM role that the Hook assumes to retrieve your Guard rules from S3 and optionally write a detailed Guard output report back. This parameter is required.

Returns:

this

failureMode

@Stability(Stable)
public CfnGuardHookProps.Builder failureMode(String failureMode)

Sets the value of CfnGuardHookProps.getFailureMode()

Parameters:

failureMode - Specifies how the Hook responds when rules fail their evaluation. This parameter is required.

• FAIL : Prevents the action from proceeding. This is helpful for enforcing strict compliance or security policies.
• WARN : Issues warnings to users but allows actions to continue. This is useful for non-critical validations or informational checks.

Returns:

this

hookStatus

@Stability(Stable)
public CfnGuardHookProps.Builder hookStatus(String hookStatus)

Sets the value of CfnGuardHookProps.getHookStatus()

Parameters:

hookStatus - Specifies if the Hook is ENABLED or DISABLED . This parameter is required.

Returns:

this

ruleLocation

@Stability(Stable)
public CfnGuardHookProps.Builder ruleLocation(IResolvable ruleLocation)

Sets the value of CfnGuardHookProps.getRuleLocation()

Parameters:

ruleLocation - Specifies the S3 location of your Guard rules. This parameter is required.

Returns:

this

ruleLocation

@Stability(Stable)
public CfnGuardHookProps.Builder ruleLocation(CfnGuardHook.S3LocationProperty ruleLocation)

Sets the value of CfnGuardHookProps.getRuleLocation()

Parameters:

ruleLocation - Specifies the S3 location of your Guard rules. This parameter is required.

Returns:

this

targetOperations

@Stability(Stable)
public CfnGuardHookProps.Builder targetOperations(List<String> targetOperations)

Sets the value of CfnGuardHookProps.getTargetOperations()

Parameters:

targetOperations - Specifies the list of operations the Hook is run against. This parameter is required. For more information, see Hook targets in the AWS CloudFormation Hooks User Guide .

Valid values: STACK | RESOURCE | CHANGE_SET | CLOUD_CONTROL

Returns:

this

logBucket

@Stability(Stable)
public CfnGuardHookProps.Builder logBucket(String logBucket)

Sets the value of CfnGuardHookProps.getLogBucket()

Parameters:

logBucket - Specifies the name of an S3 bucket to store the Guard output report. This report contains the results of your Guard rule validations.

Returns:

this

options

@Stability(Stable)
public CfnGuardHookProps.Builder options(IResolvable options)

Sets the value of CfnGuardHookProps.getOptions()

Parameters:

options - Specifies the S3 location of your input parameters.

Returns:

this

options

@Stability(Stable)
public CfnGuardHookProps.Builder options(CfnGuardHook.OptionsProperty options)

Sets the value of CfnGuardHookProps.getOptions()

Parameters:

options - Specifies the S3 location of your input parameters.

Returns:

this

stackFilters

@Stability(Stable)
public CfnGuardHookProps.Builder stackFilters(IResolvable stackFilters)

Sets the value of CfnGuardHookProps.getStackFilters()

Parameters:

stackFilters - Specifies the stack level filters for the Hook. Example stack level filter in JSON:

"StackFilters": {"FilteringCriteria": "ALL", "StackNames": {"Exclude": [ "stack-1", "stack-2"]}}

Example stack level filter in YAML:

StackFilters: FilteringCriteria: ALL StackNames: Exclude: - stack-1 - stack-2

Returns:

this

stackFilters

@Stability(Stable)
public CfnGuardHookProps.Builder stackFilters(CfnGuardHook.StackFiltersProperty stackFilters)

Sets the value of CfnGuardHookProps.getStackFilters()

Parameters:

stackFilters - Specifies the stack level filters for the Hook. Example stack level filter in JSON:

"StackFilters": {"FilteringCriteria": "ALL", "StackNames": {"Exclude": [ "stack-1", "stack-2"]}}

Example stack level filter in YAML:

StackFilters: FilteringCriteria: ALL StackNames: Exclude: - stack-1 - stack-2

Returns:

this

targetFilters

@Stability(Stable)
public CfnGuardHookProps.Builder targetFilters(IResolvable targetFilters)

Sets the value of CfnGuardHookProps.getTargetFilters()

Parameters:

targetFilters - Specifies the target filters for the Hook. Example target filter in JSON:

"TargetFilters": {"Actions": [ "CREATE", "UPDATE", "DELETE" ]}

Example target filter in YAML:

TargetFilters: Actions: - CREATE - UPDATE - DELETE

Returns:

this

targetFilters

@Stability(Stable)
public CfnGuardHookProps.Builder targetFilters(CfnGuardHook.TargetFiltersProperty targetFilters)

Sets the value of CfnGuardHookProps.getTargetFilters()

Parameters:

targetFilters - Specifies the target filters for the Hook. Example target filter in JSON:

"TargetFilters": {"Actions": [ "CREATE", "UPDATE", "DELETE" ]}

Example target filter in YAML:

TargetFilters: Actions: - CREATE - UPDATE - DELETE

Returns:

this

build

@Stability(Stable)
public CfnGuardHookProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnGuardHookProps>

Returns:

a new instance of CfnGuardHookProps

Throws:

NullPointerException - if any required attribute was not provided