CfnHookVersionProps

All Known Implementing Classes:: CfnHookVersionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:55.186Z")
public interface CfnHookVersionProps

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();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnHookVersionProps.Builder` A builder for `CfnHookVersionProps`
`static class`	`CfnHookVersionProps.Jsii$Proxy` An implementation for `CfnHookVersionProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnHookVersionProps.Builder`	`builder()`
`default java.lang.String`	`getExecutionRoleArn()` The Amazon Resource Name (ARN) of the task execution role that grants the hook permission.
`default java.lang.Object`	`getLoggingConfig()` Contains logging configuration information for an extension.
`java.lang.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.
`java.lang.String`	`getTypeName()` The unique name for your hook.

- Method Detail
  - getSchemaHandlerPackage
```
java.lang.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
```
java.lang.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
```
default java.lang.String getExecutionRoleArn()
```
    The Amazon Resource Name (ARN) of the task execution role that grants the hook permission.
  - getLoggingConfig
```
default java.lang.Object getLoggingConfig()
```
    Contains logging configuration information for an extension.
  - builder
```
static CfnHookVersionProps.Builder builder()
```
    Returns:
    
    a CfnHookVersionProps.Builder of CfnHookVersionProps

Interface CfnHookVersionProps

Nested Class Summary

Method Summary

Method Detail

getSchemaHandlerPackage

getTypeName

getExecutionRoleArn

getLoggingConfig

builder