Package software.amazon.awscdk.services.cloudformation

Class CfnGuardHook.Builder

java.lang.Object

software.amazon.awscdk.services.cloudformation.CfnGuardHook.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGuardHook>

Enclosing class:

CfnGuardHook

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

A fluent builder for CfnGuardHook.

Method Summary

Modifier and Type	Method	Description
CfnGuardHook.Builder	alias(String alias)	The type name alias for the Hook.
CfnGuardHook	build()
static CfnGuardHook.Builder	create(software.constructs.Construct scope, String id)
CfnGuardHook.Builder	executionRole(String executionRole)	The IAM role that the Hook assumes to retrieve your Guard rules from S3 and optionally write a detailed Guard output report back.
CfnGuardHook.Builder	failureMode(String failureMode)	Specifies how the Hook responds when rules fail their evaluation.
CfnGuardHook.Builder	hookStatus(String hookStatus)	Specifies if the Hook is ENABLED or DISABLED .
CfnGuardHook.Builder	logBucket(String logBucket)	Specifies the name of an S3 bucket to store the Guard output report.
CfnGuardHook.Builder	options(IResolvable options)	Specifies the S3 location of your input parameters.
CfnGuardHook.Builder	options(CfnGuardHook.OptionsProperty options)	Specifies the S3 location of your input parameters.
CfnGuardHook.Builder	ruleLocation(IResolvable ruleLocation)	Specifies the S3 location of your Guard rules.
CfnGuardHook.Builder	ruleLocation(CfnGuardHook.S3LocationProperty ruleLocation)	Specifies the S3 location of your Guard rules.
CfnGuardHook.Builder	stackFilters(IResolvable stackFilters)	Specifies the stack level filters for the Hook.
CfnGuardHook.Builder	stackFilters(CfnGuardHook.StackFiltersProperty stackFilters)	Specifies the stack level filters for the Hook.
CfnGuardHook.Builder	targetFilters(IResolvable targetFilters)	Specifies the target filters for the Hook.
CfnGuardHook.Builder	targetFilters(CfnGuardHook.TargetFiltersProperty targetFilters)	Specifies the target filters for the Hook.
CfnGuardHook.Builder	targetOperations(List<String> targetOperations)	Specifies the list of operations the Hook is run against.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnGuardHook.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnGuardHook.Builder.

alias

@Stability(Stable)
public CfnGuardHook.Builder alias(String 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 .

Parameters:

alias - The type name alias for the Hook. This alias must be unique per account and Region. This parameter is required.

Returns:

this

See Also:

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

executionRole

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

The IAM role that the Hook assumes to retrieve your Guard rules from S3 and optionally write a detailed Guard output report back.

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

See Also:

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

failureMode

@Stability(Stable)
public CfnGuardHook.Builder failureMode(String 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.

Default: - "WARN"

Parameters:

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

Returns:

this

See Also:

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

hookStatus

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

Specifies if the Hook is ENABLED or DISABLED .

Default: - "DISABLED"

Parameters:

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

Returns:

this

See Also:

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

ruleLocation

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

Specifies the S3 location of your Guard rules.

Parameters:

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

Returns:

this

See Also:

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

ruleLocation

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

Specifies the S3 location of your Guard rules.

Parameters:

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

Returns:

this

See Also:

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

targetOperations

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

Specifies the list of operations the Hook is run against.

For more information, see Hook targets in the AWS CloudFormation Hooks User Guide .

Valid values: STACK | RESOURCE | CHANGE_SET | CLOUD_CONTROL

Parameters:

targetOperations - Specifies the list of operations the Hook is run against. This parameter is required.

Returns:

this

See Also:

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

logBucket

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

Specifies the name of an S3 bucket to store the Guard output report.

This report contains the results of your Guard rule validations.

Parameters:

logBucket - Specifies the name of an S3 bucket to store the Guard output report. This parameter is required.

Returns:

this

See Also:

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

options

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

Specifies the S3 location of your input parameters.

Parameters:

options - Specifies the S3 location of your input parameters. This parameter is required.

Returns:

this

See Also:

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

options

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

Specifies the S3 location of your input parameters.

Parameters:

options - Specifies the S3 location of your input parameters. This parameter is required.

Returns:

this

See Also:

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

stackFilters

@Stability(Stable)
public CfnGuardHook.Builder stackFilters(IResolvable 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

Parameters:

stackFilters - Specifies the stack level filters for the Hook. This parameter is required.

Returns:

this

See Also:

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

stackFilters

@Stability(Stable)
public CfnGuardHook.Builder stackFilters(CfnGuardHook.StackFiltersProperty 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

Parameters:

stackFilters - Specifies the stack level filters for the Hook. This parameter is required.

Returns:

this

See Also:

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

targetFilters

@Stability(Stable)
public CfnGuardHook.Builder targetFilters(IResolvable 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

Parameters:

targetFilters - Specifies the target filters for the Hook. This parameter is required.

Returns:

this

See Also:

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

targetFilters

@Stability(Stable)
public CfnGuardHook.Builder targetFilters(CfnGuardHook.TargetFiltersProperty 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

Parameters:

targetFilters - Specifies the target filters for the Hook. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnGuardHook build()

Specified by:

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

Returns:

a newly built instance of CfnGuardHook.