Class CfnHookVersionProps

Properties for defining a CfnHookVersion.

Inheritance

object

CfnHookVersionProps

Implements

ICfnHookVersionProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnHookVersionProps : ICfnHookVersionProps

Syntax (vb)

Public Class CfnHookVersionProps Implements 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

Constructors

CfnHookVersionProps()

Properties for defining a CfnHookVersion.

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 containing the Hook project package that contains the necessary files for the Hook you want to register.
TypeName	The unique name for your hook.

Constructors

CfnHookVersionProps()

Properties for defining a CfnHookVersion.

public CfnHookVersionProps()

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

Properties

ExecutionRoleArn

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

public string? ExecutionRoleArn { get; set; }

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.

public object? LoggingConfig { get; set; }

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 containing the Hook project package that contains the necessary files for the Hook you want to register.

public string SchemaHandlerPackage { get; set; }

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.

public string TypeName { get; set; }

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

Implements

ICfnHookVersionProps