Interface CfnCampaignProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnCampaignProps.Jsii$Proxy
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()
.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
.action("action")
.compression("compression")
.dataDestinationConfigs(List.of(DataDestinationConfigProperty.builder()
.mqttTopicConfig(MqttTopicConfigProperty.builder()
.executionRoleArn("executionRoleArn")
.mqttTopicArn("mqttTopicArn")
.build())
.s3Config(S3ConfigProperty.builder()
.bucketArn("bucketArn")
// the properties below are optional
.dataFormat("dataFormat")
.prefix("prefix")
.storageCompressionFormat("storageCompressionFormat")
.build())
.timestreamConfig(TimestreamConfigProperty.builder()
.executionRoleArn("executionRoleArn")
.timestreamTableArn("timestreamTableArn")
.build())
.build()))
.dataExtraDimensions(List.of("dataExtraDimensions"))
.dataPartitions(List.of(DataPartitionProperty.builder()
.id("id")
.storageOptions(DataPartitionStorageOptionsProperty.builder()
.maximumSize(StorageMaximumSizeProperty.builder()
.unit("unit")
.value(123)
.build())
.minimumTimeToLive(StorageMinimumTimeToLiveProperty.builder()
.unit("unit")
.value(123)
.build())
.storageLocation("storageLocation")
.build())
// the properties below are optional
.uploadOptions(DataPartitionUploadOptionsProperty.builder()
.expression("expression")
// the properties below are optional
.conditionLanguageVersion(123)
.build())
.build()))
.description("description")
.diagnosticsMode("diagnosticsMode")
.expiryTime("expiryTime")
.postTriggerCollectionDuration(123)
.priority(123)
.signalsToCollect(List.of(SignalInformationProperty.builder()
.name("name")
// the properties below are optional
.dataPartitionId("dataPartitionId")
.maxSampleCount(123)
.minimumSamplingIntervalMs(123)
.build()))
.signalsToFetch(List.of(SignalFetchInformationProperty.builder()
.actions(List.of("actions"))
.fullyQualifiedName("fullyQualifiedName")
.signalFetchConfig(SignalFetchConfigProperty.builder()
.conditionBased(ConditionBasedSignalFetchConfigProperty.builder()
.conditionExpression("conditionExpression")
.triggerMode("triggerMode")
.build())
.timeBased(TimeBasedSignalFetchConfigProperty.builder()
.executionFrequencyMs(123)
.build())
.build())
// the properties below are optional
.conditionLanguageVersion(123)
.build()))
.spoolingMode("spoolingMode")
.startTime("startTime")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnCampaignPropsstatic final classAn implementation forCfnCampaignProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnCampaignProps.Builderbuilder()default StringSpecifies how to update a campaign.The data collection scheme associated with the campaign.default StringWhether to compress signals before transmitting data to AWS IoT FleetWise .default ObjectThe destination where the campaign sends data.A list of vehicle attributes to associate with a campaign.default ObjectThe data partitions associated with the signals collected from the vehicle.default StringThe description of the campaign.default StringOption for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .default StringThe time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).getName()The name of a campaign.default NumberHow long (in milliseconds) to collect raw data after a triggering event initiates the collection.default NumberA number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.default ObjectA list of information about signals to collect.default ObjectA list of information about signals to fetch.default StringWhether to store collected data after a vehicle lost a connection with the cloud.default StringThe time, in milliseconds, to deliver a campaign after it was approved.getTags()Metadata that can be used to manage the campaign.The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCollectionScheme
The data collection scheme associated with the campaign.You can specify a scheme that collects data based on time or an event.
Returns union: either
IResolvableorCfnCampaign.CollectionSchemeProperty- See Also:
-
getName
The name of a campaign.- See Also:
-
getSignalCatalogArn
The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.- See Also:
-
getTargetArn
The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.- See Also:
-
getAction
Specifies how to update a campaign. The action can be one of the following:.APPROVE- To approve delivering a data collection scheme to vehicles.SUSPEND- To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.RESUME- To reactivate theSUSPENDcampaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.UPDATE- To update a campaign.
- See Also:
-
getCompression
Whether to compress signals before transmitting data to AWS IoT FleetWise .If you don't want to compress the signals, use
OFF. If it's not specified,SNAPPYis used.Default:
SNAPPYDefault: - "OFF"
- See Also:
-
getDataDestinationConfigs
The destination where the campaign sends data.You can choose to send data to be stored in Amazon S3 or Amazon Timestream .
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. AWS IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple AWS IoT FleetWise servers for redundancy and high availability.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnCampaign.DataDestinationConfigProperty>- See Also:
-
getDataExtraDimensions
A list of vehicle attributes to associate with a campaign.Enrich the data with specified vehicle attributes. For example, add
makeandmodelto the campaign, and AWS IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream . You can then query the data againstmakeandmodel.Default: An empty array
- See Also:
-
getDataPartitions
The data partitions associated with the signals collected from the vehicle.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnCampaign.DataPartitionProperty>- See Also:
-
getDescription
The description of the campaign.- See Also:
-
getDiagnosticsMode
Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .If you want to send diagnostic trouble codes, use
SEND_ACTIVE_DTCS. If it's not specified,OFFis used.Default:
OFFDefault: - "OFF"
- See Also:
-
getExpiryTime
The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).Vehicle data isn't collected after the campaign expires.
Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
Default: - "253402214400"
- See Also:
-
getPostTriggerCollectionDuration
How long (in milliseconds) to collect raw data after a triggering event initiates the collection.If it's not specified,
0is used.Default:
0Default: - 0
- See Also:
-
getPriority
A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified,
0is used.Default:
0Default: - 0
- See Also:
-
getSignalsToCollect
A list of information about signals to collect.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnCampaign.SignalInformationProperty>- See Also:
-
getSignalsToFetch
A list of information about signals to fetch.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnCampaign.SignalFetchInformationProperty>- See Also:
-
getSpoolingMode
Whether to store collected data after a vehicle lost a connection with the cloud.After a connection is re-established, the data is automatically forwarded to AWS IoT FleetWise . If you want to store collected data when a vehicle loses connection with the cloud, use
TO_DISK. If it's not specified,OFFis used.Default:
OFFDefault: - "OFF"
- See Also:
-
getStartTime
The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified,0is used.Default:
0Default: - "0"
- See Also:
-
getTags
Metadata that can be used to manage the campaign.- See Also:
-
builder
- Returns:
- a
CfnCampaignProps.BuilderofCfnCampaignProps
-