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 typename alias for the hook.
CfnGuardHook	build()
static CfnGuardHook.Builder	create(software.constructs.Construct scope, String id)
CfnGuardHook.Builder	executionRole(String executionRole)	IAM Role ARN.
CfnGuardHook.Builder	failureMode(String failureMode)	Attribute to specify CloudFormation behavior on hook failure.
CfnGuardHook.Builder	hookStatus(String hookStatus)	Attribute to specify which stacks this hook applies to or should get invoked for.
CfnGuardHook.Builder	logBucket(String logBucket)	S3 Bucket where the guard validate report will be uploaded to.
CfnGuardHook.Builder	options(IResolvable options)
CfnGuardHook.Builder	options(CfnGuardHook.OptionsProperty options)
CfnGuardHook.Builder	ruleLocation(IResolvable ruleLocation)	S3 Source Location for the Guard files.
CfnGuardHook.Builder	ruleLocation(CfnGuardHook.S3LocationProperty ruleLocation)	S3 Source Location for the Guard files.
CfnGuardHook.Builder	stackFilters(IResolvable stackFilters)	Filters to allow hooks to target specific stack attributes.
CfnGuardHook.Builder	stackFilters(CfnGuardHook.StackFiltersProperty stackFilters)	Filters to allow hooks to target specific stack attributes.
CfnGuardHook.Builder	targetFilters(IResolvable targetFilters)
CfnGuardHook.Builder	targetFilters(CfnGuardHook.TargetFiltersProperty targetFilters)
CfnGuardHook.Builder	targetOperations(List<String> targetOperations)	Which operations should this Hook 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 typename alias for the hook.

Parameters:

alias - The typename alias 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-alias

executionRole

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

IAM Role ARN.

Parameters:

executionRole - IAM Role ARN. 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)

Attribute to specify CloudFormation behavior on hook failure.

Default: - "WARN"

Parameters:

failureMode - Attribute to specify CloudFormation behavior on hook failure. 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)

Attribute to specify which stacks this hook applies to or should get invoked for.

Default: - "DISABLED"

Parameters:

hookStatus - Attribute to specify which stacks this hook applies to or should get invoked for. 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)

S3 Source Location for the Guard files.

Parameters:

ruleLocation - S3 Source Location for the Guard files. 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)

S3 Source Location for the Guard files.

Parameters:

ruleLocation - S3 Source Location for the Guard files. 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)

Which operations should this Hook run against?

Resource changes, stacks or change sets.

Parameters:

targetOperations - Which operations should this Hook 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)

S3 Bucket where the guard validate report will be uploaded to.

Parameters:

logBucket - S3 Bucket where the guard validate report will be uploaded to. 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)

Parameters:

options - 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)

Parameters:

options - 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)

Filters to allow hooks to target specific stack attributes.

Parameters:

stackFilters - Filters to allow hooks to target specific stack attributes. 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)

Filters to allow hooks to target specific stack attributes.

Parameters:

stackFilters - Filters to allow hooks to target specific stack attributes. 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)

Parameters:

targetFilters - 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)

Parameters:

targetFilters - 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.