Show / Hide Table of Contents

Class CfnDatasetPropsMixin

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
Mixin
CfnDatasetPropsMixin
Implements
IMixin
Inherited Members
Mixin.IsMixin(object)
Namespace: Amazon.CDK.Mixins.Preview.AWS.IoTAnalytics.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnDatasetPropsMixin : Mixin, IMixin
Syntax (vb)
Public Class CfnDatasetPropsMixin Inherits Mixin Implements IMixin
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

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.IoTAnalytics.Mixins;

             var cfnDatasetPropsMixin = new CfnDatasetPropsMixin(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
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Synopsis

Constructors

CfnDatasetPropsMixin(ICfnDatasetMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::IoTAnalytics::Dataset.

Properties

CFN_PROPERTY_KEYS

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

Props

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

Strategy

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

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

Supports(IConstruct)

Check if this mixin supports the given construct.

Constructors

CfnDatasetPropsMixin(ICfnDatasetMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::IoTAnalytics::Dataset.

public CfnDatasetPropsMixin(ICfnDatasetMixinProps props, ICfnPropertyMixinOptions? options = null)
Parameters
props ICfnDatasetMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

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

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

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 static string[] CFN_PROPERTY_KEYS { 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

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.IoTAnalytics.Mixins;

             var cfnDatasetPropsMixin = new CfnDatasetPropsMixin(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
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Props

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 virtual ICfnDatasetMixinProps Props { get; }
Property Value

ICfnDatasetMixinProps

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

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.IoTAnalytics.Mixins;

             var cfnDatasetPropsMixin = new CfnDatasetPropsMixin(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
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Strategy

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 virtual PropertyMergeStrategy Strategy { get; }
Property Value

PropertyMergeStrategy

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

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.IoTAnalytics.Mixins;

             var cfnDatasetPropsMixin = new CfnDatasetPropsMixin(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
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override IConstruct ApplyTo(IConstruct construct)
Parameters
construct IConstruct
Returns

IConstruct

Overrides
Mixin.ApplyTo(IConstruct)
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

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)
Parameters
construct IConstruct
Returns

bool

Overrides
Mixin.Supports(IConstruct)
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

Mixin: true

ExampleMetadata: fixture=_generated

Implements

IMixin
Back to top Generated by DocFX