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 containing 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 containing the hook project package that contains the necessary files for the hook you want to register.

For information on generating a schema handler package for the resource you want to register, see submit in the CloudFormation CLI User Guide for Extension Development .

The user registering the resource must be able to access the package in the S3 bucket. That's, the user must have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide .

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.