interface CfnMacroMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CloudFormation.Mixins.CfnMacroMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscloudformation/mixins#CfnMacroMixinProps
Java	software.amazon.awscdk.mixins.preview.services.cloudformation.mixins.CfnMacroMixinProps
Python	aws_cdk.mixins_preview.aws_cloudformation.mixins.CfnMacroMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_cloudformation » mixins » CfnMacroMixinProps

Properties for CfnMacroPropsMixin.

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 { mixins as cloudformation_mixins } from '@aws-cdk/mixins-preview/aws-cloudformation';
const cfnMacroMixinProps: cloudformation_mixins.CfnMacroMixinProps = {
  description: 'description',
  functionName: 'functionName',
  logGroupName: 'logGroupName',
  logRoleArn: 'logRoleArn',
  name: 'name',
};

Properties

Name	Type	Description
description?	string	A description of the macro.
functionName?	string	The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.
logGroupName?	string	The CloudWatch Logs group to which CloudFormation sends error logging information when invoking the macro's underlying Lambda function.
logRoleArn?	string	The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs .
name?	string	The name of the macro.

---

description?

Type: string (optional)

A description of the macro.

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

---

functionName?

Type: string (optional)

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

---

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.

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

---

logRoleArn?

Type: string (optional)

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

---

name?

Type: string (optional)

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