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.5.0 (build 46538f8)",
           date="2020-05-15T23:35:45.932Z")
 @Stability(value=External)
public class CfnMacro
extends CfnResource
implements IInspectable

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

See Also:

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

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$Proxy

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
static CfnMacro	fromCloudFormation(Construct scope, String id, Object resourceAttributes) A factory method that creates a new instance of this class from an object containing the CloudFormation properties of this resource.
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.core.CfnResource

addDeletionOverride, addDependsOn, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getUpdatedProperites, isCfnResource, 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

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=External)
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=External)
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

fromCloudFormation

@Stability(value=Experimental)
 @NotNull
public static CfnMacro fromCloudFormation(@NotNull
                                                                                   Construct scope,
                                                                                   @NotNull
                                                                                   String id,
                                                                                   @NotNull
                                                                                   Object resourceAttributes)

A factory method that creates a new instance of this class from an object containing the CloudFormation properties of this resource.

Used in the @aws-cdk/cloudformation-include module.

EXPERIMENTAL

Parameters:

scope - This parameter is required.

id - This parameter is required.

resourceAttributes - This parameter is required.

inspect

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

Examines the CloudFormation resource and discloses attributes.

EXPERIMENTAL

Specified by:

inspect in interface IInspectable

Parameters:

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

renderProperties

@Stability(value=External)
 @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=External)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFunctionName

@Stability(value=External)
 @NotNull
public String getFunctionName()

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

See Also:

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

setFunctionName

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

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

See Also:

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

getName

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

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

See Also:

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

setName

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

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

See Also:

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

getDescription

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

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

See Also:

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

setDescription

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

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

See Also:

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

getLogGroupName

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

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

See Also:

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

setLogGroupName

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

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

See Also:

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

getLogRoleArn

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

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

See Also:

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

setLogRoleArn

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

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

See Also:

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