Package software.amazon.awscdk.services.cloudformation

Interface CfnMacroProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnMacroProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.515Z") @Stability(Stable) public interface CfnMacroProps extends software.amazon.jsii.JsiiSerializable
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
    Description
    static final class 
    CfnMacroProps.Builder
    A builder for CfnMacroProps
    static final class 
    CfnMacroProps.Jsii$Proxy
    An implementation for CfnMacroProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfnMacroProps.Builder
    builder()
     
    default String
    getDescription()
    A description of the macro.
    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 String
    getLogGroupName()
    The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function.
    default String
    getLogRoleArn()
    The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs .
    String
    getName()
    The name of the macro.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getFunctionName

      @Stability(Stable) @NotNull 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

      @Stability(Stable) @NotNull String getName()
      The name of the macro.

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

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      A description of the macro.

    • getLogGroupName

      @Stability(Stable) @Nullable default String getLogGroupName()
      The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function.

    • getLogRoleArn

      @Stability(Stable) @Nullable default String getLogRoleArn()
      The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs .

    • builder

      @Stability(Stable) static CfnMacroProps.Builder builder()
      Returns:
      a CfnMacroProps.Builder of CfnMacroProps