Table of Contents

Class CfnHookVersion

Namespace
Amazon.CDK
Assembly
Amazon.CDK.dll

A CloudFormation AWS::CloudFormation::HookVersion.

public class CfnHookVersion : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Inheritance
CfnHookVersion
Implements
IConstruct
Inherited Members

Examples

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

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

Remarks

The HookVersion resource publishes new or first hook version to the AWS CloudFormation registry.

CloudformationResource: AWS::CloudFormation::HookVersion

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

ExampleMetadata: fixture=_generated

Constructors

CfnHookVersion(Construct, string, ICfnHookVersionProps)

Create a new AWS::CloudFormation::HookVersion.

public CfnHookVersion(Construct scope, string id, ICfnHookVersionProps props)

Parameters

scope Construct
  • scope in which this resource is defined.
id string
  • scoped id of the resource.
props ICfnHookVersionProps
  • resource properties.

Properties

AttrArn

The Amazon Resource Name (ARN) of the hook.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrIsDefaultVersion

Whether the specified hook version is set as the default version.

public virtual IResolvable AttrIsDefaultVersion { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: IsDefaultVersion

AttrTypeArn

The Amazon Resource Number (ARN) assigned to this version of the hook.

public virtual string AttrTypeArn { get; }

Property Value

string

Remarks

CloudformationAttribute: TypeArn

AttrVersionId

The ID of this version of the hook.

public virtual string AttrVersionId { get; }

Property Value

string

Remarks

CloudformationAttribute: VersionId

AttrVisibility

The scope at which the resource is visible and usable in CloudFormation operations.

public virtual string AttrVisibility { get; }

Property Value

string

Remarks

Valid values include:

    CloudformationAttribute: Visibility

    CFN_RESOURCE_TYPE_NAME

    The CloudFormation resource type name for this resource class.

    public static string CFN_RESOURCE_TYPE_NAME { get; }

    Property Value

    string

    CfnProperties 

    protected override IDictionary<string, object> CfnProperties { get; }

    Property Value

    IDictionary<string, object>

    ExecutionRoleArn

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

    public virtual string? ExecutionRoleArn { get; set; }

    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.

    public virtual object? LoggingConfig { get; set; }

    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.

    public virtual string SchemaHandlerPackage { get; set; }

    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.

    public virtual 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:

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

      Methods

      Inspect(TreeInspector)

      Examines the CloudFormation resource and discloses attributes.

      public virtual void Inspect(TreeInspector inspector)

      Parameters

      inspector TreeInspector
      • tree inspector to collect and process attributes.

      RenderProperties(IDictionary<string, object>) 

      protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

      Parameters

      props IDictionary<string, object>

      Returns

      IDictionary<string, object>