hook_version

Gets an individual hook_version resource

Overview

Name	hook_version
Type	Resource
Description	hook_version
Id	awscc.cloudformation.hook_version

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the type, here the HookVersion. This is used to uniquely identify a HookVersion resource
type_arn	string	The Amazon Resource Name (ARN) of the type without the versionID.
execution_role_arn	string	The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
is_default_version	boolean	Indicates if this type version is the current default version
logging_config	object	Specifies logging configuration information for a type.
schema_handler_package	string	A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.<br/><br/>For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.
type_name	string	The name of the type being registered.<br/><br/>We recommend that type names adhere to the following pattern: company_or_organization::service::type.
version_id	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.<br/><br/>Valid values include:<br/><br/>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.<br/><br/>PUBLIC: The type is publically visible and usable within any Amazon account.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
arn,
type_arn,
execution_role_arn,
is_default_version,
logging_config,
schema_handler_package,
type_name,
version_id,
visibility
FROM awscc.cloudformation.hook_version
WHERE data__Identifier = '<Arn>';

Permissions

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

Read

cloudformation:DescribeType

Delete

cloudformation:DeregisterType,
cloudformation:DescribeType