Class CfnMacroProps

Properties for defining a CfnMacro.

Inheritance

System.Object

CfnMacroProps

Implements

ICfnMacroProps

Namespace: Amazon.CDK.AWS.CloudFormation

Assembly: Amazon.CDK.AWS.CloudFormation.dll

Syntax (csharp)

public class CfnMacroProps : Object, ICfnMacroProps

Syntax (vb)

Public Class CfnMacroProps
    Inherits Object
    Implements ICfnMacroProps

Remarks

Link: 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.AWS.CloudFormation;

var cfnMacroProps = new CfnMacroProps {
    FunctionName = "functionName",
    Name = "name",

    // the properties below are optional
    Description = "description",
    LogGroupName = "logGroupName",
    LogRoleArn = "logRoleArn"
};

Synopsis

Constructors

CfnMacroProps()

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.

Constructors

CfnMacroProps()

public CfnMacroProps()

Properties

Description

A description of the macro.

public string Description { get; set; }

Property Value

System.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.

public string FunctionName { get; set; }

Property Value

System.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.

public string LogGroupName { get; set; }

Property Value

System.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 .

public string LogRoleArn { get; set; }

Property Value

System.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.

public string Name { get; set; }

Property Value

System.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

Implements

ICfnMacroProps