Package software.amazon.awscdk.services.cloudformation

Interface CfnHookVersionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnHookVersionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-02-06T22:15:50.729Z")
@Stability(Stable)
public interface CfnHookVersionProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.cloudformation.*;
 CfnHookVersionProps cfnHookVersionProps = CfnHookVersionProps.builder()
         .schemaHandlerPackage("schemaHandlerPackage")
         .typeName("typeName")
         // the properties below are optional
         .executionRoleArn("executionRoleArn")
         .loggingConfig(LoggingConfigProperty.builder()
                 .logGroupName("logGroupName")
                 .logRoleArn("logRoleArn")
                 .build())
         .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	CfnHookVersionProps.Builder	A builder for CfnHookVersionProps
static final class	CfnHookVersionProps.Jsii$Proxy	An implementation for CfnHookVersionProps

Method Summary

Modifier and Type	Method	Description
static CfnHookVersionProps.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.
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.
String	getTypeName()	The unique name for your hook.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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, 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.

See Also:

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

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

See Also:

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

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.

See Also:

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

builder

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

Returns:

a CfnHookVersionProps.Builder of CfnHookVersionProps