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

Interface CfnMacroMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMacroMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.946Z")
@Stability(Stable)
public interface CfnMacroMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnMacroPropsMixin.

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.*;
 CfnMacroMixinProps cfnMacroMixinProps = CfnMacroMixinProps.builder()
         .description("description")
         .functionName("functionName")
         .logGroupName("logGroupName")
         .logRoleArn("logRoleArn")
         .name("name")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMacroMixinProps.Builder	A builder for CfnMacroMixinProps
static final class	CfnMacroMixinProps.Jsii$Proxy	An implementation for CfnMacroMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnMacroMixinProps.Builder	builder()
default String	getDescription()	A description of the macro.
default String	getFunctionName()	The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.
default String	getLogGroupName()	The CloudWatch Logs group to which CloudFormation sends error logging information when invoking the macro's underlying Lambda function.
default String	getLogRoleArn()	The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs .
default String	getName()	The name of the macro.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the macro.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-description

getFunctionName

@Stability(Stable)
@Nullable
default String getFunctionName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-functionname

getLogGroupName

@Stability(Stable)
@Nullable
default String getLogGroupName()

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

This will be an existing CloudWatch Logs LogGroup. Neither CloudFormation or Lambda will create the group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-loggroupname

getLogRoleArn

@Stability(Stable)
@Nullable
default String getLogRoleArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-logrolearn

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the macro.

The name of the macro must be unique across all macros in the account.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-name

builder

@Stability(Stable)
static CfnMacroMixinProps.Builder builder()

Returns:

a CfnMacroMixinProps.Builder of CfnMacroMixinProps