AWS::CloudFormation::HookVersion

CloudFormation HookVersion

Publishes new or first hook version to AWS CloudFormation Registry.

Properties

4 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`SchemaHandlerPackage`	`string`	RequiredCreate-onlyWrite-only
`TypeName`	`string`	RequiredCreate-only
`ExecutionRoleArn`	`string`	Create-only
`LoggingConfig`	`LoggingConfig`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	The Amazon Resource Name (ARN) of the type, here the HookVersion. This is used to uniquely identify a HookVersion resource
`IsDefaultVersion`	`boolean`	Indicates if this type version is the current default version
`TypeArn`	`string`	The Amazon Resource Name (ARN) of the type without the versionID.
`VersionId`	`string`	The ID of the version of the type represented by this hook instance.
`Visibility`	`string`	The scope at which the type is visible and usable in CloudFormation operations. Valid values include: PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE. PUBLIC: The type is publically...

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::CloudFormation::HookVersion

Resources:
  MyResource:
    Type: AWS::CloudFormation::HookVersion
    Properties:
      SchemaHandlerPackage: "value"
      TypeName: "my-typename"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

cloudformation:DescribeTypecloudformation:DescribeTypeRegistrationcloudformation:RegisterTypeiam:PassRoles3:GetObjects3:ListBucketkms:Decrypt

read

cloudformation:DescribeType

delete

cloudformation:DeregisterTypecloudformation:DescribeType

list

cloudformation:ListTypescloudformation:ListTypeVersions

Get the CloudFormation Cheat Sheet

Everything you need to know about CloudFormation on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceCloudFormation

Properties9

Required2

TaggingNot supported

Primary IDArn

Supported Operations

CreateReadDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ExecutionRoleArnLoggingConfigSchemaHandlerPackageTypeName

Related Resources

External Links

AWS Documentation