View a markdown version of this page

AWS::IoTSiteWise::Dataset - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::IoTSiteWise::Dataset

Creates a dataset to connect an external datasource.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoTSiteWise::Dataset",
  "Properties" : {
      "DatasetConfig" : DatasetConfig,
      "DatasetDescription" : String,
      "DatasetName" : String,
      "DatasetSource" : DatasetSource,
      "DatasetType" : String,
      "Tags" : [ Tag, ... ],
      "WorkspaceName" : String
    }
}

YAML

Type: AWS::IoTSiteWise::Dataset
Properties:
  DatasetConfig: 
    DatasetConfig
  DatasetDescription: String
  DatasetName: String
  DatasetSource: 
    DatasetSource
  DatasetType: String
  Tags: 
    - Tag
  WorkspaceName: String

Properties

DatasetConfig

Property description not available.

Required: No

Type: DatasetConfig

Update requires: No interruption

DatasetDescription

A description about the dataset, and its functionality.

Required: No

Type: String

Update requires: No interruption

DatasetName

The name of the dataset.

Required: Yes

Type: String

Update requires: No interruption

DatasetSource

The data source for the dataset.

Required: No

Type: DatasetSource

Update requires: No interruption

DatasetType

The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.

Required: No

Type: String

Allowed values: SESSION | CURATED | EXTERNAL

Update requires: Replacement

Tags

A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Required: No

Type: Array of Tag

Update requires: No interruption

WorkspaceName

Property description not available.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 64

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the DatasetId.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

DatasetArn

The ARN of the dataset, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}

For more information about using the Ref function, see Ref.

DatasetId

The ID of the dataset.

For more information about using the Ref function, see Ref.