Package software.amazon.awscdk.cfnpropertymixins.services.cloudformation

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 Type	Method	Description
CfnMacroPropsMixin	build()
static CfnMacroPropsMixin.Builder	create()
static CfnMacroPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnMacroPropsMixin.Builder	description(String description)	A description of the macro.
CfnMacroPropsMixin.Builder	functionName(String functionName)	The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.
CfnMacroPropsMixin.Builder	logGroupName(String logGroupName)	The CloudWatch Logs group to which CloudFormation sends error logging information when invoking the macro's underlying Lambda function.
CfnMacroPropsMixin.Builder	logRoleArn(String logRoleArn)	The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs .
CfnMacroPropsMixin.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 CfnMacroPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnMacroPropsMixin.Builder.

create

@Stability(Stable)
public static CfnMacroPropsMixin.Builder create()

Returns:

a new instance of CfnMacroPropsMixin.Builder.

description

@Stability(Stable)
public CfnMacroPropsMixin.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

functionName

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

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

logGroupName

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

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

logRoleArn

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

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

name

@Stability(Stable)
public CfnMacroPropsMixin.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

build

@Stability(Stable)
public CfnMacroPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnMacroPropsMixin.