import * as cdk from "../../core/lib"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; import { AccessPolicyReference, AssetModelReference, AssetReference, ComputationModelReference, DashboardReference, DatasetReference, GatewayReference, IAccessPolicyRef, IAssetModelRef, IAssetRef, IComputationModelRef, IDashboardRef, IDatasetRef, IGatewayRef, IPortalRef, IProjectRef, PortalReference, ProjectReference } from "../../interfaces/generated/aws-iotsitewise-interfaces.generated"; import { aws_iotsitewise as ioTSiteWiseRefs } from "../../interfaces"; /** * > The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 . * * If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS IoT SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html) . * * Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource. * * > Support for access policies that use an SSO Group as the identity is not supported at this time. * * @cloudformationResource AWS::IoTSiteWise::AccessPolicy * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html */ export declare class CfnAccessPolicy extends cdk.CfnResource implements cdk.IInspectable, IAccessPolicyRef { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnAccessPolicy from CloudFormation properties * * 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. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAccessPolicy; /** * Checks whether the given object is a CfnAccessPolicy */ static isCfnAccessPolicy(x: any): x is CfnAccessPolicy; /** * Creates a new IAccessPolicyRef from an ARN */ static fromAccessPolicyArn(scope: constructs.Construct, id: string, arn: string): IAccessPolicyRef; /** * Creates a new IAccessPolicyRef from a accessPolicyId */ static fromAccessPolicyId(scope: constructs.Construct, id: string, accessPolicyId: string): IAccessPolicyRef; static arnForAccessPolicy(resource: IAccessPolicyRef): string; /** * The identity for this access policy. */ private _accessPolicyIdentity; /** * The permission level for this access policy. */ private _accessPolicyPermission; /** * The AWS IoT SiteWise Monitor resource for this access policy. */ private _accessPolicyResource; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::IoTSiteWise::AccessPolicy`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnAccessPolicyProps); get accessPolicyRef(): AccessPolicyReference; /** * The identity for this access policy. */ get accessPolicyIdentity(): CfnAccessPolicy.AccessPolicyIdentityProperty | cdk.IResolvable; /** * The identity for this access policy. */ set accessPolicyIdentity(value: CfnAccessPolicy.AccessPolicyIdentityProperty | cdk.IResolvable); /** * The permission level for this access policy. */ get accessPolicyPermission(): string; /** * The permission level for this access policy. */ set accessPolicyPermission(value: string); /** * The AWS IoT SiteWise Monitor resource for this access policy. */ get accessPolicyResource(): CfnAccessPolicy.AccessPolicyResourceProperty | cdk.IResolvable; /** * The AWS IoT SiteWise Monitor resource for this access policy. */ set accessPolicyResource(value: CfnAccessPolicy.AccessPolicyResourceProperty | cdk.IResolvable); /** * The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the access policy, which has the following format. * * `arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}` * * @cloudformationAttribute AccessPolicyArn */ get attrAccessPolicyArn(): string; /** * The ID of the access policy. * * @cloudformationAttribute AccessPolicyId */ get attrAccessPolicyId(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnAccessPolicy { /** * The AWS IoT SiteWise Monitor resource for this access policy. * * Choose either a portal or a project. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html */ interface AccessPolicyResourceProperty { /** * Identifies an AWS IoT SiteWise Monitor portal. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html#cfn-iotsitewise-accesspolicy-accesspolicyresource-portal */ readonly portal?: cdk.IResolvable | CfnAccessPolicy.PortalProperty; /** * Identifies a specific AWS IoT SiteWise Monitor project. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html#cfn-iotsitewise-accesspolicy-accesspolicyresource-project */ readonly project?: cdk.IResolvable | CfnAccessPolicy.ProjectProperty; } /** * Identifies a specific AWS IoT SiteWise Monitor project. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-project.html */ interface ProjectProperty { /** * The ID of the project. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-project.html#cfn-iotsitewise-accesspolicy-project-id */ readonly id?: string; } /** * Identifies an AWS IoT SiteWise Monitor portal. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-portal.html */ interface PortalProperty { /** * The ID of the portal. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-portal.html#cfn-iotsitewise-accesspolicy-portal-id */ readonly id?: string; } /** * The identity (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy applies. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html */ interface AccessPolicyIdentityProperty { /** * An IAM role identity. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html#cfn-iotsitewise-accesspolicy-accesspolicyidentity-iamrole */ readonly iamRole?: CfnAccessPolicy.IamRoleProperty | cdk.IResolvable; /** * An IAM user identity. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html#cfn-iotsitewise-accesspolicy-accesspolicyidentity-iamuser */ readonly iamUser?: CfnAccessPolicy.IamUserProperty | cdk.IResolvable; /** * An IAM Identity Center user identity. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html#cfn-iotsitewise-accesspolicy-accesspolicyidentity-user */ readonly user?: cdk.IResolvable | CfnAccessPolicy.UserProperty; } /** * Contains information for a user identity in an access policy. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html */ interface UserProperty { /** * The IAM Identity Center ID of the user. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html#cfn-iotsitewise-accesspolicy-user-id */ readonly id?: string; } /** * Contains information about an AWS Identity and Access Management user. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamuser.html */ interface IamUserProperty { /** * The ARN of the IAM user. For more information, see [IAM ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in the *IAM User Guide* . * * > If you delete the IAM user, access policies that contain this identity include an empty `arn` . You can delete the access policy for the IAM user that no longer exists. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamuser.html#cfn-iotsitewise-accesspolicy-iamuser-arn */ readonly arn?: string; } /** * Contains information about an AWS Identity and Access Management role. * * For more information, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamrole.html */ interface IamRoleProperty { /** * The ARN of the IAM role. * * For more information, see [IAM ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in the *IAM User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamrole.html#cfn-iotsitewise-accesspolicy-iamrole-arn */ readonly arn?: string; } } /** * Properties for defining a `CfnAccessPolicy` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html */ export interface CfnAccessPolicyProps { /** * The identity for this access policy. * * Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html#cfn-iotsitewise-accesspolicy-accesspolicyidentity */ readonly accessPolicyIdentity: CfnAccessPolicy.AccessPolicyIdentityProperty | cdk.IResolvable; /** * The permission level for this access policy. * * Note that a project `ADMINISTRATOR` is also known as a project owner. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html#cfn-iotsitewise-accesspolicy-accesspolicypermission */ readonly accessPolicyPermission: string; /** * The AWS IoT SiteWise Monitor resource for this access policy. * * Choose either a portal or a project. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html#cfn-iotsitewise-accesspolicy-accesspolicyresource */ readonly accessPolicyResource: CfnAccessPolicy.AccessPolicyResourceProperty | cdk.IResolvable; } /** * Creates an asset from an existing asset model. * * For more information, see [Creating assets](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html) in the *AWS IoT SiteWise User Guide* . * * @cloudformationResource AWS::IoTSiteWise::Asset * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html */ export declare class CfnAsset extends cdk.CfnResource implements cdk.IInspectable, IAssetRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnAsset from CloudFormation properties * * 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. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAsset; /** * Checks whether the given object is a CfnAsset */ static isCfnAsset(x: any): x is CfnAsset; /** * Creates a new IAssetRef from an ARN */ static fromAssetArn(scope: constructs.Construct, id: string, arn: string): IAssetRef; /** * Creates a new IAssetRef from a assetId */ static fromAssetId(scope: constructs.Construct, id: string, assetId: string): IAssetRef; static arnForAsset(resource: IAssetRef): string; /** * The ID of the asset, in UUID format. */ private _assetDescription?; /** * The external ID of the asset model composite model. */ private _assetExternalId?; /** * A list of asset hierarchies that each contain a `hierarchyId` . */ private _assetHierarchies?; /** * The ID of the asset model from which to create the asset. */ private _assetModelId; /** * A friendly name for the asset. */ private _assetName; /** * The list of asset properties for the asset. */ private _assetProperties?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * A list of key-value pairs that contain metadata for the asset. */ private _tagsRaw?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::IoTSiteWise::Asset`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnAssetProps); get assetRef(): AssetReference; /** * The ID of the asset, in UUID format. */ get assetDescription(): string | undefined; /** * The ID of the asset, in UUID format. */ set assetDescription(value: string | undefined); /** * The external ID of the asset model composite model. */ get assetExternalId(): string | undefined; /** * The external ID of the asset model composite model. */ set assetExternalId(value: string | undefined); /** * A list of asset hierarchies that each contain a `hierarchyId` . */ get assetHierarchies(): Array | cdk.IResolvable | undefined; /** * A list of asset hierarchies that each contain a `hierarchyId` . */ set assetHierarchies(value: Array | cdk.IResolvable | undefined); /** * The ID of the asset model from which to create the asset. */ get assetModelId(): string; /** * The ID of the asset model from which to create the asset. */ set assetModelId(value: string); /** * A friendly name for the asset. */ get assetName(): string; /** * A friendly name for the asset. */ set assetName(value: string); /** * The list of asset properties for the asset. */ get assetProperties(): Array | cdk.IResolvable | undefined; /** * The list of asset properties for the asset. */ set assetProperties(value: Array | cdk.IResolvable | undefined); /** * A list of key-value pairs that contain metadata for the asset. */ get tagsRaw(): Array | undefined; /** * A list of key-value pairs that contain metadata for the asset. */ set tagsRaw(value: Array | undefined); /** * The ARN of the asset. * * @cloudformationAttribute AssetArn */ get attrAssetArn(): string; /** * The ID of the asset. * * @cloudformationAttribute AssetId */ get attrAssetId(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnAsset { /** * Contains asset property information. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html */ interface AssetPropertyProperty { /** * The alias that identifies the property, such as an OPC-UA server data stream path (for example, `/company/windfarm/3/turbine/7/temperature` ). * * For more information, see [Mapping industrial data streams to asset properties](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-alias */ readonly alias?: string; /** * The external ID of the property. * * For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-externalid */ readonly externalId?: string; /** * The ID of the asset property. * * > This is a return value and can't be set. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-id */ readonly id?: string; /** * The `LogicalID` of the asset property. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-logicalid */ readonly logicalId?: string; /** * The MQTT notification state (enabled or disabled) for this asset property. * * When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see [Interacting with other services](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) in the *AWS IoT SiteWise User Guide* . * * If you omit this parameter, the notification state is set to `DISABLED` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-notificationstate */ readonly notificationState?: string; /** * The unit (such as `Newtons` or `RPM` ) of the asset property. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-unit */ readonly unit?: string; } /** * Describes an asset hierarchy that contains a hierarchy's name and ID. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html */ interface AssetHierarchyProperty { /** * The Id of the child asset. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-childassetid */ readonly childAssetId: string; /** * The external ID of the hierarchy, if it has one. * * When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-externalid */ readonly externalId?: string; /** * The ID of the hierarchy. This ID is a `hierarchyId` . * * > This is a return value and can't be set. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-id */ readonly id?: string; /** * The ID of the hierarchy. * * This ID is a `hierarchyId` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-logicalid */ readonly logicalId?: string; } } /** * Properties for defining a `CfnAsset` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html */ export interface CfnAssetProps { /** * The ID of the asset, in UUID format. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetdescription */ readonly assetDescription?: string; /** * The external ID of the asset model composite model. * * For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetexternalid */ readonly assetExternalId?: string; /** * A list of asset hierarchies that each contain a `hierarchyId` . * * A hierarchy specifies allowed parent/child asset relationships. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assethierarchies */ readonly assetHierarchies?: Array | cdk.IResolvable; /** * The ID of the asset model from which to create the asset. * * This can be either the actual ID in UUID format, or else `externalId:` followed by the external ID, if it has one. For more information, see [Referencing objects with external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetmodelid */ readonly assetModelId: ioTSiteWiseRefs.IAssetModelRef | string; /** * A friendly name for the asset. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetname */ readonly assetName: string; /** * The list of asset properties for the asset. * * This object doesn't include properties that you define in composite models. You can find composite model properties in the `assetCompositeModels` object. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetproperties */ readonly assetProperties?: Array | cdk.IResolvable; /** * A list of key-value pairs that contain metadata for the asset. * * For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-tags */ readonly tags?: Array; } /** * 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html) in the *AWS IoT SiteWise User Guide* . * * You can create three types of asset models, `ASSET_MODEL` , `COMPONENT_MODEL` , or an `INTERFACE` . * * - *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. * - *INTERFACE* – An interface is a type of model that defines a standard structure that can be applied to different asset models. * * @cloudformationResource AWS::IoTSiteWise::AssetModel * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html */ export declare class CfnAssetModel extends cdk.CfnResource implements cdk.IInspectable, IAssetModelRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnAssetModel from CloudFormation properties * * 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. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAssetModel; /** * Checks whether the given object is a CfnAssetModel */ static isCfnAssetModel(x: any): x is CfnAssetModel; /** * Creates a new IAssetModelRef from an ARN */ static fromAssetModelArn(scope: constructs.Construct, id: string, arn: string): IAssetModelRef; /** * Creates a new IAssetModelRef from a assetModelId */ static fromAssetModelId(scope: constructs.Construct, id: string, assetModelId: string): IAssetModelRef; static arnForAssetModel(resource: IAssetModelRef): string; /** * The composite models that are part of this asset model. */ private _assetModelCompositeModels?; /** * A description for the asset model. */ private _assetModelDescription?; /** * The external ID of the asset model. */ private _assetModelExternalId?; /** * The hierarchy definitions of the asset model. */ private _assetModelHierarchies?; /** * A unique name for the asset model. */ private _assetModelName; /** * The property definitions of the asset model. */ private _assetModelProperties?; /** * The type of asset model. */ private _assetModelType?; /** * a list of asset model and interface relationships. */ private _enforcedAssetModelInterfaceRelationships?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * A list of key-value pairs that contain metadata for the asset. */ private _tagsRaw?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::IoTSiteWise::AssetModel`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnAssetModelProps); get assetModelRef(): AssetModelReference; /** * The composite models that are part of this asset model. */ get assetModelCompositeModels(): Array | cdk.IResolvable | undefined; /** * The composite models that are part of this asset model. */ set assetModelCompositeModels(value: Array | cdk.IResolvable | undefined); /** * A description for the asset model. */ get assetModelDescription(): string | undefined; /** * A description for the asset model. */ set assetModelDescription(value: string | undefined); /** * The external ID of the asset model. */ get assetModelExternalId(): string | undefined; /** * The external ID of the asset model. */ set assetModelExternalId(value: string | undefined); /** * The hierarchy definitions of the asset model. */ get assetModelHierarchies(): Array | cdk.IResolvable | undefined; /** * The hierarchy definitions of the asset model. */ set assetModelHierarchies(value: Array | cdk.IResolvable | undefined); /** * A unique name for the asset model. */ get assetModelName(): string; /** * A unique name for the asset model. */ set assetModelName(value: string); /** * The property definitions of the asset model. */ get assetModelProperties(): Array | cdk.IResolvable | undefined; /** * The property definitions of the asset model. */ set assetModelProperties(value: Array | cdk.IResolvable | undefined); /** * The type of asset model. */ get assetModelType(): string | undefined; /** * The type of asset model. */ set assetModelType(value: string | undefined); /** * a list of asset model and interface relationships. */ get enforcedAssetModelInterfaceRelationships(): Array | cdk.IResolvable | undefined; /** * a list of asset model and interface relationships. */ set enforcedAssetModelInterfaceRelationships(value: Array | cdk.IResolvable | undefined); /** * A list of key-value pairs that contain metadata for the asset. */ get tagsRaw(): Array | undefined; /** * A list of key-value pairs that contain metadata for the asset. */ set tagsRaw(value: Array | undefined); /** * The ARN of the asset model, which has the following format. * * @cloudformationAttribute AssetModelArn */ get attrAssetModelArn(): string; /** * The ID of the asset model. * * @cloudformationAttribute AssetModelId */ get attrAssetModelId(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnAssetModel { /** * Contains information about a composite model in an asset model. * * This object contains the asset property definitions that you define in the composite model. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html */ interface AssetModelCompositeModelProperty { /** * The ID of a component model which is reused to create this composite model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-composedassetmodelid */ readonly composedAssetModelId?: string; /** * The asset property definitions for this composite model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-compositemodelproperties */ readonly compositeModelProperties?: Array | cdk.IResolvable; /** * The description of the composite model. * * > If the composite model is a `component-model-based` composite model, the description is inherited from the `COMPONENT_MODEL` asset model and cannot be changed. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-description */ readonly description?: string; /** * The external ID of a composite model on this asset model. * * For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide* . * * > One of `ExternalId` or `Path` must be specified. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-externalid */ readonly externalId?: string; /** * The ID of the asset model composite model. * * > This is a return value and can't be set. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-id */ readonly id?: string; /** * The name of the composite model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-name */ readonly name: string; /** * The external ID of the parent composite model. * * For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-parentassetmodelcompositemodelexternalid */ readonly parentAssetModelCompositeModelExternalId?: string; /** * The structured path to the property from the root of the asset using property names. * * Path is used as the ID if the asset model is a derived composite model. * * > One of `ExternalId` or `Path` must be specified. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-path */ readonly path?: Array; /** * The type of the composite model. * * For alarm composite models, this type is `AWS/ALARM` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-type */ readonly type: string; } /** * Contains information about an asset model property. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html */ interface AssetModelPropertyProperty { /** * The data type of the asset model property. * * If you specify `STRUCT` , you must also specify `dataTypeSpec` to identify the type of the structure for this property. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-datatype */ readonly dataType: string; /** * The data type of the structure for this property. * * This parameter exists on properties that have the `STRUCT` data type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-datatypespec */ readonly dataTypeSpec?: string; /** * The external ID of the asset property. * * For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide* . * * > One of `ExternalId` or `LogicalId` must be specified. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-externalid */ readonly externalId?: string; /** * The ID of the property. * * > This is a return value and can't be set. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-id */ readonly id?: string; /** * The `LogicalID` of the asset model property. * * > One of `ExternalId` or `LogicalId` must be specified. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-logicalid */ readonly logicalId?: string; /** * The name of the asset model property. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-name */ readonly name: string; /** * Contains a property type, which can be one of `attribute` , `measurement` , `metric` , or `transform` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-type */ readonly type: cdk.IResolvable | CfnAssetModel.PropertyTypeProperty; /** * The unit of the asset model property, such as `Newtons` or `RPM` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-unit */ readonly unit?: string; } /** * Contains a property type, which can be one of `attribute` , `measurement` , `metric` , or `transform` . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html */ interface PropertyTypeProperty { /** * Specifies an asset attribute property. * * An attribute generally contains static information, such as the serial number of an [IIoT](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) wind turbine. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html#cfn-iotsitewise-assetmodel-propertytype-attribute */ readonly attribute?: CfnAssetModel.AttributeProperty | cdk.IResolvable; /** * Specifies an asset metric property. * * A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html#cfn-iotsitewise-assetmodel-propertytype-metric */ readonly metric?: cdk.IResolvable | CfnAssetModel.MetricProperty; /** * Specifies an asset transform property. * * A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html#cfn-iotsitewise-assetmodel-propertytype-transform */ readonly transform?: cdk.IResolvable | CfnAssetModel.TransformProperty; /** * The type of property type, which can be one of `Attribute` , `Measurement` , `Metric` , or `Transform` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html#cfn-iotsitewise-assetmodel-propertytype-typename */ readonly typeName: string; } /** * Contains an asset attribute property. * * For more information, see [Attributes](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#attributes) in the *AWS IoT SiteWise User Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-attribute.html */ interface AttributeProperty { /** * The default value of the asset model property attribute. * * All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see [Updating attribute values](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-attribute.html#cfn-iotsitewise-assetmodel-attribute-defaultvalue */ readonly defaultValue?: string; } /** * Contains an asset metric property. * * With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum). * * The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a *root* metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of `DOUBLE` and consume properties with data types of `INTEGER` or `DOUBLE` . * * For more information, see [Metrics](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics) in the *AWS IoT SiteWise User Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html */ interface MetricProperty { /** * The mathematical expression that defines the metric aggregation function. * * You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. * * For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html#cfn-iotsitewise-assetmodel-metric-expression */ readonly expression: string; /** * The list of variables used in the expression. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html#cfn-iotsitewise-assetmodel-metric-variables */ readonly variables: Array | cdk.IResolvable; /** * The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. * * AWS IoT SiteWise computes one data point per `window` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html#cfn-iotsitewise-assetmodel-metric-window */ readonly window: cdk.IResolvable | CfnAssetModel.MetricWindowProperty; } /** * Contains expression variable information. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-expressionvariable.html */ interface ExpressionVariableProperty { /** * The friendly name of the variable to be used in the expression. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-expressionvariable.html#cfn-iotsitewise-assetmodel-expressionvariable-name */ readonly name: string; /** * The variable that identifies an asset property from which to use values. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-expressionvariable.html#cfn-iotsitewise-assetmodel-expressionvariable-value */ readonly value: cdk.IResolvable | CfnAssetModel.VariableValueProperty; } /** * Identifies a property value used in an expression. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html */ interface VariableValueProperty { /** * The external ID of the hierarchy being referenced. * * For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-hierarchyexternalid */ readonly hierarchyExternalId?: string; /** * The ID of the hierarchy to query for the property ID. * * You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify `externalId:` followed by the external ID. For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide* . * * You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same `propertyId` . For example, you might have separately grouped assets that come from the same asset model. For more information, see [Asset hierarchies](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-hierarchyid */ readonly hierarchyId?: string; /** * The `LogicalID` of the hierarchy to query for the `PropertyLogicalID` . * * You use a `hierarchyLogicalID` instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see [Defining relationships between asset models (hierarchies)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-hierarchylogicalid */ readonly hierarchyLogicalId?: string; /** * The external ID of the property being referenced. * * For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertyexternalid */ readonly propertyExternalId?: string; /** * The ID of the property to use as the variable. * * You can use the property `name` if it's from the same asset model. If the property has an external ID, you can specify `externalId:` followed by the external ID. For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide* . * * > This is a return value and can't be set. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertyid */ readonly propertyId?: string; /** * The `LogicalID` of the property that is being referenced. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertylogicalid */ readonly propertyLogicalId?: string; /** * The path of the property. * * Each step of the path is the name of the step. See the following example: * * `PropertyPath: Name: AssetModelName Name: Composite1 Name: NestedComposite` * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertypath */ readonly propertyPath?: Array | cdk.IResolvable; } /** * Represents one level between a composite model and the root of the asset model. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertypathdefinition.html */ interface PropertyPathDefinitionProperty { /** * The name of the path segment. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertypathdefinition.html#cfn-iotsitewise-assetmodel-propertypathdefinition-name */ readonly name: string; } /** * Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on). * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metricwindow.html */ interface MetricWindowProperty { /** * The tumbling time interval window. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metricwindow.html#cfn-iotsitewise-assetmodel-metricwindow-tumbling */ readonly tumbling?: cdk.IResolvable | CfnAssetModel.TumblingWindowProperty; } /** * Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. * * You can use this window in metrics to aggregate data from properties and other assets. * * You can use `m` , `h` , `d` , and `w` when you specify an interval or offset. Note that `m` represents minutes, `h` represents hours, `d` represents days, and `w` represents weeks. You can also use `s` to represent seconds in `offset` . * * The `interval` and `offset` parameters support the [ISO 8601 format](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/ISO_8601) . For example, `PT5S` represents 5 seconds, `PT5M` represents 5 minutes, and `PT5H` represents 5 hours. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-tumblingwindow.html */ interface TumblingWindowProperty { /** * The time interval for the tumbling window. The interval time must be between 1 minute and 1 week. * * AWS IoT SiteWise computes the `1w` interval the end of Sunday at midnight each week (UTC), the `1d` interval at the end of each day at midnight (UTC), the `1h` interval at the end of each hour, and so on. * * When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-tumblingwindow.html#cfn-iotsitewise-assetmodel-tumblingwindow-interval */ readonly interval: string; /** * The offset for the tumbling window. The `offset` parameter accepts the following:. * * - The offset time. * * For example, if you specify `18h` for `offset` and `1d` for `interval` , AWS IoT SiteWise aggregates data in one of the following ways: * * - If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric. * - If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day. * - The ISO 8601 format. * * For example, if you specify `PT18H` for `offset` and `1d` for `interval` , AWS IoT SiteWise aggregates data in one of the following ways: * * - If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric. * - If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day. * - The 24-hour clock. * * For example, if you specify `00:03:00` for `offset` , `5m` for `interval` , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC). * - The offset time zone. * * For example, if you specify `2021-07-23T18:00-08` for `offset` and `1d` for `interval` , AWS IoT SiteWise aggregates data in one of the following ways: * * - If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric. * - If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-tumblingwindow.html#cfn-iotsitewise-assetmodel-tumblingwindow-offset */ readonly offset?: string; } /** * Contains an asset transform property. * * A transform is a one-to-one mapping of a property's data points from one form to another. For example, you can use a transform to convert a Celsius data stream to Fahrenheit by applying the transformation expression to each data point of the Celsius stream. A transform can only have a data type of `DOUBLE` and consume properties with data types of `INTEGER` or `DOUBLE` . * * For more information, see [Transforms](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#transforms) in the *AWS IoT SiteWise User Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-transform.html */ interface TransformProperty { /** * The mathematical expression that defines the transformation function. * * You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. * * For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-transform.html#cfn-iotsitewise-assetmodel-transform-expression */ readonly expression: string; /** * The list of variables used in the expression. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-transform.html#cfn-iotsitewise-assetmodel-transform-variables */ readonly variables: Array | cdk.IResolvable; } /** * Describes 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. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html */ interface AssetModelHierarchyProperty { /** * The ID of the asset model, in UUID format. * * All assets in this hierarchy must be instances of the `childAssetModelId` asset model. AWS IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to [UpdateAssetModel](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) , you may provide either the asset model ID or else `externalId:` followed by the asset model's external ID. For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-childassetmodelid */ readonly childAssetModelId: string; /** * The external ID (if any) provided in the [CreateAssetModel](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) or [UpdateAssetModel](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) operation. You can assign an external ID by specifying this value as part of a call to [UpdateAssetModel](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) . However, you can't change the external ID if one is already assigned. For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide* . * * > One of `ExternalId` or `LogicalId` must be specified. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-externalid */ readonly externalId?: string; /** * The ID of the asset model hierarchy. This ID is a `hierarchyId` . * * > This is a return value and can't be set. * * - If you are callling [UpdateAssetModel](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) to create a *new* hierarchy: You can specify its ID here, if desired. AWS IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique. * - If you are calling UpdateAssetModel to modify an *existing* hierarchy: This can be either the actual ID in UUID format, or else `externalId:` followed by the external ID, if it has one. For more information, see [Referencing objects with external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-id */ readonly id?: string; /** * The `LogicalID` of the asset model hierarchy. This ID is a `hierarchyLogicalId` . * * > One of `ExternalId` or `LogicalId` must be specified. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-logicalid */ readonly logicalId?: string; /** * The name of the asset model hierarchy that you specify by using the [CreateAssetModel](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) or [UpdateAssetModel](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) API operation. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-name */ readonly name: string; } /** * Contains information about applied interface hierarchy and asset model hierarchy. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-enforcedassetmodelinterfacerelationship.html */ interface EnforcedAssetModelInterfaceRelationshipProperty { /** * The ID of the asset model that has the interface applied to it. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-enforcedassetmodelinterfacerelationship.html#cfn-iotsitewise-assetmodel-enforcedassetmodelinterfacerelationship-interfaceassetmodelid */ readonly interfaceAssetModelId?: string; /** * A list of property mappings between the interface asset model and the asset model where the interface is applied. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-enforcedassetmodelinterfacerelationship.html#cfn-iotsitewise-assetmodel-enforcedassetmodelinterfacerelationship-propertymappings */ readonly propertyMappings?: Array | cdk.IResolvable; } /** * Contains information about applied interface property and asset model property. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-enforcedassetmodelinterfacepropertymapping.html */ interface EnforcedAssetModelInterfacePropertyMappingProperty { /** * The external ID of the linked asset model property. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-enforcedassetmodelinterfacepropertymapping.html#cfn-iotsitewise-assetmodel-enforcedassetmodelinterfacepropertymapping-assetmodelpropertyexternalid */ readonly assetModelPropertyExternalId?: string; /** * The logical ID of the linked asset model property. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-enforcedassetmodelinterfacepropertymapping.html#cfn-iotsitewise-assetmodel-enforcedassetmodelinterfacepropertymapping-assetmodelpropertylogicalid */ readonly assetModelPropertyLogicalId?: string; /** * The external ID of the applied interface property. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-enforcedassetmodelinterfacepropertymapping.html#cfn-iotsitewise-assetmodel-enforcedassetmodelinterfacepropertymapping-interfaceassetmodelpropertyexternalid */ readonly interfaceAssetModelPropertyExternalId: string; } } /** * Properties for defining a `CfnAssetModel` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html */ export interface CfnAssetModelProps { /** * 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](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html) . For more information, see [Creating custom composite models (Components)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodels */ readonly assetModelCompositeModels?: Array | cdk.IResolvable; /** * A description for the asset model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodeldescription */ readonly assetModelDescription?: string; /** * The external ID of the asset model. * * For more information, see [Using external IDs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelexternalid */ readonly assetModelExternalId?: string; /** * 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) in the *AWS IoT SiteWise User Guide* . * * You can specify up to 10 hierarchies per asset model. For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelhierarchies */ readonly assetModelHierarchies?: Array | cdk.IResolvable; /** * A unique name for the asset model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelname */ readonly assetModelName: string; /** * The property definitions of the asset model. * * For more information, see [Asset properties](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html) in the *AWS IoT SiteWise User Guide* . * * You can specify up to 200 properties per asset model. For more information, see [Quotas](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelproperties */ readonly assetModelProperties?: Array | cdk.IResolvable; /** * 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. * - *INTERFACE* – An interface is a type of model that defines a standard structure that can be applied to different asset models. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodeltype */ readonly assetModelType?: string; /** * a list of asset model and interface relationships. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-enforcedassetmodelinterfacerelationships */ readonly enforcedAssetModelInterfaceRelationships?: Array | cdk.IResolvable; /** * A list of key-value pairs that contain metadata for the asset. * * For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-tags */ readonly tags?: Array; } /** * > The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 . * * If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS IoT SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html) . * * Creates a dashboard in an AWS IoT SiteWise Monitor project. * * @cloudformationResource AWS::IoTSiteWise::Dashboard * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dashboard.html */ export declare class CfnDashboard extends cdk.CfnResource implements cdk.IInspectable, IDashboardRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnDashboard from CloudFormation properties * * 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. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDashboard; /** * Checks whether the given object is a CfnDashboard */ static isCfnDashboard(x: any): x is CfnDashboard; /** * Creates a new IDashboardRef from an ARN */ static fromDashboardArn(scope: constructs.Construct, id: string, arn: string): IDashboardRef; /** * Creates a new IDashboardRef from a dashboardId */ static fromDashboardId(scope: constructs.Construct, id: string, dashboardId: string): IDashboardRef; static arnForDashboard(resource: IDashboardRef): string; /** * The dashboard definition specified in a JSON literal. */ private _dashboardDefinition; /** * A description for the dashboard. */ private _dashboardDescription; /** * A friendly name for the dashboard. */ private _dashboardName; /** * The ID of the project in which to create the dashboard. */ private _projectId?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * A list of key-value pairs that contain metadata for the dashboard. */ private _tagsRaw?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::IoTSiteWise::Dashboard`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnDashboardProps); get dashboardRef(): DashboardReference; /** * The dashboard definition specified in a JSON literal. */ get dashboardDefinition(): string; /** * The dashboard definition specified in a JSON literal. */ set dashboardDefinition(value: string); /** * A description for the dashboard. */ get dashboardDescription(): string; /** * A description for the dashboard. */ set dashboardDescription(value: string); /** * A friendly name for the dashboard. */ get dashboardName(): string; /** * A friendly name for the dashboard. */ set dashboardName(value: string); /** * The ID of the project in which to create the dashboard. */ get projectId(): string | undefined; /** * The ID of the project in which to create the dashboard. */ set projectId(value: string | undefined); /** * A list of key-value pairs that contain metadata for the dashboard. */ get tagsRaw(): Array | undefined; /** * A list of key-value pairs that contain metadata for the dashboard. */ set tagsRaw(value: Array | undefined); /** * The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the dashboard, which has the following format. * * `arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}` * * @cloudformationAttribute DashboardArn */ get attrDashboardArn(): string; /** * The ID of the dashboard. * * @cloudformationAttribute DashboardId */ get attrDashboardId(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } /** * Properties for defining a `CfnDashboard` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dashboard.html */ export interface CfnDashboardProps { /** * The dashboard definition specified in a JSON literal. * * - AWS IoT SiteWise Monitor (Classic) see [Create dashboards ( AWS CLI )](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) * - AWS IoT SiteWise Monitor (AI-aware) see [Create dashboards ( AWS CLI )](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-ai-dashboard-cli.html) * * in the *AWS IoT SiteWise User Guide* * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dashboard.html#cfn-iotsitewise-dashboard-dashboarddefinition */ readonly dashboardDefinition: string; /** * A description for the dashboard. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dashboard.html#cfn-iotsitewise-dashboard-dashboarddescription */ readonly dashboardDescription: string; /** * A friendly name for the dashboard. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dashboard.html#cfn-iotsitewise-dashboard-dashboardname */ readonly dashboardName: string; /** * The ID of the project in which to create the dashboard. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dashboard.html#cfn-iotsitewise-dashboard-projectid */ readonly projectId?: string; /** * A list of key-value pairs that contain metadata for the dashboard. * * For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dashboard.html#cfn-iotsitewise-dashboard-tags */ readonly tags?: Array; } /** * Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise . * * For more information, see [Ingesting data using a gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) in the *AWS IoT SiteWise User Guide* . * * @cloudformationResource AWS::IoTSiteWise::Gateway * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html */ export declare class CfnGateway extends cdk.CfnResource implements cdk.IInspectable, IGatewayRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnGateway from CloudFormation properties * * 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. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnGateway; /** * Checks whether the given object is a CfnGateway */ static isCfnGateway(x: any): x is CfnGateway; /** * Creates a new IGatewayRef from a gatewayId */ static fromGatewayId(scope: constructs.Construct, id: string, gatewayId: string): IGatewayRef; static arnForGateway(resource: IGatewayRef): string; /** * A list of gateway capability summaries that each contain a namespace and status. */ private _gatewayCapabilitySummaries?; /** * A unique name for the gateway. */ private _gatewayName; /** * The gateway's platform. */ private _gatewayPlatform; /** * The version of the gateway. */ private _gatewayVersion?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * A list of key-value pairs that contain metadata for the gateway. */ private _tagsRaw?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::IoTSiteWise::Gateway`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnGatewayProps); get gatewayRef(): GatewayReference; /** * A list of gateway capability summaries that each contain a namespace and status. */ get gatewayCapabilitySummaries(): Array | cdk.IResolvable | undefined; /** * A list of gateway capability summaries that each contain a namespace and status. */ set gatewayCapabilitySummaries(value: Array | cdk.IResolvable | undefined); /** * A unique name for the gateway. */ get gatewayName(): string; /** * A unique name for the gateway. */ set gatewayName(value: string); /** * The gateway's platform. */ get gatewayPlatform(): CfnGateway.GatewayPlatformProperty | cdk.IResolvable; /** * The gateway's platform. */ set gatewayPlatform(value: CfnGateway.GatewayPlatformProperty | cdk.IResolvable); /** * The version of the gateway. */ get gatewayVersion(): string | undefined; /** * The version of the gateway. */ set gatewayVersion(value: string | undefined); /** * A list of key-value pairs that contain metadata for the gateway. */ get tagsRaw(): Array | undefined; /** * A list of key-value pairs that contain metadata for the gateway. */ set tagsRaw(value: Array | undefined); /** * The ID for the gateway. * * @cloudformationAttribute GatewayId */ get attrGatewayId(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnGateway { /** * Contains a summary of a gateway capability configuration. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewaycapabilitysummary.html */ interface GatewayCapabilitySummaryProperty { /** * The JSON document that defines the configuration for the gateway capability. * * For more information, see [Configuring data sources (CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewaycapabilitysummary.html#cfn-iotsitewise-gateway-gatewaycapabilitysummary-capabilityconfiguration */ readonly capabilityConfiguration?: string; /** * The namespace of the capability configuration. * * For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace `iotsitewise:opcuacollector:3` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewaycapabilitysummary.html#cfn-iotsitewise-gateway-gatewaycapabilitysummary-capabilitynamespace */ readonly capabilityNamespace: string; } /** * The gateway's platform configuration. You can only specify one platform type in a gateway. * * (Legacy only) For Greengrass V1 gateways, specify the `greengrass` parameter with a valid Greengrass group ARN. * * For Greengrass V2 gateways, specify the `greengrassV2` parameter with a valid core device thing name. If creating a V3 gateway ( `gatewayVersion=3` ), you must also specify the `coreDeviceOperatingSystem` . * * For Siemens Industrial Edge gateways, specify the `siemensIE` parameter with a valid IoT Core thing name. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewayplatform.html */ interface GatewayPlatformProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewayplatform.html#cfn-iotsitewise-gateway-gatewayplatform-greengrass */ readonly greengrass?: CfnGateway.GreengrassProperty | cdk.IResolvable; /** * A gateway that runs on AWS IoT Greengrass V2 . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewayplatform.html#cfn-iotsitewise-gateway-gatewayplatform-greengrassv2 */ readonly greengrassV2?: CfnGateway.GreengrassV2Property | cdk.IResolvable; /** * An AWS IoT SiteWise Edge gateway that runs on a Siemens Industrial Edge Device. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewayplatform.html#cfn-iotsitewise-gateway-gatewayplatform-siemensie */ readonly siemensIe?: cdk.IResolvable | CfnGateway.SiemensIEProperty; } /** * Contains details for a gateway that runs on AWS IoT Greengrass V2 . * * To create a gateway that runs on AWS IoT Greengrass V2 , you must deploy the IoT SiteWise Edge component to your gateway device. Your [Greengrass device role](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html) must use the `AWSIoTSiteWiseEdgeAccess` policy. For more information, see [Using AWS IoT SiteWise at the edge](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html) in the *AWS IoT SiteWise User Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-greengrassv2.html */ interface GreengrassV2Property { /** * The operating system of the core device in AWS IoT Greengrass V2. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-greengrassv2.html#cfn-iotsitewise-gateway-greengrassv2-coredeviceoperatingsystem */ readonly coreDeviceOperatingSystem?: string; /** * The name of the AWS IoT thing for your AWS IoT Greengrass V2 core device. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-greengrassv2.html#cfn-iotsitewise-gateway-greengrassv2-coredevicethingname */ readonly coreDeviceThingName: string; } /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-greengrass.html */ interface GreengrassProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-greengrass.html#cfn-iotsitewise-gateway-greengrass-grouparn */ readonly groupArn: string; } /** * Contains details for a AWS IoT SiteWise Edge gateway that runs on a Siemens Industrial Edge Device. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-siemensie.html */ interface SiemensIEProperty { /** * The name of the AWS IoT Thing for your AWS IoT SiteWise Edge gateway. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-siemensie.html#cfn-iotsitewise-gateway-siemensie-iotcorethingname */ readonly iotCoreThingName: string; } } /** * Properties for defining a `CfnGateway` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html */ export interface CfnGatewayProps { /** * A list of gateway capability summaries that each contain a namespace and status. * * Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use [DescribeGatewayCapabilityConfiguration](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-gatewaycapabilitysummaries */ readonly gatewayCapabilitySummaries?: Array | cdk.IResolvable; /** * A unique name for the gateway. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-gatewayname */ readonly gatewayName: string; /** * The gateway's platform. * * You can only specify one platform in a gateway. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-gatewayplatform */ readonly gatewayPlatform: CfnGateway.GatewayPlatformProperty | cdk.IResolvable; /** * The version of the gateway. * * A value of `3` indicates an MQTT-enabled, V3 gateway, while `2` indicates a Classic streams, V2 gateway. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-gatewayversion */ readonly gatewayVersion?: string; /** * A list of key-value pairs that contain metadata for the gateway. * * For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-tags */ readonly tags?: Array; } /** * > The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 . * * If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS IoT SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html) . * * Creates a portal, which can contain projects and dashboards. AWS IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions. * * > Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see [Adding or removing portal administrators](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) in the *AWS IoT SiteWise User Guide* . * * @cloudformationResource AWS::IoTSiteWise::Portal * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html */ export declare class CfnPortal extends cdk.CfnResource implements cdk.IInspectable, IPortalRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnPortal from CloudFormation properties * * 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. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnPortal; /** * Checks whether the given object is a CfnPortal */ static isCfnPortal(x: any): x is CfnPortal; /** * Creates a new IPortalRef from an ARN */ static fromPortalArn(scope: constructs.Construct, id: string, arn: string): IPortalRef; /** * Creates a new IPortalRef from a portalId */ static fromPortalId(scope: constructs.Construct, id: string, portalId: string): IPortalRef; static arnForPortal(resource: IPortalRef): string; /** * Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. */ private _alarms?; /** * The email address that sends alarm notifications. */ private _notificationSenderEmail?; /** * The service to use to authenticate users to the portal. Choose from the following options:. */ private _portalAuthMode?; /** * The AWS administrator's contact email address. */ private _portalContactEmail; /** * A description for the portal. */ private _portalDescription?; /** * A friendly name for the portal. */ private _portalName; /** * Define the type of portal. */ private _portalType?; /** * Map to associate detail of configuration related with a PortalType. */ private _portalTypeConfiguration?; /** * The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see [Using service roles for AWS IoT SiteWise Monitor](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) in the *AWS IoT SiteWise User Guide* . */ private _roleArn; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * A list of key-value pairs that contain metadata for the portal. */ private _tagsRaw?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::IoTSiteWise::Portal`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnPortalProps); get portalRef(): PortalReference; /** * Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. */ get alarms(): any | cdk.IResolvable | undefined; /** * Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. */ set alarms(value: any | cdk.IResolvable | undefined); /** * The email address that sends alarm notifications. */ get notificationSenderEmail(): string | undefined; /** * The email address that sends alarm notifications. */ set notificationSenderEmail(value: string | undefined); /** * The service to use to authenticate users to the portal. Choose from the following options:. */ get portalAuthMode(): string | undefined; /** * The service to use to authenticate users to the portal. Choose from the following options:. */ set portalAuthMode(value: string | undefined); /** * The AWS administrator's contact email address. */ get portalContactEmail(): string; /** * The AWS administrator's contact email address. */ set portalContactEmail(value: string); /** * A description for the portal. */ get portalDescription(): string | undefined; /** * A description for the portal. */ set portalDescription(value: string | undefined); /** * A friendly name for the portal. */ get portalName(): string; /** * A friendly name for the portal. */ set portalName(value: string); /** * Define the type of portal. */ get portalType(): string | undefined; /** * Define the type of portal. */ set portalType(value: string | undefined); /** * Map to associate detail of configuration related with a PortalType. */ get portalTypeConfiguration(): cdk.IResolvable | Record | undefined; /** * Map to associate detail of configuration related with a PortalType. */ set portalTypeConfiguration(value: cdk.IResolvable | Record | undefined); /** * The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see [Using service roles for AWS IoT SiteWise Monitor](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) in the *AWS IoT SiteWise User Guide* . */ get roleArn(): string; /** * The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see [Using service roles for AWS IoT SiteWise Monitor](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) in the *AWS IoT SiteWise User Guide* . */ set roleArn(value: string); /** * A list of key-value pairs that contain metadata for the portal. */ get tagsRaw(): Array | undefined; /** * A list of key-value pairs that contain metadata for the portal. */ set tagsRaw(value: Array | undefined); /** * The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the portal, which has the following format. * * `arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}` * * @cloudformationAttribute PortalArn */ get attrPortalArn(): string; /** * The SSO application generated client ID (used with SSO APIs). * * @cloudformationAttribute PortalClientId */ get attrPortalClientId(): string; /** * The ID of the created portal. * * @cloudformationAttribute PortalId */ get attrPortalId(): string; /** * The public URL for the AWS IoT SiteWise Monitor portal. * * @cloudformationAttribute PortalStartUrl */ get attrPortalStartUrl(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnPortal { /** * Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. * * You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see [Monitoring with alarms](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) in the *AWS IoT SiteWise Application Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-alarms.html */ interface AlarmsProperty { /** * The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-alarms.html#cfn-iotsitewise-portal-alarms-alarmrolearn */ readonly alarmRoleArn?: string; /** * The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the Lambda function that manages alarm notifications. For more information, see [Managing alarm notifications](https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) in the *AWS IoT Events Developer Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-alarms.html#cfn-iotsitewise-portal-alarms-notificationlambdaarn */ readonly notificationLambdaArn?: string; } /** * Container associated a certain PortalType. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-portaltypeentry.html */ interface PortalTypeEntryProperty { /** * The array of tools associated with the specified portal type. * * The possible values are `ASSISTANT` and `DASHBOARD` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-portaltypeentry.html#cfn-iotsitewise-portal-portaltypeentry-portaltools */ readonly portalTools: Array; } } /** * Properties for defining a `CfnPortal` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html */ export interface CfnPortalProps { /** * Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. * * You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see [Monitoring with alarms](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) in the *AWS IoT SiteWise Application Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-alarms */ readonly alarms?: any | cdk.IResolvable; /** * The email address that sends alarm notifications. * * > If you use the [AWS IoT Events managed Lambda function](https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) to manage your emails, you must [verify the sender email address in Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-notificationsenderemail */ readonly notificationSenderEmail?: string; /** * The service to use to authenticate users to the portal. Choose from the following options:. * * - `SSO` – The portal uses SSOlong to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see [Enabling IAM Identity Center](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso) in the *AWS IoT SiteWise User Guide* . This option is only available in AWS Regions other than the China Regions. * - `IAM` – The portal uses AWS Identity and Access Management to authenticate users and manage user permissions. * * You can't change this value after you create a portal. * * Default: `SSO` * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portalauthmode */ readonly portalAuthMode?: string; /** * The AWS administrator's contact email address. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portalcontactemail */ readonly portalContactEmail: string; /** * A description for the portal. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portaldescription */ readonly portalDescription?: string; /** * A friendly name for the portal. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portalname */ readonly portalName: string; /** * Define the type of portal. * * The value for AWS IoT SiteWise Monitor (Classic) is `SITEWISE_PORTAL_V1` . The value for AWS IoT SiteWise Monitor (AI-aware) is `SITEWISE_PORTAL_V2` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portaltype */ readonly portalType?: string; /** * Map to associate detail of configuration related with a PortalType. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portaltypeconfiguration */ readonly portalTypeConfiguration?: cdk.IResolvable | Record; /** * The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see [Using service roles for AWS IoT SiteWise Monitor](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-rolearn */ readonly roleArn: string; /** * A list of key-value pairs that contain metadata for the portal. * * For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-tags */ readonly tags?: Array; } /** * > The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 . * * If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS IoT SiteWise Monitor availability change](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html) . * * Creates a project in the specified portal. * * > Make sure that the project name and description don't contain confidential information. * * @cloudformationResource AWS::IoTSiteWise::Project * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html */ export declare class CfnProject extends cdk.CfnResource implements cdk.IInspectable, IProjectRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnProject from CloudFormation properties * * 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. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnProject; /** * Checks whether the given object is a CfnProject */ static isCfnProject(x: any): x is CfnProject; /** * Creates a new IProjectRef from an ARN */ static fromProjectArn(scope: constructs.Construct, id: string, arn: string): IProjectRef; /** * Creates a new IProjectRef from a projectId */ static fromProjectId(scope: constructs.Construct, id: string, projectId: string): IProjectRef; static arnForProject(resource: IProjectRef): string; /** * A list that contains the IDs of each asset associated with the project. */ private _assetIds?; /** * The ID of the portal in which to create the project. */ private _portalId; /** * A description for the project. */ private _projectDescription?; /** * A friendly name for the project. */ private _projectName; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * A list of key-value pairs that contain metadata for the project. */ private _tagsRaw?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::IoTSiteWise::Project`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnProjectProps); get projectRef(): ProjectReference; /** * A list that contains the IDs of each asset associated with the project. */ get assetIds(): Array | undefined; /** * A list that contains the IDs of each asset associated with the project. */ set assetIds(value: Array | undefined); /** * The ID of the portal in which to create the project. */ get portalId(): string; /** * The ID of the portal in which to create the project. */ set portalId(value: string); /** * A description for the project. */ get projectDescription(): string | undefined; /** * A description for the project. */ set projectDescription(value: string | undefined); /** * A friendly name for the project. */ get projectName(): string; /** * A friendly name for the project. */ set projectName(value: string); /** * A list of key-value pairs that contain metadata for the project. */ get tagsRaw(): Array | undefined; /** * A list of key-value pairs that contain metadata for the project. */ set tagsRaw(value: Array | undefined); /** * The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the project, which has the following format. * * `arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}` * * @cloudformationAttribute ProjectArn */ get attrProjectArn(): string; /** * The ID of the project. * * @cloudformationAttribute ProjectId */ get attrProjectId(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } /** * Properties for defining a `CfnProject` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html */ export interface CfnProjectProps { /** * A list that contains the IDs of each asset associated with the project. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html#cfn-iotsitewise-project-assetids */ readonly assetIds?: Array; /** * The ID of the portal in which to create the project. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html#cfn-iotsitewise-project-portalid */ readonly portalId: string; /** * A description for the project. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html#cfn-iotsitewise-project-projectdescription */ readonly projectDescription?: string; /** * A friendly name for the project. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html#cfn-iotsitewise-project-projectname */ readonly projectName: string; /** * A list of key-value pairs that contain metadata for the project. * * For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-project.html#cfn-iotsitewise-project-tags */ readonly tags?: Array; } /** * Create a computation model with a configuration and data binding. * * @cloudformationResource AWS::IoTSiteWise::ComputationModel * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-computationmodel.html */ export declare class CfnComputationModel extends cdk.CfnResource implements cdk.IInspectable, IComputationModelRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnComputationModel from CloudFormation properties * * 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. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnComputationModel; /** * Checks whether the given object is a CfnComputationModel */ static isCfnComputationModel(x: any): x is CfnComputationModel; /** * Creates a new IComputationModelRef from an ARN */ static fromComputationModelArn(scope: constructs.Construct, id: string, arn: string): IComputationModelRef; /** * Creates a new IComputationModelRef from a computationModelId */ static fromComputationModelId(scope: constructs.Construct, id: string, computationModelId: string): IComputationModelRef; static arnForComputationModel(resource: IComputationModelRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * The configuration for the computation model. */ private _computationModelConfiguration; /** * The data binding for the computation model. */ private _computationModelDataBinding; /** * The description of the computation model. */ private _computationModelDescription?; /** * The name of the computation model. */ private _computationModelName; /** * A list of key-value pairs that contain metadata for the asset. */ private _tags?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::IoTSiteWise::ComputationModel`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnComputationModelProps); get computationModelRef(): ComputationModelReference; /** * The configuration for the computation model. */ get computationModelConfiguration(): CfnComputationModel.ComputationModelConfigurationProperty | cdk.IResolvable; /** * The configuration for the computation model. */ set computationModelConfiguration(value: CfnComputationModel.ComputationModelConfigurationProperty | cdk.IResolvable); /** * The data binding for the computation model. */ get computationModelDataBinding(): cdk.IResolvable | Record; /** * The data binding for the computation model. */ set computationModelDataBinding(value: cdk.IResolvable | Record); /** * The description of the computation model. */ get computationModelDescription(): string | undefined; /** * The description of the computation model. */ set computationModelDescription(value: string | undefined); /** * The name of the computation model. */ get computationModelName(): string; /** * The name of the computation model. */ set computationModelName(value: string); /** * A list of key-value pairs that contain metadata for the asset. */ get tags(): Array | undefined; /** * A list of key-value pairs that contain metadata for the asset. */ set tags(value: Array | undefined); /** * The ARN of the computation model, which has the following format. * * `arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}` * * @cloudformationAttribute ComputationModelArn */ get attrComputationModelArn(): string; /** * The ID of the computation model. * * @cloudformationAttribute ComputationModelId */ get attrComputationModelId(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnComputationModel { /** * The configuration for the computation model. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-computationmodel-computationmodelconfiguration.html */ interface ComputationModelConfigurationProperty { /** * The configuration for the anomaly detection type of computation model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-computationmodel-computationmodelconfiguration.html#cfn-iotsitewise-computationmodel-computationmodelconfiguration-anomalydetection */ readonly anomalyDetection?: CfnComputationModel.AnomalyDetectionComputationModelConfigurationProperty | cdk.IResolvable; } /** * Contains the configuration for anomaly detection computation models. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-computationmodel-anomalydetectioncomputationmodelconfiguration.html */ interface AnomalyDetectionComputationModelConfigurationProperty { /** * The list of input properties for the anomaly detection model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-computationmodel-anomalydetectioncomputationmodelconfiguration.html#cfn-iotsitewise-computationmodel-anomalydetectioncomputationmodelconfiguration-inputproperties */ readonly inputProperties: string; /** * The property where the anomaly detection results will be stored. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-computationmodel-anomalydetectioncomputationmodelconfiguration.html#cfn-iotsitewise-computationmodel-anomalydetectioncomputationmodelconfiguration-resultproperty */ readonly resultProperty: string; } /** * Contains computation model data binding value information, which can be one of `assetModelProperty` , `list` . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-computationmodel-computationmodeldatabindingvalue.html */ interface ComputationModelDataBindingValueProperty { /** * Specifies an asset model property data binding value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-computationmodel-computationmodeldatabindingvalue.html#cfn-iotsitewise-computationmodel-computationmodeldatabindingvalue-assetmodelproperty */ readonly assetModelProperty?: CfnComputationModel.AssetModelPropertyBindingValueProperty | cdk.IResolvable; /** * The asset property value used for computation model data binding. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-computationmodel-computationmodeldatabindingvalue.html#cfn-iotsitewise-computationmodel-computationmodeldatabindingvalue-assetproperty */ readonly assetProperty?: CfnComputationModel.AssetPropertyBindingValueProperty | cdk.IResolvable; /** * Specifies a list of data binding value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-computationmodel-computationmodeldatabindingvalue.html#cfn-iotsitewise-computationmodel-computationmodeldatabindingvalue-list */ readonly list?: Array | cdk.IResolvable; } /** * Contains information about an `assetModelProperty` binding value. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-computationmodel-assetmodelpropertybindingvalue.html */ interface AssetModelPropertyBindingValueProperty { /** * The ID of the asset model, in UUID format. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-computationmodel-assetmodelpropertybindingvalue.html#cfn-iotsitewise-computationmodel-assetmodelpropertybindingvalue-assetmodelid */ readonly assetModelId: string; /** * The ID of the asset model property used in data binding value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-computationmodel-assetmodelpropertybindingvalue.html#cfn-iotsitewise-computationmodel-assetmodelpropertybindingvalue-propertyid */ readonly propertyId: string; } /** * Represents a data binding value referencing a specific asset property. * * It's used to bind computation model variables to actual asset property values for processing. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-computationmodel-assetpropertybindingvalue.html */ interface AssetPropertyBindingValueProperty { /** * The ID of the asset containing the property. * * This identifies the specific asset instance's property value used in the computation model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-computationmodel-assetpropertybindingvalue.html#cfn-iotsitewise-computationmodel-assetpropertybindingvalue-assetid */ readonly assetId: string; /** * The ID of the property within the asset. * * This identifies the specific property's value used in the computation model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-computationmodel-assetpropertybindingvalue.html#cfn-iotsitewise-computationmodel-assetpropertybindingvalue-propertyid */ readonly propertyId: string; } } /** * Properties for defining a `CfnComputationModel` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-computationmodel.html */ export interface CfnComputationModelProps { /** * The configuration for the computation model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-computationmodel.html#cfn-iotsitewise-computationmodel-computationmodelconfiguration */ readonly computationModelConfiguration: CfnComputationModel.ComputationModelConfigurationProperty | cdk.IResolvable; /** * The data binding for the computation model. * * Key is a variable name defined in configuration. Value is a `ComputationModelDataBindingValue` referenced by the variable. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-computationmodel.html#cfn-iotsitewise-computationmodel-computationmodeldatabinding */ readonly computationModelDataBinding: cdk.IResolvable | Record; /** * The description of the computation model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-computationmodel.html#cfn-iotsitewise-computationmodel-computationmodeldescription */ readonly computationModelDescription?: string; /** * The name of the computation model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-computationmodel.html#cfn-iotsitewise-computationmodel-computationmodelname */ readonly computationModelName: string; /** * A list of key-value pairs that contain metadata for the asset. * * For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-computationmodel.html#cfn-iotsitewise-computationmodel-tags */ readonly tags?: Array; } /** * Creates a dataset to connect an external datasource. * * @cloudformationResource AWS::IoTSiteWise::Dataset * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dataset.html */ export declare class CfnDataset extends cdk.CfnResource implements cdk.IInspectable, IDatasetRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnDataset from CloudFormation properties * * 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. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDataset; /** * Checks whether the given object is a CfnDataset */ static isCfnDataset(x: any): x is CfnDataset; /** * Creates a new IDatasetRef from an ARN */ static fromDatasetArn(scope: constructs.Construct, id: string, arn: string): IDatasetRef; /** * Creates a new IDatasetRef from a datasetId */ static fromDatasetId(scope: constructs.Construct, id: string, datasetId: string): IDatasetRef; static arnForDataset(resource: IDatasetRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * A description about the dataset, and its functionality. */ private _datasetDescription?; /** * The name of the dataset. */ private _datasetName; /** * The data source for the dataset. */ private _datasetSource; /** * A list of key-value pairs that contain metadata for the access policy. */ private _tags?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::IoTSiteWise::Dataset`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnDatasetProps); get datasetRef(): DatasetReference; /** * A description about the dataset, and its functionality. */ get datasetDescription(): string | undefined; /** * A description about the dataset, and its functionality. */ set datasetDescription(value: string | undefined); /** * The name of the dataset. */ get datasetName(): string; /** * The name of the dataset. */ set datasetName(value: string); /** * The data source for the dataset. */ get datasetSource(): CfnDataset.DatasetSourceProperty | cdk.IResolvable; /** * The data source for the dataset. */ set datasetSource(value: CfnDataset.DatasetSourceProperty | cdk.IResolvable); /** * A list of key-value pairs that contain metadata for the access policy. */ get tags(): Array | undefined; /** * A list of key-value pairs that contain metadata for the access policy. */ set tags(value: Array | undefined); /** * The ARN of the dataset, which has the following format. * * `arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}` * * @cloudformationAttribute DatasetArn */ get attrDatasetArn(): string; /** * The ID of the dataset. * * @cloudformationAttribute DatasetId */ get attrDatasetId(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnDataset { /** * The data source for the dataset. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-dataset-datasetsource.html */ interface DatasetSourceProperty { /** * The details of the dataset source associated with the dataset. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-dataset-datasetsource.html#cfn-iotsitewise-dataset-datasetsource-sourcedetail */ readonly sourceDetail?: cdk.IResolvable | CfnDataset.SourceDetailProperty; /** * The format of the dataset source associated with the dataset. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-dataset-datasetsource.html#cfn-iotsitewise-dataset-datasetsource-sourceformat */ readonly sourceFormat: string; /** * The type of data source for the dataset. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-dataset-datasetsource.html#cfn-iotsitewise-dataset-datasetsource-sourcetype */ readonly sourceType: string; } /** * The details of the dataset source associated with the dataset. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-dataset-sourcedetail.html */ interface SourceDetailProperty { /** * Contains details about the Kendra dataset source. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-dataset-sourcedetail.html#cfn-iotsitewise-dataset-sourcedetail-kendra */ readonly kendra?: cdk.IResolvable | CfnDataset.KendraSourceDetailProperty; } /** * The source details for the Kendra dataset source. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-dataset-kendrasourcedetail.html */ interface KendraSourceDetailProperty { /** * The `knowledgeBaseArn` details for the Kendra dataset source. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-dataset-kendrasourcedetail.html#cfn-iotsitewise-dataset-kendrasourcedetail-knowledgebasearn */ readonly knowledgeBaseArn: string; /** * The `roleARN` details for the Kendra dataset source. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-dataset-kendrasourcedetail.html#cfn-iotsitewise-dataset-kendrasourcedetail-rolearn */ readonly roleArn: string; } } /** * Properties for defining a `CfnDataset` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dataset.html */ export interface CfnDatasetProps { /** * A description about the dataset, and its functionality. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dataset.html#cfn-iotsitewise-dataset-datasetdescription */ readonly datasetDescription?: string; /** * The name of the dataset. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dataset.html#cfn-iotsitewise-dataset-datasetname */ readonly datasetName: string; /** * The data source for the dataset. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dataset.html#cfn-iotsitewise-dataset-datasetsource */ readonly datasetSource: CfnDataset.DatasetSourceProperty | cdk.IResolvable; /** * A list of key-value pairs that contain metadata for the access policy. * * For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the *AWS IoT SiteWise User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dataset.html#cfn-iotsitewise-dataset-tags */ readonly tags?: Array; } export type { IAccessPolicyRef, AccessPolicyReference }; export type { IAssetRef, AssetReference }; export type { IAssetModelRef, AssetModelReference }; export type { IDashboardRef, DashboardReference }; export type { IGatewayRef, GatewayReference }; export type { IPortalRef, PortalReference }; export type { IProjectRef, ProjectReference }; export type { IComputationModelRef, ComputationModelReference }; export type { IDatasetRef, DatasetReference };