CfnMacroProps
- class aws_cdk.aws_cloudformation.CfnMacroProps(*, function_name, name, description=None, log_group_name=None, log_role_arn=None)
Bases:
object
Properties for defining a
CfnMacro
.- Parameters:
function_name (
str
) – The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.name (
str
) – The name of the macro. The name of the macro must be unique across all macros in the account.description (
Optional
[str
]) – A description of the macro.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 .
- 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 import aws_cloudformation as cloudformation cfn_macro_props = cloudformation.CfnMacroProps( function_name="functionName", name="name", # the properties below are optional description="description", log_group_name="logGroupName", log_role_arn="logRoleArn" )
Attributes
- description
A description of the macro.
- function_name
The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.
- 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.
- log_role_arn
The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs .
- name
The name of the macro.
The name of the macro must be unique across all macros in the account.