Class CfnHookTypeConfig
The AWS::CloudFormation::HookTypeConfig resource specifies the configuration of an activated Hook.
Inherited Members
Namespace: Amazon.CDK.AWS.CloudFormation
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnHookTypeConfig : CfnResource, IInspectable, IHookTypeConfigRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class CfnHookTypeConfig Inherits CfnResource Implements IInspectable, IHookTypeConfigRef, IConstruct, IDependable, IEnvironmentAware
Remarks
For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::HookTypeConfig
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 cfnHookTypeConfig = new CfnHookTypeConfig(this, "MyCfnHookTypeConfig", new CfnHookTypeConfigProps {
Configuration = "configuration",
// the properties below are optional
ConfigurationAlias = "configurationAlias",
TypeArn = "typeArn",
TypeName = "typeName"
});
Synopsis
Constructors
| CfnHookTypeConfig(Construct, string, ICfnHookTypeConfigProps) | Create a new |
Properties
| AttrConfigurationArn | The Amazon Resource Number (ARN) of the activated Hook type configuration in this account and Region. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | The |
| Configuration | Specifies the activated Hook type configuration, in this AWS account and AWS Region . |
| ConfigurationAlias | An alias by which to refer to this configuration data. |
| HookTypeConfigRef | A reference to a HookTypeConfig resource. |
| TypeArn | The Amazon Resource Number (ARN) for the Hook to set |
| TypeName | The unique name for your Hook. |
Methods
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| RenderProperties(IDictionary<string, object>) | The |
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
Construct identifier for this resource (unique in its scope).
- props ICfnHookTypeConfigProps
Resource properties.
Remarks
For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::HookTypeConfig
ExampleMetadata: fixture=_generated
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
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
Remarks
For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::HookTypeConfig
ExampleMetadata: fixture=_generated
CfnProperties
The AWS::CloudFormation::HookTypeConfig resource specifies the configuration of an activated Hook.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::HookTypeConfig
ExampleMetadata: fixture=_generated
Configuration
Specifies the activated Hook type configuration, in this AWS account and AWS Region .
public virtual string Configuration { get; set; }
Property Value
Remarks
For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::HookTypeConfig
ExampleMetadata: fixture=_generated
ConfigurationAlias
An alias by which to refer to this configuration data.
public virtual string? ConfigurationAlias { get; set; }
Property Value
Remarks
For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::HookTypeConfig
ExampleMetadata: fixture=_generated
HookTypeConfigRef
A reference to a HookTypeConfig resource.
public virtual IHookTypeConfigReference HookTypeConfigRef { get; }
Property Value
Remarks
For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::HookTypeConfig
ExampleMetadata: fixture=_generated
TypeArn
The Amazon Resource Number (ARN) for the Hook to set Configuration for.
public virtual string? TypeArn { get; set; }
Property Value
Remarks
For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::HookTypeConfig
ExampleMetadata: fixture=_generated
TypeName
The unique name for your Hook.
public virtual string? TypeName { get; set; }
Property Value
Remarks
For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::HookTypeConfig
ExampleMetadata: fixture=_generated
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.
Remarks
For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::HookTypeConfig
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
The AWS::CloudFormation::HookTypeConfig resource specifies the configuration of an activated Hook.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::HookTypeConfig
ExampleMetadata: fixture=_generated