Table of Contents

Class CfnHookTypeConfig

Namespace
Amazon.CDK
Assembly
Amazon.CDK.dll

A CloudFormation AWS::CloudFormation::HookTypeConfig.

public class CfnHookTypeConfig : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Inheritance
CfnHookTypeConfig
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 cfnHookTypeConfig = new CfnHookTypeConfig(this, "MyCfnHookTypeConfig", new CfnHookTypeConfigProps {
                 Configuration = "configuration",

                 // the properties below are optional
                 ConfigurationAlias = "configurationAlias",
                 TypeArn = "typeArn",
                 TypeName = "typeName"
             });

Remarks

The HookTypeConfig resource specifies the configuration of a hook.

CloudformationResource: AWS::CloudFormation::HookTypeConfig

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

ExampleMetadata: fixture=_generated

Constructors

CfnHookTypeConfig(Construct, string, ICfnHookTypeConfigProps)

Create a new AWS::CloudFormation::HookTypeConfig.

public CfnHookTypeConfig(Construct scope, string id, ICfnHookTypeConfigProps props)

Parameters

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

Properties

AttrConfigurationArn

The Amazon Resource Number (ARN) of the activated hook type configuration, in this account and Region.

public virtual string AttrConfigurationArn { get; }

Property Value

string

Remarks

CloudformationAttribute: ConfigurationArn

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>

Configuration

Specifies the activated hook type configuration, in this AWS account and AWS Region .

public virtual string Configuration { get; set; }

Property Value

string

Remarks

You must specify either TypeName and Configuration or TypeARN and Configuration .

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

ConfigurationAlias

Specifies the activated hook type configuration, in this AWS account and AWS Region .

public virtual string? ConfigurationAlias { get; set; }

Property Value

string

Remarks

Defaults to default alias. Hook types currently support default configuration alias.

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

TypeArn

The Amazon Resource Number (ARN) for the hook to set Configuration for.

public virtual string? TypeArn { get; set; }

Property Value

string

Remarks

You must specify either TypeName and Configuration or TypeARN and Configuration .

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

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 .

You must specify either TypeName and Configuration or TypeARN and Configuration .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-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>