class CfnAssetModel (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.IoTSiteWise.CfnAssetModel |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsiotsitewise#CfnAssetModel |
![]() | software.amazon.awscdk.services.iotsitewise.CfnAssetModel |
![]() | aws_cdk.aws_iotsitewise.CfnAssetModel |
![]() | aws-cdk-lib » aws_iotsitewise » CfnAssetModel |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
Creates an asset model from specified property and hierarchy definitions.
You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the AWS IoT SiteWise User Guide .
You can create two types of asset models, ASSET_MODEL
or COMPONENT_MODEL
.
- ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
- COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotsitewise as iotsitewise } from 'aws-cdk-lib';
const cfnAssetModel = new iotsitewise.CfnAssetModel(this, 'MyCfnAssetModel', {
assetModelName: 'assetModelName',
// the properties below are optional
assetModelCompositeModels: [{
name: 'name',
type: 'type',
// the properties below are optional
composedAssetModelId: 'composedAssetModelId',
compositeModelProperties: [{
dataType: 'dataType',
name: 'name',
type: {
typeName: 'typeName',
// the properties below are optional
attribute: {
defaultValue: 'defaultValue',
},
metric: {
expression: 'expression',
variables: [{
name: 'name',
value: {
hierarchyExternalId: 'hierarchyExternalId',
hierarchyId: 'hierarchyId',
hierarchyLogicalId: 'hierarchyLogicalId',
propertyExternalId: 'propertyExternalId',
propertyId: 'propertyId',
propertyLogicalId: 'propertyLogicalId',
propertyPath: [{
name: 'name',
}],
},
}],
window: {
tumbling: {
interval: 'interval',
// the properties below are optional
offset: 'offset',
},
},
},
transform: {
expression: 'expression',
variables: [{
name: 'name',
value: {
hierarchyExternalId: 'hierarchyExternalId',
hierarchyId: 'hierarchyId',
hierarchyLogicalId: 'hierarchyLogicalId',
propertyExternalId: 'propertyExternalId',
propertyId: 'propertyId',
propertyLogicalId: 'propertyLogicalId',
propertyPath: [{
name: 'name',
}],
},
}],
},
},
// the properties below are optional
dataTypeSpec: 'dataTypeSpec',
externalId: 'externalId',
id: 'id',
logicalId: 'logicalId',
unit: 'unit',
}],
description: 'description',
externalId: 'externalId',
id: 'id',
parentAssetModelCompositeModelExternalId: 'parentAssetModelCompositeModelExternalId',
path: ['path'],
}],
assetModelDescription: 'assetModelDescription',
assetModelExternalId: 'assetModelExternalId',
assetModelHierarchies: [{
childAssetModelId: 'childAssetModelId',
name: 'name',
// the properties below are optional
externalId: 'externalId',
id: 'id',
logicalId: 'logicalId',
}],
assetModelProperties: [{
dataType: 'dataType',
name: 'name',
type: {
typeName: 'typeName',
// the properties below are optional
attribute: {
defaultValue: 'defaultValue',
},
metric: {
expression: 'expression',
variables: [{
name: 'name',
value: {
hierarchyExternalId: 'hierarchyExternalId',
hierarchyId: 'hierarchyId',
hierarchyLogicalId: 'hierarchyLogicalId',
propertyExternalId: 'propertyExternalId',
propertyId: 'propertyId',
propertyLogicalId: 'propertyLogicalId',
propertyPath: [{
name: 'name',
}],
},
}],
window: {
tumbling: {
interval: 'interval',
// the properties below are optional
offset: 'offset',
},
},
},
transform: {
expression: 'expression',
variables: [{
name: 'name',
value: {
hierarchyExternalId: 'hierarchyExternalId',
hierarchyId: 'hierarchyId',
hierarchyLogicalId: 'hierarchyLogicalId',
propertyExternalId: 'propertyExternalId',
propertyId: 'propertyId',
propertyLogicalId: 'propertyLogicalId',
propertyPath: [{
name: 'name',
}],
},
}],
},
},
// the properties below are optional
dataTypeSpec: 'dataTypeSpec',
externalId: 'externalId',
id: 'id',
logicalId: 'logicalId',
unit: 'unit',
}],
assetModelType: 'assetModelType',
tags: [{
key: 'key',
value: 'value',
}],
});
Initializer
new CfnAssetModel(scope: Construct, id: string, props: CfnAssetModelProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Asset Model Props
Construct Props
Name | Type | Description |
---|---|---|
asset | string | A unique name for the asset model. |
asset | IResolvable | IResolvable | Asset [] | The composite models that are part of this asset model. |
asset | string | A description for the asset model. |
asset | string | The external ID of the asset model. |
asset | IResolvable | IResolvable | Asset [] | The hierarchy definitions of the asset model. |
asset | IResolvable | IResolvable | Asset [] | The property definitions of the asset model. |
asset | string | The type of asset model. |
tags? | Cfn [] | A list of key-value pairs that contain metadata for the asset. |
assetModelName
Type:
string
A unique name for the asset model.
assetModelCompositeModels?
Type:
IResolvable
|
IResolvable
|
Asset
[]
(optional)
The composite models that are part of this asset model.
It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.
When creating custom composite models, you need to use CreateAssetModelCompositeModel . For more information, see Creating custom composite models (Components) in the AWS IoT SiteWise User Guide .
assetModelDescription?
Type:
string
(optional)
A description for the asset model.
assetModelExternalId?
Type:
string
(optional)
The external ID of the asset model.
For more information, see Using external IDs in the AWS IoT SiteWise User Guide .
assetModelHierarchies?
Type:
IResolvable
|
IResolvable
|
Asset
[]
(optional)
The hierarchy definitions of the asset model.
Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .
assetModelProperties?
Type:
IResolvable
|
IResolvable
|
Asset
[]
(optional)
The property definitions of the asset model.
For more information, see Asset properties in the AWS IoT SiteWise User Guide .
You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .
assetModelType?
Type:
string
(optional)
The type of asset model.
- ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
- COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
tags?
Type:
Cfn
[]
(optional)
A list of key-value pairs that contain metadata for the asset.
For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .
Properties
Name | Type | Description |
---|---|---|
asset | string | A unique name for the asset model. |
attr | string | The ARN of the asset model, which has the following format. |
attr | string | The ID of the asset model. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
asset | IResolvable | IResolvable | Asset [] | The composite models that are part of this asset model. |
asset | string | A description for the asset model. |
asset | string | The external ID of the asset model. |
asset | IResolvable | IResolvable | Asset [] | The hierarchy definitions of the asset model. |
asset | IResolvable | IResolvable | Asset [] | The property definitions of the asset model. |
asset | string | The type of asset model. |
tags | Cfn [] | A list of key-value pairs that contain metadata for the asset. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
assetModelName
Type:
string
A unique name for the asset model.
attrAssetModelArn
Type:
string
The ARN of the asset model, which has the following format.
attrAssetModelId
Type:
string
The ID of the asset model.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
assetModelCompositeModels?
Type:
IResolvable
|
IResolvable
|
Asset
[]
(optional)
The composite models that are part of this asset model.
assetModelDescription?
Type:
string
(optional)
A description for the asset model.
assetModelExternalId?
Type:
string
(optional)
The external ID of the asset model.
assetModelHierarchies?
Type:
IResolvable
|
IResolvable
|
Asset
[]
(optional)
The hierarchy definitions of the asset model.
assetModelProperties?
Type:
IResolvable
|
IResolvable
|
Asset
[]
(optional)
The property definitions of the asset model.
assetModelType?
Type:
string
(optional)
The type of asset model.
tagsRaw?
Type:
Cfn
[]
(optional)
A list of key-value pairs that contain metadata for the asset.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }