# CfnHookVersionProps

Properties for defining a `CfnHookVersion`.

Extends: CfnHookVersionProps
Used as props by: CfnHookVersion

- Source: Generated code
- Type last changed: v2.13.0 · 19 Feb 2022

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const cfnHookVersionProps: cdk.CfnHookVersionProps = {
  schemaHandlerPackage: 'schemaHandlerPackage',
  typeName: 'typeName',

  // the properties below are optional
  executionRoleArn: 'executionRoleArn',
  loggingConfig: {
    logGroupName: 'logGroupName',
    logRoleArn: 'logRoleArn',
  },
};
```

## Properties

- `executionRoleArn`: string — The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission.

- `loggingConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnHookVersion.LoggingConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.CfnHookVersion.LoggingConfigProperty.html) — Contains logging configuration information for an extension.

- `schemaHandlerPackage`: string (required) — 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.

- `typeName`: string (required) — 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`