software.amazon.awscdk.services.cloudformation

Interface CfnMacroProps

All Known Implementing Classes:

CfnMacroProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:55.189Z")
public interface CfnMacroProps

Properties for defining a `CfnMacro`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudformation.*;
 CfnMacroProps cfnMacroProps = CfnMacroProps.builder()
         .functionName("functionName")
         .name("name")
         // the properties below are optional
         .description("description")
         .logGroupName("logGroupName")
         .logRoleArn("logRoleArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnMacroProps.Builder A builder for CfnMacroProps
static class	CfnMacroProps.Jsii$Proxy An implementation for CfnMacroProps

Method Summary

Modifier and Type	Method and Description
static CfnMacroProps.Builder	builder()
default java.lang.String	getDescription() A description of the macro.
java.lang.String	getFunctionName() The Amazon Resource Name (ARN) of the underlying AWS Lambda function that you want AWS CloudFormation to invoke when the macro is run.
default java.lang.String	getLogGroupName() The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function.
default java.lang.String	getLogRoleArn() The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs .
java.lang.String	getName() The name of the macro.

Method Detail

getFunctionName

java.lang.String getFunctionName()

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

getName

java.lang.String getName()

The name of the macro.

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

getDescription

default java.lang.String getDescription()

A description of the macro.

getLogGroupName

default java.lang.String getLogGroupName()

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

getLogRoleArn

default java.lang.String getLogRoleArn()

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

builder

static CfnMacroProps.Builder builder()

Returns:

a CfnMacroProps.Builder of CfnMacroProps