interface CfnHookVersionProps

Language	Type name
.NET	`Amazon.CDK.CfnHookVersionProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2#CfnHookVersionProps`
Java	`software.amazon.awscdk.CfnHookVersionProps`
Python	`aws_cdk.CfnHookVersionProps`
TypeScript	`aws-cdk-lib` » `CfnHookVersionProps`

Properties for defining a CfnHookVersion.

Example

// 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

Name	Type	Description
schemaHandlerPackage	`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.
typeName	`string`	The unique name for your Hook.
executionRoleArn?	`string`	The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission.
loggingConfig?	`IResolvable` `\|` `LoggingConfigProperty`	Contains logging configuration information for an extension.

schemaHandlerPackage

Type: 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 in the AWS CloudFormation Hooks User Guide .

To register the Hook, you must have s3:GetObject permissions to access the S3 objects.

typeName

Type: 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

executionRoleArn?

Type: string (optional)

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

loggingConfig?

Type: IResolvable | LoggingConfigProperty (optional)

Contains logging configuration information for an extension.