Package software.amazon.awscdk.services.cloudformation

Class CfnMacro

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cloudformation.CfnMacro
All Implemented Interfaces:
IInspectable, IMacroRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:32.824Z") @Stability(Stable) public class CfnMacro extends CfnResource implements IInspectable, IMacroRef
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 Perform custom processing on CloudFormation templates with template macros in the AWS CloudFormation User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudformation.*;
 CfnMacro cfnMacro = CfnMacro.Builder.create(this, "MyCfnMacro")
         .functionName("functionName")
         .name("name")
         // the properties below are optional
         .description("description")
         .logGroupName("logGroupName")
         .logRoleArn("logRoleArn")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMacro

      protected CfnMacro(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMacro

      protected CfnMacro(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMacro

      @Stability(Stable) public CfnMacro(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMacroProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      Returns a unique identifier for the resource.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getMacroRef

      @Stability(Stable) @NotNull public MacroReference getMacroRef()
      A reference to a Macro resource.
      Specified by:
      getMacroRef in interface IMacroRef

    • getFunctionName

      @Stability(Stable) @NotNull public String getFunctionName()
      The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.

    • setFunctionName

      @Stability(Stable) public void setFunctionName(@NotNull String value)
      The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the macro.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the macro.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the macro.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the macro.

    • getLogGroupName

      @Stability(Stable) @Nullable public String getLogGroupName()
      The CloudWatch Logs group to which CloudFormation sends error logging information when invoking the macro's underlying Lambda function.

    • setLogGroupName

      @Stability(Stable) public void setLogGroupName(@Nullable String value)
      The CloudWatch Logs group to which CloudFormation sends error logging information when invoking the macro's underlying Lambda function.

    • getLogRoleArn

      @Stability(Stable) @Nullable public String getLogRoleArn()
      The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs .

    • setLogRoleArn

      @Stability(Stable) public void setLogRoleArn(@Nullable String value)
      The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs .