Show / Hide Table of Contents

Class CfnDatasetMixinProps

Properties for CfnDatasetPropsMixin.

Inheritance
object
CfnDatasetMixinProps
Implements
ICfnDatasetMixinProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.IoTAnalytics
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnDatasetMixinProps : ICfnDatasetMixinProps
Syntax (vb)
Public Class CfnDatasetMixinProps Implements ICfnDatasetMixinProps
Remarks

See: 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.CfnPropertyMixins.AWS.IoTAnalytics;

             var cfnDatasetMixinProps = new CfnDatasetMixinProps {
                 Actions = new [] { new ActionProperty {
                     ActionName = "actionName",
                     ContainerAction = new ContainerActionProperty {
                         ExecutionRoleArn = "executionRoleArn",
                         Image = "image",
                         ResourceConfiguration = new ResourceConfigurationProperty {
                             ComputeType = "computeType",
                             VolumeSizeInGb = 123
                         },
                         Variables = new [] { new VariableProperty {
                             DatasetContentVersionValue = new DatasetContentVersionValueProperty {
                                 DatasetName = "datasetName"
                             },
                             DoubleValue = 123,
                             OutputFileUriValue = new OutputFileUriValueProperty {
                                 FileName = "fileName"
                             },
                             StringValue = "stringValue",
                             VariableName = "variableName"
                         } }
                     },
                     QueryAction = new QueryActionProperty {
                         Filters = new [] { new FilterProperty {
                             DeltaTime = new DeltaTimeProperty {
                                 OffsetSeconds = 123,
                                 TimeExpression = "timeExpression"
                             }
                         } },
                         SqlQuery = "sqlQuery"
                     }
                 } },
                 ContentDeliveryRules = new [] { new DatasetContentDeliveryRuleProperty {
                     Destination = new DatasetContentDeliveryRuleDestinationProperty {
                         IotEventsDestinationConfiguration = new IotEventsDestinationConfigurationProperty {
                             InputName = "inputName",
                             RoleArn = "roleArn"
                         },
                         S3DestinationConfiguration = new S3DestinationConfigurationProperty {
                             Bucket = "bucket",
                             GlueConfiguration = new GlueConfigurationProperty {
                                 DatabaseName = "databaseName",
                                 TableName = "tableName"
                             },
                             Key = "key",
                             RoleArn = "roleArn"
                         }
                     },
                     EntryName = "entryName"
                 } },
                 DatasetName = "datasetName",
                 LateDataRules = new [] { new LateDataRuleProperty {
                     RuleConfiguration = new LateDataRuleConfigurationProperty {
                         DeltaTimeSessionWindowConfiguration = new DeltaTimeSessionWindowConfigurationProperty {
                             TimeoutInMinutes = 123
                         }
                     },
                     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

CfnDatasetMixinProps()

Properties for CfnDatasetPropsMixin.

Properties

Actions

The DatasetAction objects that automatically create the dataset contents.

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 DatasetTrigger objects that specify when the dataset is automatically updated.

VersioningConfiguration

Optional.

Constructors

CfnDatasetMixinProps()

Properties for CfnDatasetPropsMixin.

public CfnDatasetMixinProps()
Remarks

See: 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.CfnPropertyMixins.AWS.IoTAnalytics;

             var cfnDatasetMixinProps = new CfnDatasetMixinProps {
                 Actions = new [] { new ActionProperty {
                     ActionName = "actionName",
                     ContainerAction = new ContainerActionProperty {
                         ExecutionRoleArn = "executionRoleArn",
                         Image = "image",
                         ResourceConfiguration = new ResourceConfigurationProperty {
                             ComputeType = "computeType",
                             VolumeSizeInGb = 123
                         },
                         Variables = new [] { new VariableProperty {
                             DatasetContentVersionValue = new DatasetContentVersionValueProperty {
                                 DatasetName = "datasetName"
                             },
                             DoubleValue = 123,
                             OutputFileUriValue = new OutputFileUriValueProperty {
                                 FileName = "fileName"
                             },
                             StringValue = "stringValue",
                             VariableName = "variableName"
                         } }
                     },
                     QueryAction = new QueryActionProperty {
                         Filters = new [] { new FilterProperty {
                             DeltaTime = new DeltaTimeProperty {
                                 OffsetSeconds = 123,
                                 TimeExpression = "timeExpression"
                             }
                         } },
                         SqlQuery = "sqlQuery"
                     }
                 } },
                 ContentDeliveryRules = new [] { new DatasetContentDeliveryRuleProperty {
                     Destination = new DatasetContentDeliveryRuleDestinationProperty {
                         IotEventsDestinationConfiguration = new IotEventsDestinationConfigurationProperty {
                             InputName = "inputName",
                             RoleArn = "roleArn"
                         },
                         S3DestinationConfiguration = new S3DestinationConfigurationProperty {
                             Bucket = "bucket",
                             GlueConfiguration = new GlueConfigurationProperty {
                                 DatabaseName = "databaseName",
                                 TableName = "tableName"
                             },
                             Key = "key",
                             RoleArn = "roleArn"
                         }
                     },
                     EntryName = "entryName"
                 } },
                 DatasetName = "datasetName",
                 LateDataRules = new [] { new LateDataRuleProperty {
                     RuleConfiguration = new LateDataRuleConfigurationProperty {
                         DeltaTimeSessionWindowConfiguration = new DeltaTimeSessionWindowConfigurationProperty {
                             TimeoutInMinutes = 123
                         }
                     },
                     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
                 }
             };

Properties

Actions

The DatasetAction objects that automatically create the dataset contents.

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

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnDatasetPropsMixin.IActionProperty)[]

ContentDeliveryRules

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

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

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnDatasetPropsMixin.IDatasetContentDeliveryRuleProperty)[]

DatasetName

The name of the dataset.

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

string

Remarks

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

LateDataRules

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

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

object

Remarks

To specify lateDataRules , the dataset must use a DeltaTimer filter.

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

Type union: either IResolvable or (either IResolvable or CfnDatasetPropsMixin.ILateDataRuleProperty)[]

RetentionPeriod

Optional.

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

object

Remarks

How long, in days, message data is kept for the dataset.

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

Type union: either IResolvable or CfnDatasetPropsMixin.IRetentionPeriodProperty

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 .

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

Triggers

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

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

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnDatasetPropsMixin.ITriggerProperty)[]

VersioningConfiguration

Optional.

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

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 ITA datasets in the ITA User Guide .

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

Type union: either IResolvable or CfnDatasetPropsMixin.IVersioningConfigurationProperty

Implements

ICfnDatasetMixinProps
Back to top Generated by DocFX