CfnDatasetProps

class aws_cdk.aws_iotsitewise.CfnDatasetProps(*, dataset_name, dataset_source, dataset_description=None, tags=None)

Bases: object

Properties for defining a CfnDataset.

Parameters:

  • dataset_name (str) – The name of the dataset.

  • dataset_source (Union[IResolvable, DatasetSourceProperty, Dict[str, Any]]) – The data source for the dataset.

  • dataset_description (Optional[str]) – A description about the dataset, and its functionality.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotsitewise as iotsitewise

cfn_dataset_props = iotsitewise.CfnDatasetProps(
    dataset_name="datasetName",
    dataset_source=iotsitewise.CfnDataset.DatasetSourceProperty(
        source_format="sourceFormat",
        source_type="sourceType",

        # the properties below are optional
        source_detail=iotsitewise.CfnDataset.SourceDetailProperty(
            kendra=iotsitewise.CfnDataset.KendraSourceDetailProperty(
                knowledge_base_arn="knowledgeBaseArn",
                role_arn="roleArn"
            )
        )
    ),

    # the properties below are optional
    dataset_description="datasetDescription",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

dataset_description

A description about the dataset, and its functionality.

See:

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

dataset_name

The name of the dataset.

See:

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

dataset_source

The data source for the dataset.

See:

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

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 .

See:

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