interface CfnMacroProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.CloudFormation.CfnMacroProps |
 Java | software.amazon.awscdk.services.cloudformation.CfnMacroProps |
 Python | aws_cdk.aws_cloudformation.CfnMacroProps |
 TypeScript | @aws-cdk/aws-cloudformation » CfnMacroProps |
Properties for defining a CfnMacro.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloudformation from '@aws-cdk/aws-cloudformation';
const cfnMacroProps: cloudformation.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 AWS Lambda function that you want AWS 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 AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function. |
| log | string | The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs . |
functionName
Type:
string
The Amazon Resource Name (ARN) of the underlying AWS Lambda function that you want AWS 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 AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function.
logRoleArn?
Type:
string
(optional)
The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs .