software.amazon.awscdk.services.iotfleetwise

Interface CfnCampaignProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCampaignProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:50.870Z")
 @Stability(value=Stable)
public interface CfnCampaignProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnCampaign`.

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.iotfleetwise.*;
 CfnCampaignProps cfnCampaignProps = CfnCampaignProps.builder()
         .action("action")
         .collectionScheme(CollectionSchemeProperty.builder()
                 .conditionBasedCollectionScheme(ConditionBasedCollectionSchemeProperty.builder()
                         .expression("expression")
                         // the properties below are optional
                         .conditionLanguageVersion(123)
                         .minimumTriggerIntervalMs(123)
                         .triggerMode("triggerMode")
                         .build())
                 .timeBasedCollectionScheme(TimeBasedCollectionSchemeProperty.builder()
                         .periodMs(123)
                         .build())
                 .build())
         .name("name")
         .signalCatalogArn("signalCatalogArn")
         .targetArn("targetArn")
         // the properties below are optional
         .compression("compression")
         .dataExtraDimensions(List.of("dataExtraDimensions"))
         .description("description")
         .diagnosticsMode("diagnosticsMode")
         .expiryTime("expiryTime")
         .postTriggerCollectionDuration(123)
         .priority(123)
         .signalsToCollect(List.of(SignalInformationProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .maxSampleCount(123)
                 .minimumSamplingIntervalMs(123)
                 .build()))
         .spoolingMode("spoolingMode")
         .startTime("startTime")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnCampaignProps.Builder	builder()
String	getAction() `AWS::IoTFleetWise::Campaign.Action`.
Object	getCollectionScheme() `AWS::IoTFleetWise::Campaign.CollectionScheme`.
default String	getCompression() `AWS::IoTFleetWise::Campaign.Compression`.
default List<String>	getDataExtraDimensions() `AWS::IoTFleetWise::Campaign.DataExtraDimensions`.
default String	getDescription() `AWS::IoTFleetWise::Campaign.Description`.
default String	getDiagnosticsMode() `AWS::IoTFleetWise::Campaign.DiagnosticsMode`.
default String	getExpiryTime() `AWS::IoTFleetWise::Campaign.ExpiryTime`.
String	getName() `AWS::IoTFleetWise::Campaign.Name`.
default Number	getPostTriggerCollectionDuration() `AWS::IoTFleetWise::Campaign.PostTriggerCollectionDuration`.
default Number	getPriority() `AWS::IoTFleetWise::Campaign.Priority`.
String	getSignalCatalogArn() `AWS::IoTFleetWise::Campaign.SignalCatalogArn`.
default Object	getSignalsToCollect() `AWS::IoTFleetWise::Campaign.SignalsToCollect`.
default String	getSpoolingMode() `AWS::IoTFleetWise::Campaign.SpoolingMode`.
default String	getStartTime() `AWS::IoTFleetWise::Campaign.StartTime`.
default List<CfnTag>	getTags() `AWS::IoTFleetWise::Campaign.Tags`.
String	getTargetArn() `AWS::IoTFleetWise::Campaign.TargetArn`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAction

@Stability(value=Stable)
 @NotNull
String getAction()

`AWS::IoTFleetWise::Campaign.Action`.

getCollectionScheme

@Stability(value=Stable)
 @NotNull
Object getCollectionScheme()

`AWS::IoTFleetWise::Campaign.CollectionScheme`.

getName

@Stability(value=Stable)
 @NotNull
String getName()

`AWS::IoTFleetWise::Campaign.Name`.

getSignalCatalogArn

@Stability(value=Stable)
 @NotNull
String getSignalCatalogArn()

`AWS::IoTFleetWise::Campaign.SignalCatalogArn`.

getTargetArn

@Stability(value=Stable)
 @NotNull
String getTargetArn()

`AWS::IoTFleetWise::Campaign.TargetArn`.

getCompression

@Stability(value=Stable)
 @Nullable
default String getCompression()

`AWS::IoTFleetWise::Campaign.Compression`.

getDataExtraDimensions

@Stability(value=Stable)
 @Nullable
default List<String> getDataExtraDimensions()

`AWS::IoTFleetWise::Campaign.DataExtraDimensions`.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::IoTFleetWise::Campaign.Description`.

getDiagnosticsMode

@Stability(value=Stable)
 @Nullable
default String getDiagnosticsMode()

`AWS::IoTFleetWise::Campaign.DiagnosticsMode`.

getExpiryTime

@Stability(value=Stable)
 @Nullable
default String getExpiryTime()

`AWS::IoTFleetWise::Campaign.ExpiryTime`.

getPostTriggerCollectionDuration

@Stability(value=Stable)
 @Nullable
default Number getPostTriggerCollectionDuration()

`AWS::IoTFleetWise::Campaign.PostTriggerCollectionDuration`.

getPriority

@Stability(value=Stable)
 @Nullable
default Number getPriority()

`AWS::IoTFleetWise::Campaign.Priority`.

getSignalsToCollect

@Stability(value=Stable)
 @Nullable
default Object getSignalsToCollect()

`AWS::IoTFleetWise::Campaign.SignalsToCollect`.

getSpoolingMode

@Stability(value=Stable)
 @Nullable
default String getSpoolingMode()

`AWS::IoTFleetWise::Campaign.SpoolingMode`.

getStartTime

@Stability(value=Stable)
 @Nullable
default String getStartTime()

`AWS::IoTFleetWise::Campaign.StartTime`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::IoTFleetWise::Campaign.Tags`.

builder

@Stability(value=Stable)
static CfnCampaignProps.Builder builder()

Returns:

a CfnCampaignProps.Builder of CfnCampaignProps