interface CfnHookVersionProps
Language | Type name |
---|---|
![]() | Amazon.CDK.CfnHookVersionProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2#CfnHookVersionProps |
![]() | software.amazon.awscdk.CfnHookVersionProps |
![]() | aws_cdk.CfnHookVersionProps |
![]() | 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 |
---|---|---|
schema | 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. |
type | string | The unique name for your hook. |
execution | string | The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission. |
logging | IResolvable | Logging | 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, 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
|
Logging
(optional)
Contains logging configuration information for an extension.