Skip to content
v2.274.0

AWS::IoTSiteWise Construct Library ​

This module is part of the AWS Cloud Development Kit project.

ts
import * as iotsitewise from 'aws-cdk-lib/aws-iotsitewise';
python
import aws_cdk.aws_iotsitewise as iotsitewise
java
import software.amazon.awscdk.services.iotsitewise.*;
csharp
using Amazon.CDK.AWS.IoTSiteWise;
go
import iotsitewise "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::IoTSiteWise.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types ​

NameKindSummary
CfnAccessPolicyConstruct (L1)> The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .
CfnApplicationConstruct (L1)Represents an AWS IoT SiteWise application that provides IAM Identity Center based access to a workspace.
CfnAssetConstruct (L1)Creates an asset from an existing asset model.
CfnAssetModelConstruct (L1)Creates an asset model from specified property and hierarchy definitions.
CfnComputationModelConstruct (L1)Create a computation model with a configuration and data binding.
CfnDashboardConstruct (L1)> The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .
CfnDatasetConstruct (L1)Creates a dataset to connect an external datasource.
CfnGatewayConstruct (L1)Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise .
CfnPipelineConstruct (L1)Resource schema for AWS::IoTSiteWise::Pipeline.
CfnPortalConstruct (L1)> The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .
CfnProjectConstruct (L1)> The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .
CfnTaskConstruct (L1)Resource schema for AWS::IoTSiteWise::Task.
CfnWorkspaceConstruct (L1)Represents an AWS IoT SiteWise workspace that provides logical isolation for tasks and pipelines.
CfnAccessPolicy.AccessPolicyIdentityPropertyStructThe identity (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy applies.
CfnAccessPolicy.AccessPolicyResourcePropertyStructThe AWS IoT SiteWise Monitor resource for this access policy.
CfnAccessPolicy.IamRolePropertyStructContains information about an AWS Identity and Access Management role.
CfnAccessPolicy.IamUserPropertyStructContains information about an AWS Identity and Access Management user.
CfnAccessPolicy.PortalPropertyStructIdentifies an AWS IoT SiteWise Monitor portal.
CfnAccessPolicy.ProjectPropertyStructIdentifies a specific AWS IoT SiteWise Monitor project.
CfnAccessPolicy.UserPropertyStructContains information for a user identity in an access policy.
CfnAccessPolicyPropsStructProperties for defining a CfnAccessPolicy.
CfnApplicationPropsStructProperties for defining a CfnApplication.
CfnAsset.AssetHierarchyPropertyStructDescribes an asset hierarchy that contains a hierarchy's name and ID.
CfnAsset.AssetPropertyPropertyStructContains asset property information.
CfnAssetModel.AssetModelCompositeModelPropertyStructContains information about a composite model in an asset model.
CfnAssetModel.AssetModelHierarchyPropertyStructDescribes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.
CfnAssetModel.AssetModelPropertyPropertyStructContains information about an asset model property.
CfnAssetModel.AttributePropertyStructContains an asset attribute property.
CfnAssetModel.EnforcedAssetModelInterfacePropertyMappingPropertyStructContains information about applied interface property and asset model property.
CfnAssetModel.EnforcedAssetModelInterfaceRelationshipPropertyStructContains information about applied interface hierarchy and asset model hierarchy.
CfnAssetModel.ExpressionVariablePropertyStructContains expression variable information.
CfnAssetModel.MetricPropertyStructContains an asset metric property.
CfnAssetModel.MetricWindowPropertyStructContains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).
CfnAssetModel.PropertyPathDefinitionPropertyStructRepresents one level between a composite model and the root of the asset model.
CfnAssetModel.PropertyTypePropertyStructContains a property type, which can be one of attribute , measurement , metric , or transform .
CfnAssetModel.TransformPropertyStructContains an asset transform property.
CfnAssetModel.TumblingWindowPropertyStructContains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window.
CfnAssetModel.VariableValuePropertyStructIdentifies a property value used in an expression.
CfnAssetModelPropsStructProperties for defining a CfnAssetModel.
CfnAssetPropsStructProperties for defining a CfnAsset.
CfnComputationModel.AnomalyDetectionComputationModelConfigurationPropertyStructContains the configuration for anomaly detection computation models.
CfnComputationModel.AssetModelPropertyBindingValuePropertyStructContains information about an assetModelProperty binding value.
CfnComputationModel.AssetPropertyBindingValuePropertyStructRepresents a data binding value referencing a specific asset property.
CfnComputationModel.ComputationModelConfigurationPropertyStructThe configuration for the computation model.
CfnComputationModel.ComputationModelDataBindingValuePropertyStructContains computation model data binding value information, which can be one of assetModelProperty , list .
CfnComputationModelPropsStructProperties for defining a CfnComputationModel.
CfnDashboardPropsStructProperties for defining a CfnDashboard.
CfnDataset.DatasetConfigPropertyStruct
CfnDataset.DatasetSourcePropertyStructThe data source for the dataset.
CfnDataset.KendraSourceDetailPropertyStructThe source details for the Kendra dataset source.
CfnDataset.SessionConfigPropertyStruct
CfnDataset.SourceDetailPropertyStructThe details of the dataset source associated with the dataset.
CfnDatasetPropsStructProperties for defining a CfnDataset.
CfnGateway.GatewayCapabilitySummaryPropertyStructContains a summary of a gateway capability configuration.
CfnGateway.GatewayPlatformPropertyStructThe gateway's platform configuration. You can only specify one platform type in a gateway.
CfnGateway.GreengrassPropertyStruct
CfnGateway.GreengrassV2PropertyStructContains details for a gateway that runs on AWS IoT Greengrass V2 .
CfnGateway.SiemensIEPropertyStructContains details for a AWS IoT SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.
CfnGatewayPropsStructProperties for defining a CfnGateway.
CfnPipeline.ComputeNodePropertyStructA single compute node in a pipeline DAG.
CfnPipelinePropsStructProperties for defining a CfnPipeline.
CfnPortal.AlarmsPropertyStructContains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.
CfnPortal.PortalTypeEntryPropertyStructContainer associated a certain PortalType.
CfnPortalPropsStructProperties for defining a CfnPortal.
CfnProjectPropsStructProperties for defining a CfnProject.
CfnTask.ContainerTaskConfigurationPropertyStructConfiguration for running a custom container image on managed compute.
CfnTask.EphemeralStorageConfigurationPropertyStructConfiguration for ephemeral storage attached to the container task.
CfnTask.MountPropertyStructAttaches a data source to the container filesystem for a task at a customer-supplied relative path under the service-owned mount root.
CfnTask.MountSourcePropertyStructThe data source configuration for a mount.
CfnTask.S3AccessPointSourcePropertyStructConfigures a mount that reads from an Amazon S3 access point.
CfnTask.TaskConfigurationPropertyStructThe task execution configuration.
CfnTaskPropsStructProperties for defining a CfnTask.
CfnWorkspace.EncryptionConfigurationPropertyStructThe encryption configuration for the workspace.
CfnWorkspacePropsStructProperties for defining a CfnWorkspace.