Class CfnHookTypeConfig
A CloudFormation AWS::CloudFormation::HookTypeConfig
.
Inherited Members
Namespace: Amazon.CDK.AWS.CloudFormation
Assembly: Amazon.CDK.AWS.CloudFormation.dll
Syntax (csharp)
public class CfnHookTypeConfig : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnHookTypeConfig
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The HookTypeConfig
resource specifies the configuration of a hook.
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 |
CfnHookTypeConfig(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnHookTypeConfig(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
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 | |
Configuration | Specifies the activated hook type configuration, in this AWS account and AWS Region . |
ConfigurationAlias | Specifies the activated hook type configuration, in this AWS account and AWS Region . |
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>) |
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 System.String
- scoped id of the resource.
- props ICfnHookTypeConfigProps
- resource properties.
CfnHookTypeConfig(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnHookTypeConfig(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnHookTypeConfig(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnHookTypeConfig(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
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
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Configuration
Specifies the activated hook type configuration, in this AWS account and AWS Region .
public virtual string Configuration { get; set; }
Property Value
System.String
Remarks
You must specify either TypeName
and Configuration
or TypeARN
and Configuration
.
ConfigurationAlias
Specifies the activated hook type configuration, in this AWS account and AWS Region .
public virtual string ConfigurationAlias { get; set; }
Property Value
System.String
Remarks
Defaults to default
alias. Hook types currently support default configuration alias.
TypeArn
The Amazon Resource Number (ARN) for the hook to set Configuration
for.
public virtual string TypeArn { get; set; }
Property Value
System.String
Remarks
You must specify either TypeName
and Configuration
or TypeARN
and Configuration
.
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
.
You must specify either TypeName
and Configuration
or TypeARN
and Configuration
.
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>