Class CfnMacro
A CloudFormation AWS::CloudFormation::Macro
.
Inherited Members
Namespace: Amazon.CDK.AWS.CloudFormation
Assembly: Amazon.CDK.AWS.CloudFormation.dll
Syntax (csharp)
public class CfnMacro : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnMacro
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::CloudFormation::Macro
resource is a CloudFormation resource type that creates a CloudFormation macro to perform custom processing on CloudFormation templates. For more information, see Using AWS CloudFormation macros to perform custom processing on templates .
CloudformationResource: AWS::CloudFormation::Macro
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.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 cfnMacro = new CfnMacro(this, "MyCfnMacro", new CfnMacroProps {
FunctionName = "functionName",
Name = "name",
// the properties below are optional
Description = "description",
LogGroupName = "logGroupName",
LogRoleArn = "logRoleArn"
});
Synopsis
Constructors
CfnMacro(Construct, String, ICfnMacroProps) | Create a new |
CfnMacro(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnMacro(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description of the macro. |
FunctionName | The Amazon Resource Name (ARN) of the underlying AWS Lambda function that you want AWS CloudFormation to invoke when the macro is run. |
LogGroupName | The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function. |
LogRoleArn | The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs . |
Name | The name of the macro. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnMacro(Construct, String, ICfnMacroProps)
Create a new AWS::CloudFormation::Macro
.
public CfnMacro(Construct scope, string id, ICfnMacroProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnMacroProps
- resource properties.
CfnMacro(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnMacro(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnMacro(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnMacro(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
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
Description
A description of the macro.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
FunctionName
The Amazon Resource Name (ARN) of the underlying AWS Lambda function that you want AWS CloudFormation to invoke when the macro is run.
public virtual string FunctionName { get; set; }
Property Value
System.String
Remarks
LogGroupName
The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function.
public virtual string LogGroupName { get; set; }
Property Value
System.String
Remarks
LogRoleArn
The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs .
public virtual string LogRoleArn { get; set; }
Property Value
System.String
Remarks
Name
The name of the macro.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
The name of the macro must be unique across all macros in the account.
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>