Package software.amazon.awscdk.cfnpropertymixins.services.cloudformation

Interface CfnHookVersionMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnHookVersionMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.940Z")
@Stability(Stable)
public interface CfnHookVersionMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnHookVersionPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cloudformation.*;
 CfnHookVersionMixinProps cfnHookVersionMixinProps = CfnHookVersionMixinProps.builder()
         .executionRoleArn("executionRoleArn")
         .loggingConfig(LoggingConfigProperty.builder()
                 .logGroupName("logGroupName")
                 .logRoleArn("logRoleArn")
                 .build())
         .schemaHandlerPackage("schemaHandlerPackage")
         .typeName("typeName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnHookVersionMixinProps.Builder	A builder for CfnHookVersionMixinProps
static final class	CfnHookVersionMixinProps.Jsii$Proxy	An implementation for CfnHookVersionMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnHookVersionMixinProps.Builder	builder()
default String	getExecutionRoleArn()	The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission.
default Object	getLoggingConfig()	Contains logging configuration information for an extension.
default String	getSchemaHandlerPackage()	A URL to the Amazon S3 bucket for the Hook project package that contains the necessary files for the Hook you want to register.
default String	getTypeName()	The unique name for your Hook.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExecutionRoleArn

@Stability(Stable)
@Nullable
default String getExecutionRoleArn()

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

getLoggingConfig

@Stability(Stable)
@Nullable
default Object getLoggingConfig()

Contains logging configuration information for an extension.

Returns union: either IResolvable or CfnHookVersionPropsMixin.LoggingConfigProperty

See Also:

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

getSchemaHandlerPackage

@Stability(Stable)
@Nullable
default String getSchemaHandlerPackage()

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

getTypeName

@Stability(Stable)
@Nullable
default String getTypeName()

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

builder

@Stability(Stable)
static CfnHookVersionMixinProps.Builder builder()

Returns:

a CfnHookVersionMixinProps.Builder of CfnHookVersionMixinProps