CfnHookVersionProps Struct
Properties for defining a CfnHookVersion.
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
executionRoleArnoptionalstringexecution_role_arnoptionalstrexecutionRoleArnoptionalStringExecutionRoleArnoptionalstringExecutionRoleArnoptional*string#The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission.
loggingConfigoptionalIResolvable | CfnHookVersion.LoggingConfigPropertylogging_configoptionaltyping.Union[IResolvable, LoggingConfigProperty]loggingConfigoptionalIResolvableLoggingConfigoptionalIResolvableLoggingConfigoptionalinterface{}#Contains logging configuration information for an extension.
schemaHandlerPackagestringschema_handler_packagestrschemaHandlerPackageStringSchemaHandlerPackagestringSchemaHandlerPackage*stringrequired#A URL to the Amazon S3 bucket for the Hook project package that contains the necessary files for the Hook you want to register.
notes
For information on generating a schema handler package, see Modeling custom CloudFormation Hooks in the CloudFormation Hooks User Guide .
To register the Hook, you must have
s3:GetObjectpermissions to access the S3 objects.
The unique name for your Hook.
notes
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:
AlexaAMZNAmazonASKAWSCustomDev