Class CfnDataset
A CloudFormation AWS::IoTAnalytics::Dataset
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTAnalytics
Assembly: Amazon.CDK.AWS.IoTAnalytics.dll
Syntax (csharp)
public class CfnDataset : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDataset
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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). 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 .
CloudformationResource: AWS::IoTAnalytics::Dataset
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 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) | Create a new |
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 |
Properties
Actions | The |
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 | Metadata which can be used to manage the data set. |
Triggers | The |
VersioningConfiguration | Optional. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDataset(Construct, String, ICfnDatasetProps)
Create a new AWS::IoTAnalytics::Dataset
.
public CfnDataset(Construct scope, string id, ICfnDatasetProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDatasetProps
- resource properties.
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
Properties
Actions
The DatasetAction
objects that automatically create the dataset contents.
public virtual object Actions { get; set; }
Property Value
System.Object
Remarks
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
Remarks
DatasetName
The name of the dataset.
public virtual 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 virtual object LateDataRules { get; set; }
Property Value
System.Object
Remarks
To specify lateDataRules
, the dataset must use a DeltaTimer filter.
RetentionPeriod
Optional.
public virtual 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 virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
Triggers
The DatasetTrigger
objects that specify when the dataset is automatically updated.
public virtual object Triggers { get; set; }
Property Value
System.Object
Remarks
VersioningConfiguration
Optional.
public virtual 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 .
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>