Package software.amazon.awscdk.cfnpropertymixins.services.iotfleetwise

Interface CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty.Jsii$Proxy

Enclosing class:

CfnCampaignPropsMixin

@Stability(Stable)
public static interface CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty
extends software.amazon.jsii.JsiiSerializable

Size, time, and location options for the data partition.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.iotfleetwise.*;
 DataPartitionStorageOptionsProperty dataPartitionStorageOptionsProperty = DataPartitionStorageOptionsProperty.builder()
         .maximumSize(StorageMaximumSizeProperty.builder()
                 .unit("unit")
                 .value(123)
                 .build())
         .minimumTimeToLive(StorageMinimumTimeToLiveProperty.builder()
                 .unit("unit")
                 .value(123)
                 .build())
         .storageLocation("storageLocation")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty.Builder	A builder for CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty
static final class	CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty.Jsii$Proxy	An implementation for CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty.Builder	builder()
default Object	getMaximumSize()	The maximum storage size of the data stored in the data partition.
default Object	getMinimumTimeToLive()	The amount of time that data in this partition will be kept on disk.
default String	getStorageLocation()	The folder name for the data partition under the campaign storage folder.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaximumSize

@Stability(Stable)
@Nullable
default Object getMaximumSize()

The maximum storage size of the data stored in the data partition.

Newer data overwrites older data when the partition reaches the maximum size.

Returns union: either IResolvable or CfnCampaignPropsMixin.StorageMaximumSizeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html#cfn-iotfleetwise-campaign-datapartitionstorageoptions-maximumsize

getMinimumTimeToLive

@Stability(Stable)
@Nullable
default Object getMinimumTimeToLive()

The amount of time that data in this partition will be kept on disk.

• After the designated amount of time passes, the data can be removed, but it's not guaranteed to be removed.
• Before the time expires, data in this partition can still be deleted if the partition reaches its configured maximum size.
• Newer data will overwrite older data when the partition reaches the maximum size.

Returns union: either IResolvable or CfnCampaignPropsMixin.StorageMinimumTimeToLiveProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html#cfn-iotfleetwise-campaign-datapartitionstorageoptions-minimumtimetolive

getStorageLocation

@Stability(Stable)
@Nullable
default String getStorageLocation()

The folder name for the data partition under the campaign storage folder.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html#cfn-iotfleetwise-campaign-datapartitionstorageoptions-storagelocation

builder

@Stability(Stable)
static CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty.Builder builder()

Returns:

a CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty.Builder of CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty