Package software.amazon.awscdk.services.iotanalytics

Class CfnDataset.Builder

java.lang.Object

software.amazon.awscdk.services.iotanalytics.CfnDataset.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataset>

Enclosing class:

CfnDataset

@Stability(Stable)
public static final class CfnDataset.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataset>

A fluent builder for CfnDataset.

Method Summary

Modifier and Type	Method	Description
CfnDataset.Builder	actions(List<? extends Object> actions)	The DatasetAction objects that automatically create the dataset contents.
CfnDataset.Builder	actions(IResolvable actions)	The DatasetAction objects that automatically create the dataset contents.
CfnDataset	build()
CfnDataset.Builder	contentDeliveryRules(List<? extends Object> contentDeliveryRules)	When dataset contents are created they are delivered to destinations specified here.
CfnDataset.Builder	contentDeliveryRules(IResolvable contentDeliveryRules)	When dataset contents are created they are delivered to destinations specified here.
static CfnDataset.Builder	create(software.constructs.Construct scope, String id)
CfnDataset.Builder	datasetName(String datasetName)	The name of the dataset.
CfnDataset.Builder	lateDataRules(List<? extends Object> lateDataRules)	A list of data rules that send notifications to CloudWatch, when data arrives late.
CfnDataset.Builder	lateDataRules(IResolvable lateDataRules)	A list of data rules that send notifications to CloudWatch, when data arrives late.
CfnDataset.Builder	retentionPeriod(IResolvable retentionPeriod)	Optional.
CfnDataset.Builder	retentionPeriod(CfnDataset.RetentionPeriodProperty retentionPeriod)	Optional.
CfnDataset.Builder	tags(List<? extends CfnTag> tags)	Metadata which can be used to manage the data set.
CfnDataset.Builder	triggers(List<? extends Object> triggers)	The DatasetTrigger objects that specify when the dataset is automatically updated.
CfnDataset.Builder	triggers(IResolvable triggers)	The DatasetTrigger objects that specify when the dataset is automatically updated.
CfnDataset.Builder	versioningConfiguration(IResolvable versioningConfiguration)	Optional.
CfnDataset.Builder	versioningConfiguration(CfnDataset.VersioningConfigurationProperty versioningConfiguration)	Optional.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnDataset.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDataset.Builder.

actions

@Stability(Stable)
public CfnDataset.Builder actions(IResolvable actions)

The DatasetAction objects that automatically create the dataset contents.

Parameters:

actions - The DatasetAction objects that automatically create the dataset contents. This parameter is required.

Returns:

this

See Also:

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

actions

@Stability(Stable)
public CfnDataset.Builder actions(List<? extends Object> actions)

The DatasetAction objects that automatically create the dataset contents.

Parameters:

actions - The DatasetAction objects that automatically create the dataset contents. This parameter is required.

Returns:

this

See Also:

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

contentDeliveryRules

@Stability(Stable)
public CfnDataset.Builder contentDeliveryRules(IResolvable contentDeliveryRules)

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

Parameters:

contentDeliveryRules - When dataset contents are created they are delivered to destinations specified here. This parameter is required.

Returns:

this

See Also:

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

contentDeliveryRules

@Stability(Stable)
public CfnDataset.Builder contentDeliveryRules(List<? extends Object> contentDeliveryRules)

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

Parameters:

contentDeliveryRules - When dataset contents are created they are delivered to destinations specified here. This parameter is required.

Returns:

this

See Also:

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

datasetName

@Stability(Stable)
public CfnDataset.Builder datasetName(String datasetName)

The name of the dataset.

Parameters:

datasetName - The name of the dataset. This parameter is required.

Returns:

this

See Also:

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

lateDataRules

@Stability(Stable)
public CfnDataset.Builder lateDataRules(IResolvable lateDataRules)

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

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

Parameters:

lateDataRules - A list of data rules that send notifications to CloudWatch, when data arrives late. This parameter is required.

Returns:

this

See Also:

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

lateDataRules

@Stability(Stable)
public CfnDataset.Builder lateDataRules(List<? extends Object> lateDataRules)

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

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

Parameters:

lateDataRules - A list of data rules that send notifications to CloudWatch, when data arrives late. This parameter is required.

Returns:

this

See Also:

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

retentionPeriod

@Stability(Stable)
public CfnDataset.Builder retentionPeriod(IResolvable retentionPeriod)

Optional.

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

Parameters:

retentionPeriod - Optional. This parameter is required.

Returns:

this

See Also:

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

retentionPeriod

@Stability(Stable)
public CfnDataset.Builder retentionPeriod(CfnDataset.RetentionPeriodProperty retentionPeriod)

Optional.

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

Parameters:

retentionPeriod - Optional. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnDataset.Builder tags(List<? extends CfnTag> tags)

Metadata which can be used to manage the data set.

For more information, see Tag .

Parameters:

tags - Metadata which can be used to manage the data set. This parameter is required.

Returns:

this

See Also:

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

triggers

@Stability(Stable)
public CfnDataset.Builder triggers(IResolvable triggers)

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

Parameters:

triggers - The DatasetTrigger objects that specify when the dataset is automatically updated. This parameter is required.

Returns:

this

See Also:

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

triggers

@Stability(Stable)
public CfnDataset.Builder triggers(List<? extends Object> triggers)

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

Parameters:

triggers - The DatasetTrigger objects that specify when the dataset is automatically updated. This parameter is required.

Returns:

this

See Also:

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

versioningConfiguration

@Stability(Stable)
public CfnDataset.Builder versioningConfiguration(IResolvable versioningConfiguration)

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 retentionPeriod parameter. For more information, see Keeping Multiple Versions of AWS IoT Analytics datasets in the AWS IoT Analytics User Guide .

Parameters:

versioningConfiguration - Optional. This parameter is required.

Returns:

this

See Also:

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

versioningConfiguration

@Stability(Stable)
public CfnDataset.Builder versioningConfiguration(CfnDataset.VersioningConfigurationProperty versioningConfiguration)

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 retentionPeriod parameter. For more information, see Keeping Multiple Versions of AWS IoT Analytics datasets in the AWS IoT Analytics User Guide .

Parameters:

versioningConfiguration - Optional. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnDataset build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDataset>

Returns:

a newly built instance of CfnDataset.