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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::IoTSiteWise::Dataset
<a name="aws-resource-iotsitewise-dataset"></a>

Creates a dataset to connect an external datasource.

## Syntax
<a name="aws-resource-iotsitewise-dataset-syntax"></a>

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

### JSON
<a name="aws-resource-iotsitewise-dataset-syntax.json"></a>

```
{
  "Type" : "AWS::IoTSiteWise::Dataset",
  "Properties" : {
      "[DatasetConfig](#cfn-iotsitewise-dataset-datasetconfig)" : {{DatasetConfig}},
      "[DatasetDescription](#cfn-iotsitewise-dataset-datasetdescription)" : {{String}},
      "[DatasetName](#cfn-iotsitewise-dataset-datasetname)" : {{String}},
      "[DatasetSource](#cfn-iotsitewise-dataset-datasetsource)" : {{DatasetSource}},
      "[DatasetType](#cfn-iotsitewise-dataset-datasettype)" : {{String}},
      "[Tags](#cfn-iotsitewise-dataset-tags)" : {{[ Tag, ... ]}},
      "[WorkspaceName](#cfn-iotsitewise-dataset-workspacename)" : {{String}}
    }
}
```

### YAML
<a name="aws-resource-iotsitewise-dataset-syntax.yaml"></a>

```
Type: AWS::IoTSiteWise::Dataset
Properties:
  [DatasetConfig](#cfn-iotsitewise-dataset-datasetconfig): {{
    DatasetConfig}}
  [DatasetDescription](#cfn-iotsitewise-dataset-datasetdescription): {{String}}
  [DatasetName](#cfn-iotsitewise-dataset-datasetname): {{String}}
  [DatasetSource](#cfn-iotsitewise-dataset-datasetsource): {{
    DatasetSource}}
  [DatasetType](#cfn-iotsitewise-dataset-datasettype): {{String}}
  [Tags](#cfn-iotsitewise-dataset-tags): {{
    - Tag}}
  [WorkspaceName](#cfn-iotsitewise-dataset-workspacename): {{String}}
```

## Properties
<a name="aws-resource-iotsitewise-dataset-properties"></a>

`DatasetConfig`  <a name="cfn-iotsitewise-dataset-datasetconfig"></a>
The configuration for the dataset. Provide the session configuration for a `SESSION` dataset.  
*Required*: No  
*Type*: [DatasetConfig](aws-properties-iotsitewise-dataset-datasetconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatasetDescription`  <a name="cfn-iotsitewise-dataset-datasetdescription"></a>
A description about the dataset, and its functionality.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatasetName`  <a name="cfn-iotsitewise-dataset-datasetname"></a>
The name of the dataset.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatasetSource`  <a name="cfn-iotsitewise-dataset-datasetsource"></a>
The data source for the dataset. This property is required for `EXTERNAL` datasets (for example, an Amazon Kendra index) and is omitted for workspace-scoped `SESSION` and `CURATED` datasets.  
*Required*: No  
*Type*: [DatasetSource](aws-properties-iotsitewise-dataset-datasetsource.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatasetType`  <a name="cfn-iotsitewise-dataset-datasettype"></a>
The type of the dataset. Valid values:  
+ `SESSION`: A workspace-scoped dataset backed by a time range of time-series data. Specify `WorkspaceName` and `DatasetConfig`.
+ `CURATED`: A workspace-scoped dataset whose data segments are curated through an interactive application workflow. Specify `WorkspaceName`.
+ `EXTERNAL`: A dataset backed by an external knowledge base, such as an Amazon Kendra index. Specify `DatasetSource`.
You can't change the dataset type after you create the dataset. Changing this property requires replacing the resource.  
*Required*: No  
*Type*: String  
*Allowed values*: `SESSION | CURATED | EXTERNAL`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-iotsitewise-dataset-tags"></a>
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*.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-iotsitewise-dataset-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WorkspaceName`  <a name="cfn-iotsitewise-dataset-workspacename"></a>
The name of the workspace that the dataset belongs to. This property is required for workspace-scoped `SESSION` and `CURATED` datasets and is omitted for `EXTERNAL` datasets.  
You can't change the workspace after you create the dataset. Changing this property requires replacing the resource.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_-]+$`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-iotsitewise-dataset-return-values"></a>

### Ref
<a name="aws-resource-iotsitewise-dataset-return-values-ref"></a>

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

### Fn::GetAtt
<a name="aws-resource-iotsitewise-dataset-return-values-fn--getatt"></a>

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`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-iotsitewise-dataset-return-values-fn--getatt-fn--getatt"></a>

`DatasetArn`  <a name="DatasetArn-fn::getatt"></a>
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`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

`DatasetId`  <a name="DatasetId-fn::getatt"></a>
The ID of the dataset.  
For more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).