Package software.amazon.awscdk.cfnpropertymixins.services.cloudformation

Class CfnMacroPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.cloudformation.CfnMacroPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:56.947Z") @Stability(Stable) public class CfnMacroPropsMixin extends Mixin implements software.constructs.IMixin
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 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.cfnpropertymixins.services.cloudformation.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnMacroPropsMixin cfnMacroPropsMixin = CfnMacroPropsMixin.Builder.create(CfnMacroMixinProps.builder()
         .description("description")
         .functionName("functionName")
         .logGroupName("logGroupName")
         .logRoleArn("logRoleArn")
         .name("name")
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CfnMacroPropsMixin.Builder
    A fluent builder for CfnMacroPropsMixin.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IMixin

    software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final List<String>
    CFN_PROPERTY_KEYS
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    CfnMacroPropsMixin(CfnMacroMixinProps props)
    Create a mixin to apply properties to AWS::CloudFormation::Macro.
     
    CfnMacroPropsMixin(CfnMacroMixinProps props, CfnPropertyMixinOptions options)
    Create a mixin to apply properties to AWS::CloudFormation::Macro.
    protected
    CfnMacroPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CfnMacroPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    applyTo(software.constructs.IConstruct construct)
    Apply the mixin properties to the construct.
    protected CfnMacroMixinProps
    getProps()
     
    protected IMergeStrategy
    getStrategy()
     
    Boolean
    supports(software.constructs.IConstruct construct)
    Check if this mixin supports the given construct.

    Methods inherited from class software.amazon.awscdk.Mixin

    isMixin

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnMacroPropsMixin

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

    • CfnMacroPropsMixin

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

    • CfnMacroPropsMixin

      @Stability(Stable) public CfnMacroPropsMixin(@NotNull CfnMacroMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::CloudFormation::Macro.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnMacroPropsMixin

      @Stability(Stable) public CfnMacroPropsMixin(@NotNull CfnMacroMixinProps props)
      Create a mixin to apply properties to AWS::CloudFormation::Macro.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnMacroMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()