Interface ICfnHookVersionProps

Properties for defining a CfnHookVersion.

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnHookVersionProps

Syntax (vb)

Public Interface ICfnHookVersionProps

Remarks

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

ExampleMetadata: fixture=_generated

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"
                 }
             };

Synopsis

Properties

ExecutionRoleArn	The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission.
LoggingConfig	Contains logging configuration information for an extension.
SchemaHandlerPackage	A URL to the Amazon S3 bucket for the Hook project package that contains the necessary files for the Hook you want to register.
TypeName	The unique name for your hook.

Properties

ExecutionRoleArn

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

string? ExecutionRoleArn { get; }

Property Value

string

Remarks

See: 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

See: 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 for 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, see Modeling custom CloudFormation Hooks in the AWS CloudFormation Hooks User Guide .

To register the Hook, you must have <code>s3:GetObject</code> permissions to access the S3 objects.

See: 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:

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