interface CfnHookVersionMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CloudFormation.Mixins.CfnHookVersionMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscloudformation/mixins#CfnHookVersionMixinProps
Java	software.amazon.awscdk.mixins.preview.services.cloudformation.mixins.CfnHookVersionMixinProps
Python	aws_cdk.mixins_preview.aws_cloudformation.mixins.CfnHookVersionMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_cloudformation » mixins » CfnHookVersionMixinProps

Properties for CfnHookVersionPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as cloudformation_mixins } from '@aws-cdk/mixins-preview/aws-cloudformation';
const cfnHookVersionMixinProps: cloudformation_mixins.CfnHookVersionMixinProps = {
  executionRoleArn: 'executionRoleArn',
  loggingConfig: {
    logGroupName: 'logGroupName',
    logRoleArn: 'logRoleArn',
  },
  schemaHandlerPackage: 'schemaHandlerPackage',
  typeName: 'typeName',
};

Properties

Name	Type	Description
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?	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?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-executionrolearn

---

loggingConfig?

Type: IResolvable | LoggingConfigProperty (optional)

Contains logging configuration information for an extension.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-loggingconfig

---

schemaHandlerPackage?

Type: string (optional)

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 CloudFormation Hooks User Guide .

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-schemahandlerpackage

---

typeName?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-typename