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

object

CfnElement

CfnRefElement

CfnResource

CfnDataset

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

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(Construct, string, ICfnDatasetProps)

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).

Properties

Actions	The DatasetAction objects that automatically create the dataset contents.
AttrId	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).
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	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).
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>)	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).

Constructors

CfnDataset(Construct, string, ICfnDatasetProps)

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).

public CfnDataset(Construct scope, string id, ICfnDatasetProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

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

props ICfnDatasetProps

Resource properties.

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

Properties

Actions

The DatasetAction objects that automatically create the dataset contents.

public virtual object Actions { get; set; }

Property Value

object

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

AttrId

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).

public virtual string AttrId { get; }

Property Value

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

string

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

CfnProperties

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).

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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

ContentDeliveryRules

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

public virtual object? ContentDeliveryRules { get; set; }

Property Value

object

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

DatasetName

The name of the dataset.

public virtual string? DatasetName { get; set; }

Property Value

string

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

LateDataRules

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

public virtual object? LateDataRules { get; set; }

Property Value

object

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

RetentionPeriod

Optional.

public virtual object? RetentionPeriod { get; set; }

Property Value

object

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

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

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

TagsRaw

Metadata which can be used to manage the data set.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

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

Triggers

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

public virtual object? Triggers { get; set; }

Property Value

object

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

VersioningConfiguration

Optional.

public virtual object? VersioningConfiguration { get; set; }

Property Value

object

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

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.

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

RenderProperties(IDictionary<string, object>)

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).

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

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

Implements

IInspectable

ITaggable