Interface ICfnMacroProps

Namespace

Amazon.CDK

Assembly

Amazon.CDK.dll

Properties for defining a CfnMacro.

public interface ICfnMacroProps

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"
             };

Remarks

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

ExampleMetadata: fixture=_generated

Properties

Description

A description of the macro.

string? Description { get; }

Property Value

string

Remarks

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

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

string

Remarks

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

LogGroupName

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

string? LogGroupName { get; }

Property Value

string

Remarks

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

LogRoleArn

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

string? LogRoleArn { get; }

Property Value

string

Remarks

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

Name

The name of the macro.

string Name { get; }

Property Value

string

Remarks

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

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