interface CfnMacroProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CfnMacroProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2#CfnMacroProps |
 Java | software.amazon.awscdk.CfnMacroProps |
 Python | aws_cdk.CfnMacroProps |
 TypeScript | aws-cdk-lib » CfnMacroProps |
Properties for defining a CfnMacro.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const cfnMacroProps: cdk.CfnMacroProps = {
functionName: 'functionName',
name: 'name',
// the properties below are optional
description: 'description',
logGroupName: 'logGroupName',
logRoleArn: 'logRoleArn',
};
Properties
| Name | Type | Description |
|---|---|---|
| function | string | The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run. |
| name | string | The name of the macro. |
| description? | string | A description of the macro. |
| log | string | The CloudWatch Logs group to which CloudFormation sends error logging information when invoking the macro's underlying Lambda function. |
| log | string | The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs . |
functionName
Type:
string
The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.
name
Type:
string
The name of the macro.
The name of the macro must be unique across all macros in the account.
description?
Type:
string
(optional)
A description of the macro.
logGroupName?
Type:
string
(optional)
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.
logRoleArn?
Type:
string
(optional)
The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs .