Table of Contents

Interface ICfnHookVersionProps

Namespace
Amazon.CDK
Assembly
Amazon.CDK.dll

Properties for defining a CfnHookVersion.

public interface ICfnHookVersionProps

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             var cfnHookVersionProps = new CfnHookVersionProps {
                 SchemaHandlerPackage = "schemaHandlerPackage",
                 TypeName = "typeName",

                 // the properties below are optional
                 ExecutionRoleArn = "executionRoleArn",
                 LoggingConfig = new LoggingConfigProperty {
                     LogGroupName = "logGroupName",
                     LogRoleArn = "logRoleArn"
                 }
             };

Remarks

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

ExampleMetadata: fixture=_generated

Properties

ExecutionRoleArn

The Amazon Resource Name (ARN) of the task execution role that grants the hook permission.

string? ExecutionRoleArn { get; }

Property Value

string

Remarks

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

LoggingConfig

Contains logging configuration information for an extension.

object? LoggingConfig { get; }

Property Value

object

Remarks

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

SchemaHandlerPackage

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 SchemaHandlerPackage { get; }

Property Value

string

Remarks

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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> permissions for the schema handler package. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html">Actions, Resources, and Condition Keys for Amazon S3</a> in the <em>AWS Identity and Access Management User Guide</em> .

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

TypeName

The unique name for your hook.

string TypeName { get; }

Property Value

string

Remarks

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:

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