Interface CfnHookVersionProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:54.852Z") @Stability(Stable) public interface CfnHookVersionProps extends
Properties for defining a CfnHookVersion.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnHookVersionProps cfnHookVersionProps = CfnHookVersionProps.builder()
         // the properties below are optional
  • Method Details

    • getSchemaHandlerPackage

      @Stability(Stable) @NotNull String getSchemaHandlerPackage()
      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 for the resource you want to register, see submit in the CloudFormation CLI User Guide for Extension Development .

      The user registering the resource must be able to access the package in the S3 bucket. That's, the user must have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide .

    • getTypeName

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

    • getExecutionRoleArn

      @Stability(Stable) @Nullable default String getExecutionRoleArn()
      The Amazon Resource Name (ARN) of the task execution role that grants the hook permission.
    • getLoggingConfig

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

      @Stability(Stable) static CfnHookVersionProps.Builder builder()
      a CfnHookVersionProps.Builder of CfnHookVersionProps