software.amazon.awscdk.services.iotsitewise

Class CfnAssetModel

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.iotsitewise.CfnAssetModel

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.072Z")
 @Stability(value=Stable)
public class CfnAssetModel
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTSiteWise::AssetModel`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotsitewise.*;
 CfnAssetModel cfnAssetModel = CfnAssetModel.Builder.create(this, "MyCfnAssetModel")
         .assetModelName("assetModelName")
         // the properties below are optional
         .assetModelCompositeModels(List.of(AssetModelCompositeModelProperty.builder()
                 .name("name")
                 .type("type")
                 // the properties below are optional
                 .compositeModelProperties(List.of(AssetModelPropertyProperty.builder()
                         .dataType("dataType")
                         .logicalId("logicalId")
                         .name("name")
                         .type(PropertyTypeProperty.builder()
                                 .typeName("typeName")
                                 // the properties below are optional
                                 .attribute(AttributeProperty.builder()
                                         .defaultValue("defaultValue")
                                         .build())
                                 .metric(MetricProperty.builder()
                                         .expression("expression")
                                         .variables(List.of(ExpressionVariableProperty.builder()
                                                 .name("name")
                                                 .value(VariableValueProperty.builder()
                                                         .propertyLogicalId("propertyLogicalId")
                                                         // the properties below are optional
                                                         .hierarchyLogicalId("hierarchyLogicalId")
                                                         .build())
                                                 .build()))
                                         .window(MetricWindowProperty.builder()
                                                 .tumbling(TumblingWindowProperty.builder()
                                                         .interval("interval")
                                                         // the properties below are optional
                                                         .offset("offset")
                                                         .build())
                                                 .build())
                                         .build())
                                 .transform(TransformProperty.builder()
                                         .expression("expression")
                                         .variables(List.of(ExpressionVariableProperty.builder()
                                                 .name("name")
                                                 .value(VariableValueProperty.builder()
                                                         .propertyLogicalId("propertyLogicalId")
                                                         // the properties below are optional
                                                         .hierarchyLogicalId("hierarchyLogicalId")
                                                         .build())
                                                 .build()))
                                         .build())
                                 .build())
                         // the properties below are optional
                         .dataTypeSpec("dataTypeSpec")
                         .unit("unit")
                         .build()))
                 .description("description")
                 .build()))
         .assetModelDescription("assetModelDescription")
         .assetModelHierarchies(List.of(AssetModelHierarchyProperty.builder()
                 .childAssetModelId("childAssetModelId")
                 .logicalId("logicalId")
                 .name("name")
                 .build()))
         .assetModelProperties(List.of(AssetModelPropertyProperty.builder()
                 .dataType("dataType")
                 .logicalId("logicalId")
                 .name("name")
                 .type(PropertyTypeProperty.builder()
                         .typeName("typeName")
                         // the properties below are optional
                         .attribute(AttributeProperty.builder()
                                 .defaultValue("defaultValue")
                                 .build())
                         .metric(MetricProperty.builder()
                                 .expression("expression")
                                 .variables(List.of(ExpressionVariableProperty.builder()
                                         .name("name")
                                         .value(VariableValueProperty.builder()
                                                 .propertyLogicalId("propertyLogicalId")
                                                 // the properties below are optional
                                                 .hierarchyLogicalId("hierarchyLogicalId")
                                                 .build())
                                         .build()))
                                 .window(MetricWindowProperty.builder()
                                         .tumbling(TumblingWindowProperty.builder()
                                                 .interval("interval")
                                                 // the properties below are optional
                                                 .offset("offset")
                                                 .build())
                                         .build())
                                 .build())
                         .transform(TransformProperty.builder()
                                 .expression("expression")
                                 .variables(List.of(ExpressionVariableProperty.builder()
                                         .name("name")
                                         .value(VariableValueProperty.builder()
                                                 .propertyLogicalId("propertyLogicalId")
                                                 // the properties below are optional
                                                 .hierarchyLogicalId("hierarchyLogicalId")
                                                 .build())
                                         .build()))
                                 .build())
                         .build())
                 // the properties below are optional
                 .dataTypeSpec("dataTypeSpec")
                 .unit("unit")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnAssetModel.AssetModelCompositeModelProperty Example:
static interface	CfnAssetModel.AssetModelHierarchyProperty Example:
static interface	CfnAssetModel.AssetModelPropertyProperty Example:
static interface	CfnAssetModel.AttributeProperty Example:
static class	CfnAssetModel.Builder A fluent builder for CfnAssetModel.
static interface	CfnAssetModel.ExpressionVariableProperty Example:
static interface	CfnAssetModel.MetricProperty Example:
static interface	CfnAssetModel.MetricWindowProperty Example:
static interface	CfnAssetModel.PropertyTypeProperty Example:
static interface	CfnAssetModel.TransformProperty Example:
static interface	CfnAssetModel.TumblingWindowProperty Example:
static interface	CfnAssetModel.VariableValueProperty Example:

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
	CfnAssetModel(software.constructs.Construct scope, String id, CfnAssetModelProps props) Create a new `AWS::IoTSiteWise::AssetModel`.
protected	CfnAssetModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAssetModel(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAssetModelCompositeModels() `AWS::IoTSiteWise::AssetModel.AssetModelCompositeModels`.
String	getAssetModelDescription() `AWS::IoTSiteWise::AssetModel.AssetModelDescription`.
Object	getAssetModelHierarchies() `AWS::IoTSiteWise::AssetModel.AssetModelHierarchies`.
String	getAssetModelName() `AWS::IoTSiteWise::AssetModel.AssetModelName`.
Object	getAssetModelProperties() `AWS::IoTSiteWise::AssetModel.AssetModelProperties`.
String	getAttrAssetModelArn()
String	getAttrAssetModelId()
protected Map<String,Object>	getCfnProperties()
TagManager	getTags() `AWS::IoTSiteWise::AssetModel.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAssetModelCompositeModels(IResolvable value) `AWS::IoTSiteWise::AssetModel.AssetModelCompositeModels`.
void	setAssetModelCompositeModels(List<Object> value) `AWS::IoTSiteWise::AssetModel.AssetModelCompositeModels`.
void	setAssetModelDescription(String value) `AWS::IoTSiteWise::AssetModel.AssetModelDescription`.
void	setAssetModelHierarchies(IResolvable value) `AWS::IoTSiteWise::AssetModel.AssetModelHierarchies`.
void	setAssetModelHierarchies(List<Object> value) `AWS::IoTSiteWise::AssetModel.AssetModelHierarchies`.
void	setAssetModelName(String value) `AWS::IoTSiteWise::AssetModel.AssetModelName`.
void	setAssetModelProperties(IResolvable value) `AWS::IoTSiteWise::AssetModel.AssetModelProperties`.
void	setAssetModelProperties(List<Object> value) `AWS::IoTSiteWise::AssetModel.AssetModelProperties`.

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

