Package software.amazon.awscdk.services.cloudformation

Class CfnMacro.Builder

java.lang.Object

software.amazon.awscdk.services.cloudformation.CfnMacro.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMacro>

Enclosing class:

CfnMacro

@Stability(Stable)
public static final class CfnMacro.Builder
extends Object
implements software.amazon.jsii.Builder<CfnMacro>

A fluent builder for CfnMacro.

Method Summary

Modifier and Type	Method	Description
CfnMacro	build()
static CfnMacro.Builder	create(software.constructs.Construct scope, String id)
CfnMacro.Builder	description(String description)	A description of the macro.
CfnMacro.Builder	functionName(String functionName)	The Amazon Resource Name (ARN) of the underlying AWS Lambda function that you want AWS CloudFormation to invoke when the macro is run.
CfnMacro.Builder	logGroupName(String logGroupName)	The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function.
CfnMacro.Builder	logRoleArn(String logRoleArn)	The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs .
CfnMacro.Builder	name(String name)	The name of the macro.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnMacro.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnMacro.Builder.

functionName

@Stability(Stable)
public CfnMacro.Builder functionName(String functionName)

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

Parameters:

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

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnMacro.Builder name(String 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:

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

description

@Stability(Stable)
public CfnMacro.Builder description(String description)

A description of the macro.

Parameters:

description - A description of the macro. This parameter is required.

Returns:

this

See Also:

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

logGroupName

@Stability(Stable)
public CfnMacro.Builder logGroupName(String logGroupName)

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

Parameters:

logGroupName - The CloudWatch Logs group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function. This parameter is required.

Returns:

this

See Also:

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

logRoleArn

@Stability(Stable)
public CfnMacro.Builder logRoleArn(String logRoleArn)

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

Parameters:

logRoleArn - The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch Logs . This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnMacro build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnMacro>

Returns:

a newly built instance of CfnMacro.