CfnMacroMixinProps

class aws_cdk.mixins_preview.aws_cloudformation.mixins.CfnMacroMixinProps(*, description=None, function_name=None, log_group_name=None, log_role_arn=None, name=None)

Bases: object

Properties for CfnMacroPropsMixin.

Parameters:

  • description (Optional[str]) – A description of the macro.

  • function_name (Optional[str]) – The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.

  • log_group_name (Optional[str]) – 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.

  • log_role_arn (Optional[str]) – The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs .

  • name (Optional[str]) – The name of the macro. 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudformation import mixins as cloudformation_mixins

cfn_macro_mixin_props = cloudformation_mixins.CfnMacroMixinProps(
    description="description",
    function_name="functionName",
    log_group_name="logGroupName",
    log_role_arn="logRoleArn",
    name="name"
)

Attributes

description

A description of the macro.

See:

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

function_name

The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.

See:

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

log_group_name

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:

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

log_role_arn

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

See:

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

name

The name of the macro.

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