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

Class CfnGuardHookMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.cloudformation.CfnGuardHookMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGuardHookMixinProps>

Enclosing interface:

CfnGuardHookMixinProps

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

A builder for CfnGuardHookMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Sets the value of CfnGuardHookMixinProps.getAlias()

Parameters:

alias - The type name alias for the Hook. This alias must be unique per account and Region. 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 CfnGuardHookMixinProps.Builder executionRole(String executionRole)

Sets the value of CfnGuardHookMixinProps.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.

Returns:

this

failureMode

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

Sets the value of CfnGuardHookMixinProps.getFailureMode()

Parameters:

failureMode - Specifies how the Hook responds when rules fail their evaluation.

• 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 CfnGuardHookMixinProps.Builder hookStatus(String hookStatus)

Sets the value of CfnGuardHookMixinProps.getHookStatus()

Parameters:

hookStatus - Specifies if the Hook is ENABLED or DISABLED .

Returns:

this

logBucket

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

Sets the value of CfnGuardHookMixinProps.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 CfnGuardHookMixinProps.Builder options(IResolvable options)

Sets the value of CfnGuardHookMixinProps.getOptions()

Parameters:

options - Specifies the S3 location of your input parameters.

Returns:

this

options

@Stability(Stable)
public CfnGuardHookMixinProps.Builder options(CfnGuardHookPropsMixin.OptionsProperty options)

Sets the value of CfnGuardHookMixinProps.getOptions()

Parameters:

options - Specifies the S3 location of your input parameters.

Returns:

this

ruleLocation

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

Sets the value of CfnGuardHookMixinProps.getRuleLocation()

Parameters:

ruleLocation - Specifies the S3 location of your Guard rules.

Returns:

this

ruleLocation

@Stability(Stable)
public CfnGuardHookMixinProps.Builder ruleLocation(CfnGuardHookPropsMixin.S3LocationProperty ruleLocation)

Sets the value of CfnGuardHookMixinProps.getRuleLocation()

Parameters:

ruleLocation - Specifies the S3 location of your Guard rules.

Returns:

this

stackFilters

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

Sets the value of CfnGuardHookMixinProps.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 CfnGuardHookMixinProps.Builder stackFilters(CfnGuardHookPropsMixin.StackFiltersProperty stackFilters)

Sets the value of CfnGuardHookMixinProps.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 CfnGuardHookMixinProps.Builder targetFilters(IResolvable targetFilters)

Sets the value of CfnGuardHookMixinProps.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 CfnGuardHookMixinProps.Builder targetFilters(CfnGuardHookPropsMixin.TargetFiltersProperty targetFilters)

Sets the value of CfnGuardHookMixinProps.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

targetOperations

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

Sets the value of CfnGuardHookMixinProps.getTargetOperations()

Parameters:

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

Valid values: STACK | RESOURCE | CHANGE_SET | CLOUD_CONTROL

Returns:

this

build

@Stability(Stable)
public CfnGuardHookMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnGuardHookMixinProps

Throws:

NullPointerException - if any required attribute was not provided