Package software.amazon.awscdk.services.iotfleetwise

Class CfnCampaign

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iotfleetwise.CfnCampaign

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:09.678Z")
@Stability(Stable)
public class CfnCampaign
extends CfnResource
implements IInspectable, ITaggable

Creates an orchestration of data collection rules.

The AWS IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, AWS IoT FleetWise automatically deploys them to vehicles.

For more information, see Collect and transfer data with campaigns in the AWS IoT FleetWise Developer Guide .

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.*;
 CfnCampaign cfnCampaign = CfnCampaign.Builder.create(this, "MyCfnCampaign")
         .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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnCampaign.Builder	A fluent builder for CfnCampaign.
static interface	CfnCampaign.CollectionSchemeProperty	Specifies what data to collect and how often or when to collect it.
static interface	CfnCampaign.ConditionBasedCollectionSchemeProperty	Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
static interface	CfnCampaign.ConditionBasedSignalFetchConfigProperty	Example:
static interface	CfnCampaign.DataDestinationConfigProperty	The destination where the AWS IoT FleetWise campaign sends data.
static interface	CfnCampaign.DataPartitionProperty	Example:
static interface	CfnCampaign.DataPartitionStorageOptionsProperty	Example:
static interface	CfnCampaign.DataPartitionUploadOptionsProperty	Example:
static interface	CfnCampaign.MqttTopicConfigProperty	Example:
static interface	CfnCampaign.S3ConfigProperty	The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.
static interface	CfnCampaign.SignalFetchConfigProperty	Example:
static interface	CfnCampaign.SignalFetchInformationProperty	Example:
static interface	CfnCampaign.SignalInformationProperty	Information about a signal.
static interface	CfnCampaign.StorageMaximumSizeProperty	Example:
static interface	CfnCampaign.StorageMinimumTimeToLiveProperty	Example:
static interface	CfnCampaign.TimeBasedCollectionSchemeProperty	Information about a collection scheme that uses a time period to decide how often to collect data.
static interface	CfnCampaign.TimeBasedSignalFetchConfigProperty	Example:
static interface	CfnCampaign.TimestreamConfigProperty	The Amazon Timestream table where the AWS IoT FleetWise campaign sends data.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnCampaign(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCampaign(software.amazon.jsii.JsiiObjectRef objRef)
	CfnCampaign(software.constructs.Construct scope, String id, CfnCampaignProps props)

Method Summary

Modifier and Type	Method	Description
String	getAction()	Specifies how to update a campaign.
String	getAttrArn()	The Amazon Resource Name (ARN) of the campaign.
String	getAttrCreationTime()	The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
String	getAttrLastModificationTime()	The last time the campaign was modified.
String	getAttrStatus()	The state of the campaign.
protected Map<String,Object>	getCfnProperties()
Object	getCollectionScheme()	The data collection scheme associated with the campaign.
String	getCompression()	(Optional) Whether to compress signals before transmitting data to AWS IoT FleetWise .
Object	getDataDestinationConfigs()	(Optional) The destination where the campaign sends data.
List<String>	getDataExtraDimensions()	(Optional) A list of vehicle attributes to associate with a campaign.
Object	getDataPartitions()
String	getDescription()	(Optional) The description of the campaign.
String	getDiagnosticsMode()	(Optional) Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .
String	getExpiryTime()	(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
String	getName()	The name of a campaign.
Number	getPostTriggerCollectionDuration()	(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
Number	getPriority()	(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
String	getSignalCatalogArn()	The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.
Object	getSignalsToCollect()	(Optional) A list of information about signals to collect.
Object	getSignalsToFetch()
String	getSpoolingMode()	(Optional) Whether to store collected data after a vehicle lost a connection with the cloud.
String	getStartTime()	(Optional) The time, in milliseconds, to deliver a campaign after it was approved.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	(Optional) Metadata that can be used to manage the campaign.
String	getTargetArn()	The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAction(String value)	Specifies how to update a campaign.
void	setCollectionScheme(IResolvable value)	The data collection scheme associated with the campaign.
void	setCollectionScheme(CfnCampaign.CollectionSchemeProperty value)	The data collection scheme associated with the campaign.
void	setCompression(String value)	(Optional) Whether to compress signals before transmitting data to AWS IoT FleetWise .
void	setDataDestinationConfigs(List<Object> value)	(Optional) The destination where the campaign sends data.
void	setDataDestinationConfigs(IResolvable value)	(Optional) The destination where the campaign sends data.
void	setDataExtraDimensions(List<String> value)	(Optional) A list of vehicle attributes to associate with a campaign.
void	setDataPartitions(List<Object> value)
void	setDataPartitions(IResolvable value)
void	setDescription(String value)	(Optional) The description of the campaign.
void	setDiagnosticsMode(String value)	(Optional) Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .
void	setExpiryTime(String value)	(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
void	setName(String value)	The name of a campaign.
void	setPostTriggerCollectionDuration(Number value)	(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
void	setPriority(Number value)	(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
void	setSignalCatalogArn(String value)	The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.
void	setSignalsToCollect(List<Object> value)	(Optional) A list of information about signals to collect.
void	setSignalsToCollect(IResolvable value)	(Optional) A list of information about signals to collect.
void	setSignalsToFetch(List<Object> value)
void	setSignalsToFetch(IResolvable value)
void	setSpoolingMode(String value)	(Optional) Whether to store collected data after a vehicle lost a connection with the cloud.
void	setStartTime(String value)	(Optional) The time, in milliseconds, to deliver a campaign after it was approved.
void	setTagsRaw(List<CfnTag> value)	(Optional) Metadata that can be used to manage the campaign.
void	setTargetArn(String value)	The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnCampaign

protected CfnCampaign(software.amazon.jsii.JsiiObjectRef objRef)

CfnCampaign

protected CfnCampaign(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCampaign

@Stability(Stable)
public CfnCampaign(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnCampaignProps props)

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.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the campaign.

getAttrCreationTime

@Stability(Stable)
@NotNull
public String getAttrCreationTime()

The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).

getAttrLastModificationTime

@Stability(Stable)
@NotNull
public String getAttrLastModificationTime()

The last time the campaign was modified.

getAttrStatus

@Stability(Stable)
@NotNull
public String getAttrStatus()

The state of the campaign.

The status can be one of: CREATING , WAITING_FOR_APPROVAL , RUNNING , and SUSPENDED .

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getCollectionScheme

@Stability(Stable)
@NotNull
public Object getCollectionScheme()

The data collection scheme associated with the campaign.

setCollectionScheme

@Stability(Stable)
public void setCollectionScheme(@NotNull
 IResolvable value)

The data collection scheme associated with the campaign.

setCollectionScheme

@Stability(Stable)
public void setCollectionScheme(@NotNull
 CfnCampaign.CollectionSchemeProperty value)

The data collection scheme associated with the campaign.

getName

@Stability(Stable)
@NotNull
public String getName()

The name of a campaign.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of a campaign.

getSignalCatalogArn

@Stability(Stable)
@NotNull
public String getSignalCatalogArn()

The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.

setSignalCatalogArn

@Stability(Stable)
public void setSignalCatalogArn(@NotNull
 String value)

The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.

getTargetArn

@Stability(Stable)
@NotNull
public String getTargetArn()

The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.

setTargetArn

@Stability(Stable)
public void setTargetArn(@NotNull
 String value)

The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.

getAction

@Stability(Stable)
@Nullable
public String getAction()

Specifies how to update a campaign.

The action can be one of the following:.

setAction

@Stability(Stable)
public void setAction(@Nullable
 String value)

Specifies how to update a campaign.

The action can be one of the following:.

getCompression

@Stability(Stable)
@Nullable
public String getCompression()

(Optional) Whether to compress signals before transmitting data to AWS IoT FleetWise .

setCompression

@Stability(Stable)
public void setCompression(@Nullable
 String value)

(Optional) Whether to compress signals before transmitting data to AWS IoT FleetWise .

getDataDestinationConfigs

@Stability(Stable)
@Nullable
public Object getDataDestinationConfigs()

(Optional) The destination where the campaign sends data.

setDataDestinationConfigs

@Stability(Stable)
public void setDataDestinationConfigs(@Nullable
 IResolvable value)

(Optional) The destination where the campaign sends data.

setDataDestinationConfigs

@Stability(Stable)
public void setDataDestinationConfigs(@Nullable
 List<Object> value)

(Optional) The destination where the campaign sends data.

getDataExtraDimensions

@Stability(Stable)
@Nullable
public List<String> getDataExtraDimensions()

(Optional) A list of vehicle attributes to associate with a campaign.

setDataExtraDimensions

@Stability(Stable)
public void setDataExtraDimensions(@Nullable
 List<String> value)

(Optional) A list of vehicle attributes to associate with a campaign.

getDataPartitions

@Stability(Stable)
@Nullable
public Object getDataPartitions()

setDataPartitions

@Stability(Stable)
public void setDataPartitions(@Nullable
 IResolvable value)

setDataPartitions

@Stability(Stable)
public void setDataPartitions(@Nullable
 List<Object> value)

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

(Optional) The description of the campaign.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

(Optional) The description of the campaign.

getDiagnosticsMode

@Stability(Stable)
@Nullable
public String getDiagnosticsMode()

(Optional) Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .

setDiagnosticsMode

@Stability(Stable)
public void setDiagnosticsMode(@Nullable
 String value)

(Optional) Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .

getExpiryTime

@Stability(Stable)
@Nullable
public String getExpiryTime()

(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).

setExpiryTime

@Stability(Stable)
public void setExpiryTime(@Nullable
 String value)

(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).

getPostTriggerCollectionDuration

@Stability(Stable)
@Nullable
public Number getPostTriggerCollectionDuration()

(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.

setPostTriggerCollectionDuration

@Stability(Stable)
public void setPostTriggerCollectionDuration(@Nullable
 Number value)

(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.

getPriority

@Stability(Stable)
@Nullable
public Number getPriority()

(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.

setPriority

@Stability(Stable)
public void setPriority(@Nullable
 Number value)

(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.

getSignalsToCollect

@Stability(Stable)
@Nullable
public Object getSignalsToCollect()

(Optional) A list of information about signals to collect.

setSignalsToCollect

@Stability(Stable)
public void setSignalsToCollect(@Nullable
 IResolvable value)

(Optional) A list of information about signals to collect.

setSignalsToCollect

@Stability(Stable)
public void setSignalsToCollect(@Nullable
 List<Object> value)

(Optional) A list of information about signals to collect.

getSignalsToFetch

@Stability(Stable)
@Nullable
public Object getSignalsToFetch()

setSignalsToFetch

@Stability(Stable)
public void setSignalsToFetch(@Nullable
 IResolvable value)

setSignalsToFetch

@Stability(Stable)
public void setSignalsToFetch(@Nullable
 List<Object> value)

getSpoolingMode

@Stability(Stable)
@Nullable
public String getSpoolingMode()

(Optional) Whether to store collected data after a vehicle lost a connection with the cloud.

setSpoolingMode

@Stability(Stable)
public void setSpoolingMode(@Nullable
 String value)

(Optional) Whether to store collected data after a vehicle lost a connection with the cloud.

getStartTime

@Stability(Stable)
@Nullable
public String getStartTime()

(Optional) The time, in milliseconds, to deliver a campaign after it was approved.

setStartTime

@Stability(Stable)
public void setStartTime(@Nullable
 String value)

(Optional) The time, in milliseconds, to deliver a campaign after it was approved.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

(Optional) Metadata that can be used to manage the campaign.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

(Optional) Metadata that can be used to manage the campaign.