guard_hooks

Creates, updates, deletes or gets a guard_hook resource or lists guard_hooks in a region

Overview

Name	guard_hooks
Type	Resource
Description	This is a CloudFormation resource for activating the first-party AWS::Hooks::GuardHook.
Id	awscc.cloudformation.guard_hooks

Fields

get (all properties)

Name	Datatype	Description
▶rule_location	object	S3 Source Location for the Guard files.
log_bucket	string	S3 Bucket where the guard validate report will be uploaded to
hook_status	string	Attribute to specify which stacks this hook applies to or should get invoked for
target_operations	array	Which operations should this Hook run against? Resource changes, stacks or change sets.
failure_mode	string	Attribute to specify CloudFormation behavior on hook failure.
target_filters	object	Attribute to specify which targets should invoke the hook
▶stack_filters	object	Filters to allow hooks to target specific stack attributes
alias	string	The typename alias for the hook.
hook_arn	string	The Amazon Resource Name (ARN) of the activated hook
execution_role	string	The execution role ARN assumed by hooks to read Guard rules from S3 and write Guard outputs to S3.
options	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
hook_arn	string	The Amazon Resource Name (ARN) of the activated hook
region	string	AWS region.

For more information, see AWS::CloudFormation::GuardHook.

Methods

Name	Resource	Accessible by	Required Params
create_resource	guard_hooks	INSERT	RuleLocation, HookStatus, TargetOperations, FailureMode, Alias, ExecutionRole, region
delete_resource	guard_hooks	DELETE	Identifier, region
update_resource	guard_hooks	UPDATE	Identifier, PatchDocument, region
list_resources	guard_hooks_list_only	SELECT	region
get_resource	guard_hooks	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual guard_hook.

SELECT
  region,
  rule_location,
  log_bucket,
  hook_status,
  target_operations,
  failure_mode,
  target_filters,
  stack_filters,
  alias,
  hook_arn,
  execution_role,
  options
FROM awscc.cloudformation.guard_hooks
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ hook_arn }}';

list (identifiers only)

Lists all guard_hooks in a region.

SELECT
  region,
  hook_arn
FROM awscc.cloudformation.guard_hooks_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new guard_hook resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.cloudformation.guard_hooks (
  RuleLocation,
  HookStatus,
  TargetOperations,
  FailureMode,
  Alias,
  ExecutionRole,
  region
)
SELECT
  '{{ rule_location }}',
  '{{ hook_status }}',
  '{{ target_operations }}',
  '{{ failure_mode }}',
  '{{ alias }}',
  '{{ execution_role }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.cloudformation.guard_hooks (
  RuleLocation,
  LogBucket,
  HookStatus,
  TargetOperations,
  FailureMode,
  TargetFilters,
  StackFilters,
  Alias,
  ExecutionRole,
  Options,
  region
)
SELECT
  '{{ rule_location }}',
  '{{ log_bucket }}',
  '{{ hook_status }}',
  '{{ target_operations }}',
  '{{ failure_mode }}',
  '{{ target_filters }}',
  '{{ stack_filters }}',
  '{{ alias }}',
  '{{ execution_role }}',
  '{{ options }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: guard_hook
  props:
    - name: rule_location
      value:
        uri: '{{ uri }}'
        version_id: '{{ version_id }}'
    - name: log_bucket
      value: '{{ log_bucket }}'
    - name: hook_status
      value: '{{ hook_status }}'
    - name: target_operations
      value:
        - '{{ target_operations[0] }}'
    - name: failure_mode
      value: '{{ failure_mode }}'
    - name: target_filters
      value: {}
    - name: stack_filters
      value:
        filtering_criteria: '{{ filtering_criteria }}'
        stack_names:
          include:
            - '{{ include[0] }}'
          exclude:
            - null
        stack_roles:
          include:
            - '{{ include[0] }}'
          exclude:
            - null
    - name: alias
      value: '{{ alias }}'
    - name: execution_role
      value: '{{ execution_role }}'
    - name: options
      value: null

UPDATE example

Use the following StackQL query and manifest file to update a guard_hook resource, using stack-deploy.

/*+ update */
UPDATE awscc.cloudformation.guard_hooks
SET PatchDocument = string('{{ {
    "RuleLocation": rule_location,
    "LogBucket": log_bucket,
    "HookStatus": hook_status,
    "TargetOperations": target_operations,
    "FailureMode": failure_mode,
    "TargetFilters": target_filters,
    "StackFilters": stack_filters,
    "Options": options
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ hook_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.cloudformation.guard_hooks
WHERE
  Identifier = '{{ hook_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the guard_hooks resource, the following permissions are required:

Create

cloudformation:ActivateType,
cloudformation:DescribeType,
cloudformation:ListTypes,
cloudformation:SetTypeConfiguration,
cloudformation:BatchDescribeTypeConfigurations,
iam:PassRole

Read

cloudformation:DescribeType,
cloudformation:BatchDescribeTypeConfigurations

Update

cloudformation:BatchDescribeTypeConfigurations,
cloudformation:DescribeType,
cloudformation:SetTypeConfiguration,
iam:PassRole

Delete

cloudformation:BatchDescribeTypeConfigurations,
cloudformation:DescribeType,
cloudformation:DeactivateType,
cloudformation:SetTypeConfiguration

List

cloudformation:ListTypes,
cloudformation:DescribeType,
cloudformation:BatchDescribeTypeConfigurations