software.amazon.awscdk.core

Class CfnMacro

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.core.CfnMacro

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.52.1 (build 5ccc8f6)",
           date="2022-01-20T19:49:54.015Z")
 @Stability(value=Stable)
public class CfnMacro
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CloudFormation::Macro`.

The AWS::CloudFormation::Macro resource is a CloudFormation resource type that creates a CloudFormation macro to perform custom processing on CloudFormation templates. For more information, see Using AWS CloudFormation macros to perform custom processing on templates .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 CfnMacro cfnMacro = CfnMacro.Builder.create(this, "MyCfnMacro")
         .functionName("functionName")
         .name("name")
         // the properties below are optional
         .description("description")
         .logGroupName("logGroupName")
         .logRoleArn("logRoleArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnMacro.Builder A fluent builder for CfnMacro.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMacro(Construct scope, String id, CfnMacroProps props) Create a new `AWS::CloudFormation::Macro`.
protected	CfnMacro(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMacro(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
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.
String	getLogGroupName() The Amazon CloudWatch log group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function.
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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A description of the macro.
void	setFunctionName(String value) The Amazon Resource Name (ARN) of the underlying AWS Lambda function that you want AWS CloudFormation to invoke when the macro is run.
void	setLogGroupName(String value) The Amazon CloudWatch log group to which AWS CloudFormation sends error logging information when invoking the macro's underlying AWS Lambda function.
void	setLogRoleArn(String value) The ARN of the role AWS CloudFormation should assume when sending log entries to CloudWatch logs.
void	setName(String value) The name of the macro.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnMacro

protected CfnMacro(software.amazon.jsii.JsiiObjectRef objRef)

CfnMacro

protected CfnMacro(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnMacro

@Stability(value=Stable)
public CfnMacro(@NotNull
                                         Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnMacroProps props)

Create a new `AWS::CloudFormation::Macro`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFunctionName

@Stability(value=Stable)
 @NotNull
public 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.

setFunctionName

@Stability(value=Stable)
public void setFunctionName(@NotNull
                                                     String value)

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(value=Stable)
 @NotNull
public String getName()

The name of the macro.

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

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the macro.

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

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of the macro.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the macro.

getLogGroupName

@Stability(value=Stable)
 @Nullable
public String getLogGroupName()

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

setLogGroupName

@Stability(value=Stable)
public void setLogGroupName(@Nullable
                                                     String value)

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

getLogRoleArn

@Stability(value=Stable)
 @Nullable
public String getLogRoleArn()

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

setLogRoleArn

@Stability(value=Stable)
public void setLogRoleArn(@Nullable
                                                   String value)

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