Class CfnDatasetProps
Properties for defining a CfnDataset
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.IoTAnalytics
Assembly: Amazon.CDK.AWS.IoTAnalytics.dll
Syntax (csharp)
public class CfnDatasetProps : Object, ICfnDatasetProps
Syntax (vb)
Public Class CfnDatasetProps
Inherits Object
Implements ICfnDatasetProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html
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 cfnDatasetProps = 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
CfnDatasetProps() |
Properties
Actions | The |
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 | Metadata which can be used to manage the data set. |
Triggers | The |
VersioningConfiguration | Optional. |
Constructors
CfnDatasetProps()
public CfnDatasetProps()
Properties
Actions
The DatasetAction
objects that automatically create the dataset contents.
public object Actions { get; set; }
Property Value
System.Object
Remarks
ContentDeliveryRules
When dataset contents are created they are delivered to destinations specified here.
public object ContentDeliveryRules { get; set; }
Property Value
System.Object
Remarks
DatasetName
The name of the dataset.
public string DatasetName { get; set; }
Property Value
System.String
Remarks
LateDataRules
A list of data rules that send notifications to CloudWatch, when data arrives late.
public object LateDataRules { get; set; }
Property Value
System.Object
Remarks
To specify lateDataRules
, the dataset must use a DeltaTimer filter.
RetentionPeriod
Optional.
public object RetentionPeriod { get; set; }
Property Value
System.Object
Remarks
How long, in days, message data is kept for the dataset.
Tags
Metadata which can be used to manage the data set.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
For more information, see Tag .
Triggers
The DatasetTrigger
objects that specify when the dataset is automatically updated.
public object Triggers { get; set; }
Property Value
System.Object
Remarks
VersioningConfiguration
Optional.
public object VersioningConfiguration { get; set; }
Property Value
System.Object
Remarks
How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod
parameter. For more information, see Keeping Multiple Versions of AWS IoT Analytics datasets in the AWS IoT Analytics User Guide .