Class CfnMacroPropsMixin.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.cloudformation.CfnMacroPropsMixin.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnMacroPropsMixin>
- Enclosing class:
CfnMacroPropsMixin
@Stability(Stable)
public static final class CfnMacroPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnMacroPropsMixin>
A fluent builder for
CfnMacroPropsMixin.-
Method Summary
Modifier and TypeMethodDescriptionbuild()static CfnMacroPropsMixin.Buildercreate()static CfnMacroPropsMixin.Buildercreate(CfnPropertyMixinOptions options) description(String description) A description of the macro.functionName(String functionName) The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.logGroupName(String logGroupName) The CloudWatch Logs group to which CloudFormation sends error logging information when invoking the macro's underlying Lambda function.logRoleArn(String logRoleArn) The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs .The name of the macro.
-
Method Details
-
create
- Parameters:
options- Mixin options.- Returns:
- a new instance of
CfnMacroPropsMixin.Builder.
-
create
- Returns:
- a new instance of
CfnMacroPropsMixin.Builder.
-
description
A description of the macro.- Parameters:
description- A description of the macro. This parameter is required.- Returns:
this- See Also:
-
functionName
The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.- Parameters:
functionName- The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run. This parameter is required.- Returns:
this- See Also:
-
logGroupName
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.
- Parameters:
logGroupName- The CloudWatch Logs group to which CloudFormation sends error logging information when invoking the macro's underlying Lambda function. This parameter is required.- Returns:
this- See Also:
-
logRoleArn
The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs .- Parameters:
logRoleArn- The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs . This parameter is required.- Returns:
this- See Also:
-
name
The name of the macro.The name of the macro must be unique across all macros in the account.
- Parameters:
name- The name of the macro. This parameter is required.- Returns:
this- See Also:
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnMacroPropsMixin>- Returns:
- a newly built instance of
CfnMacroPropsMixin.
-