Package software.amazon.awscdk.services.iotsitewise

Interface CfnDatasetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDatasetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:38.505Z")
@Stability(Stable)
public interface CfnDatasetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDataset.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotsitewise.*;
 CfnDatasetProps cfnDatasetProps = CfnDatasetProps.builder()
         .datasetName("datasetName")
         .datasetSource(DatasetSourceProperty.builder()
                 .sourceFormat("sourceFormat")
                 .sourceType("sourceType")
                 // the properties below are optional
                 .sourceDetail(SourceDetailProperty.builder()
                         .kendra(KendraSourceDetailProperty.builder()
                                 .knowledgeBaseArn("knowledgeBaseArn")
                                 .roleArn("roleArn")
                                 .build())
                         .build())
                 .build())
         // the properties below are optional
         .datasetDescription("datasetDescription")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dataset.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDatasetProps.Builder	A builder for CfnDatasetProps
static final class	CfnDatasetProps.Jsii$Proxy	An implementation for CfnDatasetProps

Method Summary

Modifier and Type	Method	Description
static CfnDatasetProps.Builder	builder()
default String	getDatasetDescription()	A description about the dataset, and its functionality.
String	getDatasetName()	The name of the dataset.
Object	getDatasetSource()	The data source for the dataset.
default List<CfnTag>	getTags()	A list of key-value pairs that contain metadata for the access policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatasetName

@Stability(Stable)
@NotNull
String getDatasetName()

The name of the dataset.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dataset.html#cfn-iotsitewise-dataset-datasetname

getDatasetSource

@Stability(Stable)
@NotNull
Object getDatasetSource()

The data source for the dataset.

Returns union: either IResolvable or CfnDataset.DatasetSourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dataset.html#cfn-iotsitewise-dataset-datasetsource

getDatasetDescription

@Stability(Stable)
@Nullable
default String getDatasetDescription()

A description about the dataset, and its functionality.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dataset.html#cfn-iotsitewise-dataset-datasetdescription

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dataset.html#cfn-iotsitewise-dataset-tags

builder

@Stability(Stable)
static CfnDatasetProps.Builder builder()

Returns:

a CfnDatasetProps.Builder of CfnDatasetProps