AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::CloudFormation::HookVersion

CfnHookVersion

The `AWS::CloudFormation::HookVersion` resource publishes new or first version of a Hook to the CloudFormation registry. For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *CloudFormation User Guide* . This resource type is not compatible with Guard and Lambda Hooks.

Import

import { CfnHookVersion } from 'aws-cdk-lib/aws-cloudformation';

Or use the module namespace:

import * as cloudformation from 'aws-cdk-lib/aws-cloudformation';
// cloudformation.CfnHookVersion

Properties

Configuration passed to the constructor as CfnHookVersionProps.

schemaHandlerPackageRequired
string

A URL to the Amazon S3 bucket for the Hook project package that contains the necessary files for the Hook you want to register. For information on generating a schema handler package, see [Modeling custom CloudFormation Hooks](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-model.html) in the *CloudFormation Hooks User Guide* . > To register the Hook, you must have `s3:GetObject` permissions to access the S3 objects.

typeNameRequired
string

The unique name for your Hook. Specifies a three-part namespace for your Hook, with a recommended pattern of `Organization::Service::Hook` . > The following organization namespaces are reserved and can't be used in your Hook type names: > > - `Alexa` > - `AMZN` > - `Amazon` > - `ASK` > - `AWS` > - `Custom` > - `Dev`

executionRoleArnOptional
string

The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission.

loggingConfigOptional
IResolvable | LoggingConfigProperty

Contains logging configuration information for an extension.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::CloudFormation::HookVersionView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-cloudformation
CFN TypeAWS::CloudFormation::HookVersion
Properties4

Related Constructs

Explore This Service

External Links