Package software.amazon.awscdk.services.iotsitewise

Class CfnDataset

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iotsitewise.CfnDataset
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IDatasetRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:38.503Z") @Stability(Stable) public class CfnDataset extends CfnResource implements IInspectable, IDatasetRef, ITaggableV2
Creates a dataset to connect an external datasource.

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.*;
 CfnDataset cfnDataset = CfnDataset.Builder.create(this, "MyCfnDataset")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDataset

      protected CfnDataset(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDataset

      protected CfnDataset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDataset

      @Stability(Stable) public CfnDataset(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDatasetProps props)
      Create a new AWS::IoTSiteWise::Dataset.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForDataset

      @Stability(Stable) @NotNull public static String arnForDataset(@NotNull IDatasetRef resource)
      Parameters:
      resource - This parameter is required.

    • fromDatasetArn

      @Stability(Stable) @NotNull public static IDatasetRef fromDatasetArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IDatasetRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromDatasetId

      @Stability(Stable) @NotNull public static IDatasetRef fromDatasetId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String datasetId)
      Creates a new IDatasetRef from a datasetId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      datasetId - This parameter is required.

    • isCfnDataset

      @Stability(Stable) @NotNull public static Boolean isCfnDataset(@NotNull Object x)
      Checks whether the given object is a CfnDataset.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDatasetArn

      @Stability(Stable) @NotNull public String getAttrDatasetArn()
      The ARN of the dataset, which has the following format.

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

    • getAttrDatasetId

      @Stability(Stable) @NotNull public String getAttrDatasetId()
      The ID of the dataset.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDatasetRef

      @Stability(Stable) @NotNull public DatasetReference getDatasetRef()
      A reference to a Dataset resource.
      Specified by:
      getDatasetRef in interface IDatasetRef

    • getDatasetName

      @Stability(Stable) @NotNull public String getDatasetName()
      The name of the dataset.

    • setDatasetName

      @Stability(Stable) public void setDatasetName(@NotNull String value)
      The name of the dataset.

    • getDatasetSource

      @Stability(Stable) @NotNull public Object getDatasetSource()
      The data source for the dataset.

      Returns union: either IResolvable or CfnDataset.DatasetSourceProperty

    • setDatasetSource

      @Stability(Stable) public void setDatasetSource(@NotNull IResolvable value)
      The data source for the dataset.

    • setDatasetSource

      @Stability(Stable) public void setDatasetSource(@NotNull CfnDataset.DatasetSourceProperty value)
      The data source for the dataset.

    • getDatasetDescription

      @Stability(Stable) @Nullable public String getDatasetDescription()
      A description about the dataset, and its functionality.

    • setDatasetDescription

      @Stability(Stable) public void setDatasetDescription(@Nullable String value)
      A description about the dataset, and its functionality.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of key-value pairs that contain metadata for the access policy.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of key-value pairs that contain metadata for the access policy.