AWS::IoTSiteWise::Dataset - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

AWS::IoTSiteWise::Dataset

Creates a dataset to connect an external datasource.

Syntax

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

JSON

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

YAML

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

Properties

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: Yes

Type: DatasetSource

Update requires: No interruption

Tags

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

Required: No

Type: Array of Tag

Update requires: No interruption

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.