CfnDatasetPropsMixin

class aws_cdk.mixins_preview.aws_iotsitewise.mixins.CfnDatasetPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a dataset to connect an external datasource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dataset.html
CloudformationResource:: AWS::IoTSiteWise::Dataset
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

cfn_dataset_props_mixin = iotsitewise_mixins.CfnDatasetPropsMixin(iotsitewise_mixins.CfnDatasetMixinProps(
    dataset_description="datasetDescription",
    dataset_name="datasetName",
    dataset_source=iotsitewise_mixins.CfnDatasetPropsMixin.DatasetSourceProperty(
        source_detail=iotsitewise_mixins.CfnDatasetPropsMixin.SourceDetailProperty(
            kendra=iotsitewise_mixins.CfnDatasetPropsMixin.KendraSourceDetailProperty(
                knowledge_base_arn="knowledgeBaseArn",
                role_arn="roleArn"
            )
        ),
        source_format="sourceFormat",
        source_type="sourceType"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTSiteWise::Dataset.

Parameters:

props (Union[CfnDatasetMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['datasetDescription', 'datasetName', 'datasetSource', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DatasetSourceProperty

class CfnDatasetPropsMixin.DatasetSourceProperty(*, source_detail=None, source_format=None, source_type=None)

Bases: object

The data source for the dataset.

Parameters:

source_detail (Union[IResolvable, SourceDetailProperty, Dict[str, Any], None]) – The details of the dataset source associated with the dataset.
source_format (Optional[str]) – The format of the dataset source associated with the dataset.
source_type (Optional[str]) – The type of data source for the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-dataset-datasetsource.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.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

dataset_source_property = iotsitewise_mixins.CfnDatasetPropsMixin.DatasetSourceProperty(
    source_detail=iotsitewise_mixins.CfnDatasetPropsMixin.SourceDetailProperty(
        kendra=iotsitewise_mixins.CfnDatasetPropsMixin.KendraSourceDetailProperty(
            knowledge_base_arn="knowledgeBaseArn",
            role_arn="roleArn"
        )
    ),
    source_format="sourceFormat",
    source_type="sourceType"
)

Attributes

source_detail

The details of the dataset source associated with the dataset.

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

source_format

The format of the dataset source associated with the dataset.

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

source_type

The type of data source for the dataset.

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

KendraSourceDetailProperty

class CfnDatasetPropsMixin.KendraSourceDetailProperty(*, knowledge_base_arn=None, role_arn=None)

Bases: object

The source details for the Kendra dataset source.

Parameters:

knowledge_base_arn (Optional[str]) – The knowledgeBaseArn details for the Kendra dataset source.
role_arn (Optional[str]) – The roleARN details for the Kendra dataset source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-dataset-kendrasourcedetail.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.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

kendra_source_detail_property = iotsitewise_mixins.CfnDatasetPropsMixin.KendraSourceDetailProperty(
    knowledge_base_arn="knowledgeBaseArn",
    role_arn="roleArn"
)

Attributes

knowledge_base_arn

The knowledgeBaseArn details for the Kendra dataset source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-dataset-kendrasourcedetail.html#cfn-iotsitewise-dataset-kendrasourcedetail-knowledgebasearn

role_arn

The roleARN details for the Kendra dataset source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-dataset-kendrasourcedetail.html#cfn-iotsitewise-dataset-kendrasourcedetail-rolearn

SourceDetailProperty

class CfnDatasetPropsMixin.SourceDetailProperty(*, kendra=None)

Bases: object

The details of the dataset source associated with the dataset.

Parameters:: kendra (Union[IResolvable, KendraSourceDetailProperty, Dict[str, Any], None]) – Contains details about the Kendra dataset source.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-dataset-sourcedetail.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.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

source_detail_property = iotsitewise_mixins.CfnDatasetPropsMixin.SourceDetailProperty(
    kendra=iotsitewise_mixins.CfnDatasetPropsMixin.KendraSourceDetailProperty(
        knowledge_base_arn="knowledgeBaseArn",
        role_arn="roleArn"
    )
)

Attributes

kendra

Contains details about the Kendra dataset source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-dataset-sourcedetail.html#cfn-iotsitewise-dataset-sourcedetail-kendra