Class CfnHookVersion

A CloudFormation AWS::CloudFormation::HookVersion.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnHookVersion
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.CloudFormation
Assembly: Amazon.CDK.AWS.CloudFormation.dll
Syntax (csharp)
public class CfnHookVersion : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnHookVersion
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
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

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFormation;

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

Synopsis

Constructors

CfnHookVersion(Construct, String, ICfnHookVersionProps)

Create a new AWS::CloudFormation::HookVersion.
CfnHookVersion(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnHookVersion(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrArn

The Amazon Resource Name (ARN) of the hook.
AttrIsDefaultVersion

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

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

The ID of this version of the hook.
AttrVisibility

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

The CloudFormation resource type name for this resource class.
CfnProperties
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.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

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 System.String
  • scoped id of the resource.
props ICfnHookVersionProps
  • resource properties.

CfnHookVersion(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnHookVersion(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnHookVersion(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnHookVersion(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AttrArn

The Amazon Resource Name (ARN) of the hook.

public virtual string AttrArn { get; }
Property Value

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

System.String

Remarks

CloudformationAttribute: TypeArn

AttrVersionId

The ID of this version of the hook.

public virtual string AttrVersionId { get; }
Property Value

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

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

    System.String

    CfnProperties

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

    System.Collections.Generic.IDictionary<System.String, System.Object>

    Overrides

    ExecutionRoleArn

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

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

      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 System.Collections.Generic.IDictionary<System.String, System.Object>
      Returns

      System.Collections.Generic.IDictionary<System.String, System.Object>

      Overrides

      Implements

      Constructs.IConstruct