Interface CfnGuardHookProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnGuardHookProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-21T06:34:04.505Z")
@Stability(Stable)
public interface CfnGuardHookProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnGuardHook.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.cloudformation.*;
CfnGuardHookProps cfnGuardHookProps = CfnGuardHookProps.builder()
.alias("alias")
.executionRole("executionRole")
.failureMode("failureMode")
.hookStatus("hookStatus")
.ruleLocation(S3LocationProperty.builder()
.uri("uri")
// the properties below are optional
.versionId("versionId")
.build())
.targetOperations(List.of("targetOperations"))
// the properties below are optional
.logBucket("logBucket")
.options(OptionsProperty.builder()
.inputParams(S3LocationProperty.builder()
.uri("uri")
// the properties below are optional
.versionId("versionId")
.build())
.build())
.stackFilters(StackFiltersProperty.builder()
.filteringCriteria("filteringCriteria")
// the properties below are optional
.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"))
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnGuardHookPropsstatic final classAn implementation forCfnGuardHookProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnGuardHookProps.Builderbuilder()getAlias()The typename alias for the hook.IAM Role ARN.Attribute to specify CloudFormation behavior on hook failure.Attribute to specify which stacks this hook applies to or should get invoked for.default StringS3 Bucket where the guard validate report will be uploaded to.default ObjectS3 Source Location for the Guard files.default ObjectFilters to allow hooks to target specific stack attributes.default ObjectWhich operations should this Hook run against?Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAlias
The typename alias for the hook.- See Also:
-
getExecutionRole
IAM Role ARN.- See Also:
-
getFailureMode
Attribute to specify CloudFormation behavior on hook failure.Default: - "WARN"
- See Also:
-
getHookStatus
Attribute to specify which stacks this hook applies to or should get invoked for.Default: - "DISABLED"
- See Also:
-
getRuleLocation
S3 Source Location for the Guard files.- See Also:
-
getTargetOperations
Which operations should this Hook run against?Resource changes, stacks or change sets.
- See Also:
-
getLogBucket
S3 Bucket where the guard validate report will be uploaded to.- See Also:
-
getOptions
- See Also:
-
getStackFilters
Filters to allow hooks to target specific stack attributes.- See Also:
-
getTargetFilters
- See Also:
-
builder
- Returns:
- a
CfnGuardHookProps.BuilderofCfnGuardHookProps
-