software.amazon.awscdk.services.cloudformation

Class CfnMacro

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.cloudformation.CfnMacro

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:01.185Z")
 @Stability(value=Stable)
public class CfnMacro
extends CfnResource
implements IInspectable

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

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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.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(software.constructs.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() `AWS::CloudFormation::Macro.Description`.
String	getFunctionName() `AWS::CloudFormation::Macro.FunctionName`.
String	getLogGroupName() `AWS::CloudFormation::Macro.LogGroupName`.
String	getLogRoleArn() `AWS::CloudFormation::Macro.LogRoleARN`.
String	getName() `AWS::CloudFormation::Macro.Name`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) `AWS::CloudFormation::Macro.Description`.
void	setFunctionName(String value) `AWS::CloudFormation::Macro.FunctionName`.
void	setLogGroupName(String value) `AWS::CloudFormation::Macro.LogGroupName`.
void	setLogRoleArn(String value) `AWS::CloudFormation::Macro.LogRoleARN`.
void	setName(String value) `AWS::CloudFormation::Macro.Name`.

Methods inherited from class software.amazon.awscdk.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.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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
                                         software.constructs.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()

`AWS::CloudFormation::Macro.FunctionName`.

setFunctionName

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

`AWS::CloudFormation::Macro.FunctionName`.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

`AWS::CloudFormation::Macro.Name`.

setName

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

`AWS::CloudFormation::Macro.Name`.

getDescription

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

`AWS::CloudFormation::Macro.Description`.

setDescription

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

`AWS::CloudFormation::Macro.Description`.

getLogGroupName

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

`AWS::CloudFormation::Macro.LogGroupName`.

setLogGroupName

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

`AWS::CloudFormation::Macro.LogGroupName`.

getLogRoleArn

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

`AWS::CloudFormation::Macro.LogRoleARN`.

setLogRoleArn

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

`AWS::CloudFormation::Macro.LogRoleARN`.