Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cloudformation
  5. getGuardHook

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cloudformation.getGuardHook

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    This is a CloudFormation resource for activating the first-party AWS::Hooks::GuardHook.

    Using getGuardHook

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGuardHook(args: GetGuardHookArgs, opts?: InvokeOptions): Promise<GetGuardHookResult>
function getGuardHookOutput(args: GetGuardHookOutputArgs, opts?: InvokeOptions): Output<GetGuardHookResult>
    def get_guard_hook(hook_arn: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetGuardHookResult
def get_guard_hook_output(hook_arn: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetGuardHookResult]
    func LookupGuardHook(ctx *Context, args *LookupGuardHookArgs, opts ...InvokeOption) (*LookupGuardHookResult, error)
func LookupGuardHookOutput(ctx *Context, args *LookupGuardHookOutputArgs, opts ...InvokeOption) LookupGuardHookResultOutput

    > Note: This function is named LookupGuardHook in the Go SDK.

    public static class GetGuardHook 
{
    public static Task<GetGuardHookResult> InvokeAsync(GetGuardHookArgs args, InvokeOptions? opts = null)
    public static Output<GetGuardHookResult> Invoke(GetGuardHookInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGuardHookResult> getGuardHook(GetGuardHookArgs args, InvokeOptions options)
public static Output<GetGuardHookResult> getGuardHook(GetGuardHookArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:cloudformation:getGuardHook
  arguments:
    # arguments dictionary

    The following arguments are supported:

    HookArn string
    The Amazon Resource Name (ARN) of the activated hook
    HookArn string
    The Amazon Resource Name (ARN) of the activated hook
    hookArn String
    The Amazon Resource Name (ARN) of the activated hook
    hookArn string
    The Amazon Resource Name (ARN) of the activated hook
    hook_arn str
    The Amazon Resource Name (ARN) of the activated hook
    hookArn String
    The Amazon Resource Name (ARN) of the activated hook

    getGuardHook Result

    The following output properties are available:

    FailureMode Pulumi.AwsNative.CloudFormation.GuardHookFailureMode
    Attribute to specify CloudFormation behavior on hook failure.
    HookArn string
    The Amazon Resource Name (ARN) of the activated hook
    HookStatus Pulumi.AwsNative.CloudFormation.GuardHookHookStatus
    Attribute to specify which stacks this hook applies to or should get invoked for
    LogBucket string
    S3 Bucket where the guard validate report will be uploaded to
    Options Pulumi.AwsNative.CloudFormation.Outputs.OptionsProperties
    Specifies the S3 location of your input parameters.
    RuleLocation Pulumi.AwsNative.CloudFormation.Outputs.GuardHookS3Location
    Specifies the S3 location of your Guard rules.
    StackFilters Pulumi.AwsNative.CloudFormation.Outputs.StackFiltersProperties
    Filters to allow hooks to target specific stack attributes
    TargetFilters Pulumi.AwsNative.CloudFormation.Outputs.TargetFilters0Properties | Pulumi.AwsNative.CloudFormation.Outputs.TargetFilters1Properties
    Attribute to specify which targets should invoke the hook
    TargetOperations List<Pulumi.AwsNative.CloudFormation.GuardHookTargetOperation>
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    FailureMode GuardHookFailureMode
    Attribute to specify CloudFormation behavior on hook failure.
    HookArn string
    The Amazon Resource Name (ARN) of the activated hook
    HookStatus GuardHookHookStatus
    Attribute to specify which stacks this hook applies to or should get invoked for
    LogBucket string
    S3 Bucket where the guard validate report will be uploaded to
    Options OptionsProperties
    Specifies the S3 location of your input parameters.
    RuleLocation GuardHookS3Location
    Specifies the S3 location of your Guard rules.
    StackFilters StackFiltersProperties
    Filters to allow hooks to target specific stack attributes
    TargetFilters TargetFilters0Properties | TargetFilters1Properties
    Attribute to specify which targets should invoke the hook
    TargetOperations []GuardHookTargetOperation
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    failureMode GuardHookFailureMode
    Attribute to specify CloudFormation behavior on hook failure.
    hookArn String
    The Amazon Resource Name (ARN) of the activated hook
    hookStatus GuardHookHookStatus
    Attribute to specify which stacks this hook applies to or should get invoked for
    logBucket String
    S3 Bucket where the guard validate report will be uploaded to
    options OptionsProperties
    Specifies the S3 location of your input parameters.
    ruleLocation GuardHookS3Location
    Specifies the S3 location of your Guard rules.
    stackFilters StackFiltersProperties
    Filters to allow hooks to target specific stack attributes
    targetFilters TargetFilters0Properties | TargetFilters1Properties
    Attribute to specify which targets should invoke the hook
    targetOperations List<GuardHookTargetOperation>
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    failureMode GuardHookFailureMode
    Attribute to specify CloudFormation behavior on hook failure.
    hookArn string
    The Amazon Resource Name (ARN) of the activated hook
    hookStatus GuardHookHookStatus
    Attribute to specify which stacks this hook applies to or should get invoked for
    logBucket string
    S3 Bucket where the guard validate report will be uploaded to
    options OptionsProperties
    Specifies the S3 location of your input parameters.
    ruleLocation GuardHookS3Location
    Specifies the S3 location of your Guard rules.
    stackFilters StackFiltersProperties
    Filters to allow hooks to target specific stack attributes
    targetFilters TargetFilters0Properties | TargetFilters1Properties
    Attribute to specify which targets should invoke the hook
    targetOperations GuardHookTargetOperation[]
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    failure_mode GuardHookFailureMode
    Attribute to specify CloudFormation behavior on hook failure.
    hook_arn str
    The Amazon Resource Name (ARN) of the activated hook
    hook_status GuardHookHookStatus
    Attribute to specify which stacks this hook applies to or should get invoked for
    log_bucket str
    S3 Bucket where the guard validate report will be uploaded to
    options OptionsProperties
    Specifies the S3 location of your input parameters.
    rule_location GuardHookS3Location
    Specifies the S3 location of your Guard rules.
    stack_filters StackFiltersProperties
    Filters to allow hooks to target specific stack attributes
    target_filters TargetFilters0Properties | TargetFilters1Properties
    Attribute to specify which targets should invoke the hook
    target_operations Sequence[GuardHookTargetOperation]
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    failureMode "FAIL" | "WARN"
    Attribute to specify CloudFormation behavior on hook failure.
    hookArn String
    The Amazon Resource Name (ARN) of the activated hook
    hookStatus "ENABLED" | "DISABLED"
    Attribute to specify which stacks this hook applies to or should get invoked for
    logBucket String
    S3 Bucket where the guard validate report will be uploaded to
    options Property Map
    Specifies the S3 location of your input parameters.
    ruleLocation Property Map
    Specifies the S3 location of your Guard rules.
    stackFilters Property Map
    Filters to allow hooks to target specific stack attributes
    targetFilters Property Map | Property Map
    Attribute to specify which targets should invoke the hook
    targetOperations List<"RESOURCE" | "STACK" | "CHANGE_SET" | "CLOUD_CONTROL">
    Which operations should this Hook run against? Resource changes, stacks or change sets.

    Supporting Types

    GuardHookFailureMode

    GuardHookHookStatus

    GuardHookS3Location

    Uri string
    S3 uri of Guard files.
    VersionId string
    S3 object version
    Uri string
    S3 uri of Guard files.
    VersionId string
    S3 object version
    uri String
    S3 uri of Guard files.
    versionId String
    S3 object version
    uri string
    S3 uri of Guard files.
    versionId string
    S3 object version
    uri str
    S3 uri of Guard files.
    version_id str
    S3 object version
    uri String
    S3 uri of Guard files.
    versionId String
    S3 object version

    GuardHookTargetOperation

    LambdaHookAction

    LambdaHookHookTarget

    LambdaHookInvocationPoint

    LambdaHookStackFiltersPropertiesFilteringCriteria

    OptionsProperties

    InputParams Pulumi.AwsNative.CloudFormation.Inputs.GuardHookS3Location
    Specifies the S3 location where your input parameters are located.
    InputParams GuardHookS3Location
    Specifies the S3 location where your input parameters are located.
    inputParams GuardHookS3Location
    Specifies the S3 location where your input parameters are located.
    inputParams GuardHookS3Location
    Specifies the S3 location where your input parameters are located.
    input_params GuardHookS3Location
    Specifies the S3 location where your input parameters are located.
    inputParams Property Map
    Specifies the S3 location where your input parameters are located.

    StackFiltersProperties

    FilteringCriteria Pulumi.AwsNative.CloudFormation.LambdaHookStackFiltersPropertiesFilteringCriteria
    Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match
    StackNames Pulumi.AwsNative.CloudFormation.Inputs.StackFiltersPropertiesStackNamesProperties
    List of stack names as filters
    StackRoles Pulumi.AwsNative.CloudFormation.Inputs.StackFiltersPropertiesStackRolesProperties
    List of stack roles that are performing the stack operations.
    FilteringCriteria LambdaHookStackFiltersPropertiesFilteringCriteria
    Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match
    StackNames StackFiltersPropertiesStackNamesProperties
    List of stack names as filters
    StackRoles StackFiltersPropertiesStackRolesProperties
    List of stack roles that are performing the stack operations.
    filteringCriteria LambdaHookStackFiltersPropertiesFilteringCriteria
    Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match
    stackNames StackFiltersPropertiesStackNamesProperties
    List of stack names as filters
    stackRoles StackFiltersPropertiesStackRolesProperties
    List of stack roles that are performing the stack operations.
    filteringCriteria LambdaHookStackFiltersPropertiesFilteringCriteria
    Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match
    stackNames StackFiltersPropertiesStackNamesProperties
    List of stack names as filters
    stackRoles StackFiltersPropertiesStackRolesProperties
    List of stack roles that are performing the stack operations.
    filtering_criteria LambdaHookStackFiltersPropertiesFilteringCriteria
    Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match
    stack_names StackFiltersPropertiesStackNamesProperties
    List of stack names as filters
    stack_roles StackFiltersPropertiesStackRolesProperties
    List of stack roles that are performing the stack operations.
    filteringCriteria "ALL" | "ANY"
    Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match
    stackNames Property Map
    List of stack names as filters
    stackRoles Property Map
    List of stack roles that are performing the stack operations.

    StackFiltersPropertiesStackNamesProperties

    Exclude List<string>
    List of stack names that the hook is going to be excluded from
    Include List<string>
    List of stack names that the hook is going to target
    Exclude []string
    List of stack names that the hook is going to be excluded from
    Include []string
    List of stack names that the hook is going to target
    exclude List<String>
    List of stack names that the hook is going to be excluded from
    include List<String>
    List of stack names that the hook is going to target
    exclude string[]
    List of stack names that the hook is going to be excluded from
    include string[]
    List of stack names that the hook is going to target
    exclude Sequence[str]
    List of stack names that the hook is going to be excluded from
    include Sequence[str]
    List of stack names that the hook is going to target
    exclude List<String>
    List of stack names that the hook is going to be excluded from
    include List<String>
    List of stack names that the hook is going to target

    StackFiltersPropertiesStackRolesProperties

    Exclude List<string>
    List of stack roles that the hook is going to be excluded from
    Include List<string>
    List of stack roles that the hook is going to target
    Exclude []string
    List of stack roles that the hook is going to be excluded from
    Include []string
    List of stack roles that the hook is going to target
    exclude List<String>
    List of stack roles that the hook is going to be excluded from
    include List<String>
    List of stack roles that the hook is going to target
    exclude string[]
    List of stack roles that the hook is going to be excluded from
    include string[]
    List of stack roles that the hook is going to target
    exclude Sequence[str]
    List of stack roles that the hook is going to be excluded from
    include Sequence[str]
    List of stack roles that the hook is going to target
    exclude List<String>
    List of stack roles that the hook is going to be excluded from
    include List<String>
    List of stack roles that the hook is going to target

    TargetFilters0Properties

    Actions List<Pulumi.AwsNative.CloudFormation.LambdaHookAction>
    List of actions that the hook is going to target
    InvocationPoints List<Pulumi.AwsNative.CloudFormation.LambdaHookInvocationPoint>
    List of invocation points that the hook is going to target
    TargetNames List<string>
    List of type names that the hook is going to target
    Actions []LambdaHookAction
    List of actions that the hook is going to target
    InvocationPoints []LambdaHookInvocationPoint
    List of invocation points that the hook is going to target
    TargetNames []string
    List of type names that the hook is going to target
    actions List<LambdaHookAction>
    List of actions that the hook is going to target
    invocationPoints List<LambdaHookInvocationPoint>
    List of invocation points that the hook is going to target
    targetNames List<String>
    List of type names that the hook is going to target
    actions LambdaHookAction[]
    List of actions that the hook is going to target
    invocationPoints LambdaHookInvocationPoint[]
    List of invocation points that the hook is going to target
    targetNames string[]
    List of type names that the hook is going to target
    actions Sequence[LambdaHookAction]
    List of actions that the hook is going to target
    invocation_points Sequence[LambdaHookInvocationPoint]
    List of invocation points that the hook is going to target
    target_names Sequence[str]
    List of type names that the hook is going to target
    actions List<"CREATE" | "UPDATE" | "DELETE">
    List of actions that the hook is going to target
    invocationPoints List<"PRE_PROVISION">
    List of invocation points that the hook is going to target
    targetNames List<String>
    List of type names that the hook is going to target

    TargetFilters1Properties

    Targets []LambdaHookHookTarget
    List of hook targets
    targets LambdaHookHookTarget[]
    List of hook targets
    targets List<Property Map>
    List of hook targets

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native