CfnAssetModel

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

CfnAssetModel

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

CfnAssetModel

@Stability(value=Stable)
public CfnAssetModel(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnAssetModelProps props)

Create a new `AWS::IoTSiteWise::AssetModel`.

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.

getAssetModelCompositeModels

@Stability(value=Stable)
 @Nullable
public Object getAssetModelCompositeModels()

`AWS::IoTSiteWise::AssetModel.AssetModelCompositeModels`.

setAssetModelCompositeModels

@Stability(value=Stable)
public void setAssetModelCompositeModels(@Nullable
                                                                  IResolvable value)

`AWS::IoTSiteWise::AssetModel.AssetModelCompositeModels`.

setAssetModelCompositeModels

@Stability(value=Stable)
public void setAssetModelCompositeModels(@Nullable
                                                                  List<Object> value)

`AWS::IoTSiteWise::AssetModel.AssetModelCompositeModels`.

getAssetModelDescription

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

`AWS::IoTSiteWise::AssetModel.AssetModelDescription`.

setAssetModelDescription

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

`AWS::IoTSiteWise::AssetModel.AssetModelDescription`.

getAssetModelHierarchies

@Stability(value=Stable)
 @Nullable
public Object getAssetModelHierarchies()

`AWS::IoTSiteWise::AssetModel.AssetModelHierarchies`.

setAssetModelHierarchies

@Stability(value=Stable)
public void setAssetModelHierarchies(@Nullable
                                                              IResolvable value)

`AWS::IoTSiteWise::AssetModel.AssetModelHierarchies`.

setAssetModelHierarchies

@Stability(value=Stable)
public void setAssetModelHierarchies(@Nullable
                                                              List<Object> value)

`AWS::IoTSiteWise::AssetModel.AssetModelHierarchies`.

getAssetModelName

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

`AWS::IoTSiteWise::AssetModel.AssetModelName`.

setAssetModelName

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

`AWS::IoTSiteWise::AssetModel.AssetModelName`.

getAssetModelProperties

@Stability(value=Stable)
 @Nullable
public Object getAssetModelProperties()

`AWS::IoTSiteWise::AssetModel.AssetModelProperties`.

setAssetModelProperties

@Stability(value=Stable)
public void setAssetModelProperties(@Nullable
                                                             IResolvable value)

`AWS::IoTSiteWise::AssetModel.AssetModelProperties`.

setAssetModelProperties

@Stability(value=Stable)
public void setAssetModelProperties(@Nullable
                                                             List<Object> value)

`AWS::IoTSiteWise::AssetModel.AssetModelProperties`.

getAttrAssetModelArn

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

getAttrAssetModelId

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::IoTSiteWise::AssetModel.Tags`.