Class CfnHookVersionProps

Properties for defining a CfnHookVersion.

Inheritance

System.Object

CfnHookVersionProps

Implements

ICfnHookVersionProps

Namespace: Amazon.CDK

Assembly: Amazon.CDK.dll

Syntax (csharp)

public class CfnHookVersionProps : Object, ICfnHookVersionProps

Syntax (vb)

Public Class CfnHookVersionProps
    Inherits Object
    Implements ICfnHookVersionProps

Remarks

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

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

public CfnHookVersionProps()

Properties

ExecutionRoleArn

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

public string ExecutionRoleArn { get; set; }

Property Value

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

public object LoggingConfig { get; set; }

Property Value

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

public string SchemaHandlerPackage { get; set; }

Property Value

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

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.

public string TypeName { get; set; }

Property Value

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

Implements

ICfnHookVersionProps