Package software.amazon.awscdk

Class CfnHookVersion

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.CfnHookVersion
All Implemented Interfaces:
IHookVersionRef, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:30.858Z") @Stability(Stable) public class CfnHookVersion extends CfnResource implements IInspectable, IHookVersionRef
The AWS::CloudFormation::HookVersion resource publishes new or first version of a Hook to the CloudFormation registry.

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .

This resource type is not compatible with Guard and Lambda Hooks.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 CfnHookVersion cfnHookVersion = CfnHookVersion.Builder.create(this, "MyCfnHookVersion")
         .schemaHandlerPackage("schemaHandlerPackage")
         .typeName("typeName")
         // the properties below are optional
         .executionRoleArn("executionRoleArn")
         .loggingConfig(LoggingConfigProperty.builder()
                 .logGroupName("logGroupName")
                 .logRoleArn("logRoleArn")
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnHookVersion

      protected CfnHookVersion(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnHookVersion

      protected CfnHookVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnHookVersion

      @Stability(Stable) public CfnHookVersion(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnHookVersionProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the Hook.

    • getAttrIsDefaultVersion

      @Stability(Stable) @NotNull public IResolvable getAttrIsDefaultVersion()
      Whether the specified Hook version is set as the default version.

    • getAttrTypeArn

      @Stability(Stable) @NotNull public String getAttrTypeArn()
      The Amazon Resource Number (ARN) assigned to this version of the Hook.

    • getAttrVersionId

      @Stability(Stable) @NotNull public String getAttrVersionId()
      The ID of this version of the Hook.

    • getAttrVisibility

      @Stability(Stable) @NotNull public String getAttrVisibility()
      The visibility level that determines who can see and use this Hook in CloudFormation operations:.

      • PRIVATE : The Hook is only visible and usable within the account where it was registered. CloudFormation automatically marks any Hooks you register as PRIVATE .
      • PUBLIC : The Hook is publicly visible and usable within any AWS account.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getHookVersionRef

      @Stability(Stable) @NotNull public HookVersionReference getHookVersionRef()
      A reference to a HookVersion resource.
      Specified by:
      getHookVersionRef in interface IHookVersionRef

    • getSchemaHandlerPackage

      @Stability(Stable) @NotNull public 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.

    • setSchemaHandlerPackage

      @Stability(Stable) public void setSchemaHandlerPackage(@NotNull String value)
      A URL to the Amazon S3 bucket for the Hook project package that contains the necessary files for the Hook you want to register.

    • getTypeName

      @Stability(Stable) @NotNull public String getTypeName()
      The unique name for your Hook.

    • setTypeName

      @Stability(Stable) public void setTypeName(@NotNull String value)
      The unique name for your Hook.

    • getExecutionRoleArn

      @Stability(Stable) @Nullable public String getExecutionRoleArn()
      The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission.

    • setExecutionRoleArn

      @Stability(Stable) public void setExecutionRoleArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission.

    • getLoggingConfig

      @Stability(Stable) @Nullable public Object getLoggingConfig()
      Contains logging configuration information for an extension.

      Returns union: either IResolvable or CfnHookVersion.LoggingConfigProperty

    • setLoggingConfig

      @Stability(Stable) public void setLoggingConfig(@Nullable IResolvable value)
      Contains logging configuration information for an extension.

    • setLoggingConfig

      @Stability(Stable) public void setLoggingConfig(@Nullable CfnHookVersion.LoggingConfigProperty value)
      Contains logging configuration information for an extension.