Show / Hide Table of Contents

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 Lambda function that you want CloudFormation to invoke when the macro is run.
LogGroupName	The CloudWatch Logs group to which CloudFormation sends error logging information when invoking the macro's underlying Lambda function.
LogRoleArn	The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs .
Name	The name of the macro.

Properties

Description

A description of the macro.

string? Description { get; }

Property Value

Remarks

See: 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 Lambda function that you want CloudFormation to invoke when the macro is run.

string FunctionName { get; }

Property Value

Remarks

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

LogGroupName

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

string? LogGroupName { get; }

Property Value

Remarks

This will be an existing CloudWatch Logs LogGroup. Neither CloudFormation or Lambda will create the group.

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

LogRoleArn

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

string? LogRoleArn { get; }

Property Value

Remarks

See: 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

Remarks

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

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