Interface CfnDatasetProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDatasetProps.Jsii$Proxy
CfnDataset.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.iotanalytics.*;
CfnDatasetProps cfnDatasetProps = CfnDatasetProps.builder()
.actions(List.of(ActionProperty.builder()
.actionName("actionName")
// the properties below are optional
.containerAction(ContainerActionProperty.builder()
.executionRoleArn("executionRoleArn")
.image("image")
.resourceConfiguration(ResourceConfigurationProperty.builder()
.computeType("computeType")
.volumeSizeInGb(123)
.build())
// the properties below are optional
.variables(List.of(VariableProperty.builder()
.variableName("variableName")
// the properties below are optional
.datasetContentVersionValue(DatasetContentVersionValueProperty.builder()
.datasetName("datasetName")
.build())
.doubleValue(123)
.outputFileUriValue(OutputFileUriValueProperty.builder()
.fileName("fileName")
.build())
.stringValue("stringValue")
.build()))
.build())
.queryAction(QueryActionProperty.builder()
.sqlQuery("sqlQuery")
// the properties below are optional
.filters(List.of(FilterProperty.builder()
.deltaTime(DeltaTimeProperty.builder()
.offsetSeconds(123)
.timeExpression("timeExpression")
.build())
.build()))
.build())
.build()))
// the properties below are optional
.contentDeliveryRules(List.of(DatasetContentDeliveryRuleProperty.builder()
.destination(DatasetContentDeliveryRuleDestinationProperty.builder()
.iotEventsDestinationConfiguration(IotEventsDestinationConfigurationProperty.builder()
.inputName("inputName")
.roleArn("roleArn")
.build())
.s3DestinationConfiguration(S3DestinationConfigurationProperty.builder()
.bucket("bucket")
.key("key")
.roleArn("roleArn")
// the properties below are optional
.glueConfiguration(GlueConfigurationProperty.builder()
.databaseName("databaseName")
.tableName("tableName")
.build())
.build())
.build())
// the properties below are optional
.entryName("entryName")
.build()))
.datasetName("datasetName")
.lateDataRules(List.of(LateDataRuleProperty.builder()
.ruleConfiguration(LateDataRuleConfigurationProperty.builder()
.deltaTimeSessionWindowConfiguration(DeltaTimeSessionWindowConfigurationProperty.builder()
.timeoutInMinutes(123)
.build())
.build())
// the properties below are optional
.ruleName("ruleName")
.build()))
.retentionPeriod(RetentionPeriodProperty.builder()
.numberOfDays(123)
.unlimited(false)
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.triggers(List.of(TriggerProperty.builder()
.schedule(ScheduleProperty.builder()
.scheduleExpression("scheduleExpression")
.build())
.triggeringDataset(TriggeringDatasetProperty.builder()
.datasetName("datasetName")
.build())
.build()))
.versioningConfiguration(VersioningConfigurationProperty.builder()
.maxVersions(123)
.unlimited(false)
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnDatasetPropsstatic final classAn implementation forCfnDatasetProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnDatasetProps.Builderbuilder()TheDatasetActionobjects that automatically create the dataset contents.default ObjectWhen dataset contents are created they are delivered to destinations specified here.default StringThe name of the dataset.default ObjectA list of data rules that send notifications to CloudWatch, when data arrives late.default ObjectOptional.getTags()Metadata which can be used to manage the data set.default ObjectTheDatasetTriggerobjects that specify when the dataset is automatically updated.default ObjectOptional.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getActions
TheDatasetActionobjects that automatically create the dataset contents.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDataset.ActionProperty>- See Also:
-
getContentDeliveryRules
When dataset contents are created they are delivered to destinations specified here.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDataset.DatasetContentDeliveryRuleProperty>- See Also:
-
getDatasetName
The name of the dataset.- See Also:
-
getLateDataRules
A list of data rules that send notifications to CloudWatch, when data arrives late.To specify
lateDataRules, the dataset must use a DeltaTimer filter.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDataset.LateDataRuleProperty>- See Also:
-
getRetentionPeriod
Optional.How long, in days, message data is kept for the dataset.
Returns union: either
IResolvableorCfnDataset.RetentionPeriodProperty- See Also:
-
getTags
Metadata which can be used to manage the data set.For more information, see Tag .
- See Also:
-
getTriggers
TheDatasetTriggerobjects that specify when the dataset is automatically updated.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDataset.TriggerProperty>- See Also:
-
getVersioningConfiguration
Optional.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
retentionPeriodparameter. For more information, see Keeping Multiple Versions of AWS IoT Analytics datasets in the AWS IoT Analytics User Guide .Returns union: either
IResolvableorCfnDataset.VersioningConfigurationProperty- See Also:
-
builder
- Returns:
- a
CfnDatasetProps.BuilderofCfnDatasetProps
-