Class CfnMacro

The AWS::CloudFormation::Macro resource is a CloudFormation resource type that creates a CloudFormation macro to perform custom processing on CloudFormation templates.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnMacro

Implements

IInspectable

IMacroRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.CloudFormation

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnMacro : CfnResource, IInspectable, IMacroRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnMacro Inherits CfnResource Implements IInspectable, IMacroRef, IConstruct, IDependable, IEnvironmentAware

Remarks

For more information, see Perform custom processing on CloudFormation templates with template macros in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html

CloudformationResource: AWS::CloudFormation::Macro

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 AWS::CloudFormation::Macro.

Properties

AttrId	Returns a unique identifier for the resource.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The `AWS::CloudFormation::Macro` resource is a CloudFormation resource type that creates a CloudFormation macro to perform custom processing on CloudFormation templates.
Description	A description of the macro.
FunctionName	The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.
LogGroupName	The CloudWatch Logs group to which CloudFormation sends error logging information when invoking the macro's underlying Lambda function.
LogRoleArn	The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs .
MacroRef	A reference to a Macro resource.
Name	The name of the macro.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnMacro(object)	Checks whether the given object is a CfnMacro.
RenderProperties(IDictionary<string, object>)	The `AWS::CloudFormation::Macro` resource is a CloudFormation resource type that creates a CloudFormation macro to perform custom processing on CloudFormation templates.

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 string: Construct identifier for this resource (unique in its scope).
props ICfnMacroProps: Resource properties.

Remarks

For more information, see Perform custom processing on CloudFormation templates with template macros in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html

CloudformationResource: AWS::CloudFormation::Macro

ExampleMetadata: fixture=_generated

Properties

AttrId

Returns a unique identifier for the resource.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

For more information, see Perform custom processing on CloudFormation templates with template macros in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html

CloudformationResource: AWS::CloudFormation::Macro

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::CloudFormation::Macro resource is a CloudFormation resource type that creates a CloudFormation macro to perform custom processing on CloudFormation templates.

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

CloudformationResource: AWS::CloudFormation::Macro

ExampleMetadata: fixture=_generated

Description

A description of the macro.

public virtual string? Description { get; set; }

Property Value

string

Remarks

For more information, see Perform custom processing on CloudFormation templates with template macros in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html

CloudformationResource: AWS::CloudFormation::Macro

ExampleMetadata: fixture=_generated

FunctionName

The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.

public virtual string FunctionName { get; set; }

Property Value

string

Remarks

For more information, see Perform custom processing on CloudFormation templates with template macros in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html

CloudformationResource: AWS::CloudFormation::Macro

ExampleMetadata: fixture=_generated

LogGroupName

The CloudWatch Logs group to which CloudFormation sends error logging information when invoking the macro's underlying Lambda function.

public virtual string? LogGroupName { get; set; }

Property Value

string

Remarks

For more information, see Perform custom processing on CloudFormation templates with template macros in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html

CloudformationResource: AWS::CloudFormation::Macro

ExampleMetadata: fixture=_generated

LogRoleArn

The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs .

public virtual string? LogRoleArn { get; set; }

Property Value

string

Remarks

For more information, see Perform custom processing on CloudFormation templates with template macros in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html

CloudformationResource: AWS::CloudFormation::Macro

ExampleMetadata: fixture=_generated

MacroRef

A reference to a Macro resource.

public virtual IMacroReference MacroRef { get; }

Property Value

IMacroReference

Remarks

For more information, see Perform custom processing on CloudFormation templates with template macros in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html

CloudformationResource: AWS::CloudFormation::Macro

ExampleMetadata: fixture=_generated

Name

The name of the macro.

public virtual string Name { get; set; }

Property Value

string

Remarks

For more information, see Perform custom processing on CloudFormation templates with template macros in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html

CloudformationResource: AWS::CloudFormation::Macro

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 more information, see Perform custom processing on CloudFormation templates with template macros in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html

CloudformationResource: AWS::CloudFormation::Macro

ExampleMetadata: fixture=_generated

IsCfnMacro(object)

Checks whether the given object is a CfnMacro.

public static bool IsCfnMacro(object x)

Parameters

x object

Returns

bool

Remarks

For more information, see Perform custom processing on CloudFormation templates with template macros in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html

CloudformationResource: AWS::CloudFormation::Macro

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::CloudFormation::Macro resource is a CloudFormation resource type that creates a CloudFormation macro to perform custom processing on CloudFormation templates.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

For more information, see Perform custom processing on CloudFormation templates with template macros in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html

CloudformationResource: AWS::CloudFormation::Macro

ExampleMetadata: fixture=_generated

Implements

IInspectable

IMacroRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware