Class CfnDataset

The AWS::IoTAnalytics::Dataset resource stores data retrieved from a data store by applying a queryAction (an SQL query) or a containerAction (executing a containerized application).

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnDataset
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.IoTAnalytics
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDataset : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDataset
    Inherits CfnResource
    Implements IInspectable, ITaggable
Remarks

The data set can be populated manually by calling CreateDatasetContent or automatically according to a trigger you specify. For more information, see How to Use AWS IoT Analytics in the AWS IoT Analytics User Guide .

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

CloudformationResource: AWS::IoTAnalytics::Dataset

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTAnalytics;

var cfnDataset = new CfnDataset(this, "MyCfnDataset", new CfnDatasetProps {
    Actions = new [] { new ActionProperty {
        ActionName = "actionName",

        // the properties below are optional
        ContainerAction = new ContainerActionProperty {
            ExecutionRoleArn = "executionRoleArn",
            Image = "image",
            ResourceConfiguration = new ResourceConfigurationProperty {
                ComputeType = "computeType",
                VolumeSizeInGb = 123
            },

            // the properties below are optional
            Variables = new [] { new VariableProperty {
                VariableName = "variableName",

                // the properties below are optional
                DatasetContentVersionValue = new DatasetContentVersionValueProperty {
                    DatasetName = "datasetName"
                },
                DoubleValue = 123,
                OutputFileUriValue = new OutputFileUriValueProperty {
                    FileName = "fileName"
                },
                StringValue = "stringValue"
            } }
        },
        QueryAction = new QueryActionProperty {
            SqlQuery = "sqlQuery",

            // the properties below are optional
            Filters = new [] { new FilterProperty {
                DeltaTime = new DeltaTimeProperty {
                    OffsetSeconds = 123,
                    TimeExpression = "timeExpression"
                }
            } }
        }
    } },

    // the properties below are optional
    ContentDeliveryRules = new [] { new DatasetContentDeliveryRuleProperty {
        Destination = new DatasetContentDeliveryRuleDestinationProperty {
            IotEventsDestinationConfiguration = new IotEventsDestinationConfigurationProperty {
                InputName = "inputName",
                RoleArn = "roleArn"
            },
            S3DestinationConfiguration = new S3DestinationConfigurationProperty {
                Bucket = "bucket",
                Key = "key",
                RoleArn = "roleArn",

                // the properties below are optional
                GlueConfiguration = new GlueConfigurationProperty {
                    DatabaseName = "databaseName",
                    TableName = "tableName"
                }
            }
        },

        // the properties below are optional
        EntryName = "entryName"
    } },
    DatasetName = "datasetName",
    LateDataRules = new [] { new LateDataRuleProperty {
        RuleConfiguration = new LateDataRuleConfigurationProperty {
            DeltaTimeSessionWindowConfiguration = new DeltaTimeSessionWindowConfigurationProperty {
                TimeoutInMinutes = 123
            }
        },

        // the properties below are optional
        RuleName = "ruleName"
    } },
    RetentionPeriod = new RetentionPeriodProperty {
        NumberOfDays = 123,
        Unlimited = false
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    Triggers = new [] { new TriggerProperty {
        Schedule = new ScheduleProperty {
            ScheduleExpression = "scheduleExpression"
        },
        TriggeringDataset = new TriggeringDatasetProperty {
            DatasetName = "datasetName"
        }
    } },
    VersioningConfiguration = new VersioningConfigurationProperty {
        MaxVersions = 123,
        Unlimited = false
    }
});

Synopsis

Constructors

CfnDataset(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnDataset(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnDataset(Construct, String, ICfnDatasetProps)

Properties

Actions

The DatasetAction objects that automatically create the dataset contents.
AttrId
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
ContentDeliveryRules

When dataset contents are created they are delivered to destinations specified here.
DatasetName

The name of the dataset.
LateDataRules

A list of data rules that send notifications to CloudWatch, when data arrives late.
RetentionPeriod

Optional.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

Metadata which can be used to manage the data set.
Triggers

The DatasetTrigger objects that specify when the dataset is automatically updated.
VersioningConfiguration

Optional.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnDataset(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnDataset(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnDataset(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnDataset(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnDataset(Construct, String, ICfnDatasetProps)

public CfnDataset(Construct scope, string id, ICfnDatasetProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnDatasetProps

Resource properties.

Properties

Actions

The DatasetAction objects that automatically create the dataset contents.

public virtual object Actions { get; set; }
Property Value

System.Object

AttrId

public virtual string AttrId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

ContentDeliveryRules

When dataset contents are created they are delivered to destinations specified here.

public virtual object ContentDeliveryRules { get; set; }
Property Value

System.Object

DatasetName

The name of the dataset.

public virtual string DatasetName { get; set; }
Property Value

System.String

LateDataRules

A list of data rules that send notifications to CloudWatch, when data arrives late.

public virtual object LateDataRules { get; set; }
Property Value

System.Object

RetentionPeriod

Optional.

public virtual object RetentionPeriod { get; set; }
Property Value

System.Object

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

Metadata which can be used to manage the data set.

public virtual ICfnTag[] TagsRaw { get; set; }
Property Value

ICfnTag[]

Triggers

The DatasetTrigger objects that specify when the dataset is automatically updated.

public virtual object Triggers { get; set; }
Property Value

System.Object

VersioningConfiguration

Optional.

public virtual object VersioningConfiguration { get; set; }
Property Value

System.Object

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements