Interface ICfnMacroProps
Properties for defining a CfnMacro
.
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnMacroProps
Syntax (vb)
Public Interface ICfnMacroProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
var cfnMacroProps = new CfnMacroProps {
FunctionName = "functionName",
Name = "name",
// the properties below are optional
Description = "description",
LogGroupName = "logGroupName",
LogRoleArn = "logRoleArn"
};
Synopsis
Properties
Description | A description of the macro. |
FunctionName | The Amazon Resource Name (ARN) of the underlying AWS Lambda function that you want AWS CloudFormation to invoke when the macro is run. |
LogGroupName | The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function. |
LogRoleArn | The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs . |
Name | The name of the macro. |
Properties
Description
A description of the macro.
virtual string Description { get; }
Property Value
System.String
Remarks
FunctionName
The Amazon Resource Name (ARN) of the underlying AWS Lambda function that you want AWS CloudFormation to invoke when the macro is run.
string FunctionName { get; }
Property Value
System.String
Remarks
LogGroupName
The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function.
virtual string LogGroupName { get; }
Property Value
System.String
Remarks
LogRoleArn
The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs .
virtual string LogRoleArn { get; }
Property Value
System.String
Remarks
Name
The name of the macro.
string Name { get; }
Property Value
System.String
Remarks
The name of the macro must be unique across all macros in the account.