Class CfnCampaign
- All Implemented Interfaces:
IInspectable,IEnvironmentAware,ICampaignRef,ITaggable,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
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 Campaigns in the AWS IoT FleetWise Developer Guide .
Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability 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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA fluent builder forCfnCampaign.static interfaceSpecifies what data to collect and how often or when to collect it.static interfaceInformation about a collection scheme that uses a simple logical expression to recognize what data to collect.static interfaceSpecifies the condition under which a signal fetch occurs.static interfaceThe destination where the AWS IoT FleetWise campaign sends data.static interfaceThe configuration for signal data storage and upload options.static interfaceSize, time, and location options for the data partition.static interfaceThe upload options for the data partition.static interfaceThe MQTT topic to which the AWS IoT FleetWise campaign routes data.static interfaceThe Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.static interfaceThe configuration of the signal fetch operation.static interfaceInformation about the signal to be fetched.static interfaceInformation about a signal.static interfaceThe maximum storage size for the data partition.static interfaceInformation about the minimum amount of time that data will be kept.static interfaceInformation about a collection scheme that uses a time period to decide how often to collect data.static interfaceUsed to configure a frequency-based vehicle signal fetch.static interfaceThe 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.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.iotfleetwise.ICampaignRef
ICampaignRef.Jsii$Default, ICampaignRef.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnCampaign(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnCampaign(software.amazon.jsii.JsiiObjectRef objRef) CfnCampaign(software.constructs.Construct scope, String id, CfnCampaignProps props) Create a newAWS::IoTFleetWise::Campaign. -
Method Summary
Modifier and TypeMethodDescriptionstatic ICampaignReffromCampaignArn(software.constructs.Construct scope, String id, String arn) Creates a new ICampaignRef from an ARN.static ICampaignReffromCampaignName(software.constructs.Construct scope, String id, String campaignName) Creates a new ICampaignRef from a campaignName.Specifies how to update a campaign.The Amazon Resource Name (ARN) of the campaign.The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).The last time the campaign was modified.The state of the campaign.A reference to a Campaign resource.The data collection scheme associated with the campaign.Whether to compress signals before transmitting data to AWS IoT FleetWise .The destination where the campaign sends data.A list of vehicle attributes to associate with a campaign.The data partitions associated with the signals collected from the vehicle.The description of the campaign.Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).getName()The name of a campaign.How long (in milliseconds) to collect raw data after a triggering event initiates the collection.A 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.A list of information about signals to collect.A list of information about signals to fetch.Whether to store collected data after a vehicle lost a connection with the cloud.The time, in milliseconds, to deliver a campaign after it was approved.getTags()Tag Manager which manages the tags for this resource.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.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidSpecifies how to update a campaign.voidsetCollectionScheme(IResolvable value) The data collection scheme associated with the campaign.voidThe data collection scheme associated with the campaign.voidsetCompression(String value) Whether to compress signals before transmitting data to AWS IoT FleetWise .voidsetDataDestinationConfigs(List<Object> value) The destination where the campaign sends data.voidThe destination where the campaign sends data.voidsetDataExtraDimensions(List<String> value) A list of vehicle attributes to associate with a campaign.voidsetDataPartitions(List<Object> value) The data partitions associated with the signals collected from the vehicle.voidsetDataPartitions(IResolvable value) The data partitions associated with the signals collected from the vehicle.voidsetDescription(String value) The description of the campaign.voidsetDiagnosticsMode(String value) Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .voidsetExpiryTime(String value) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).voidThe name of a campaign.voidHow long (in milliseconds) to collect raw data after a triggering event initiates the collection.voidsetPriority(Number value) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.voidsetSignalCatalogArn(String value) The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.voidsetSignalsToCollect(List<Object> value) A list of information about signals to collect.voidsetSignalsToCollect(IResolvable value) A list of information about signals to collect.voidsetSignalsToFetch(List<Object> value) A list of information about signals to fetch.voidsetSignalsToFetch(IResolvable value) A list of information about signals to fetch.voidsetSpoolingMode(String value) Whether to store collected data after a vehicle lost a connection with the cloud.voidsetStartTime(String value) The time, in milliseconds, to deliver a campaign after it was approved.voidsetTagsRaw(List<CfnTag> value) Metadata that can be used to manage the campaign.voidsetTargetArn(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, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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) Create a newAWS::IoTFleetWise::Campaign.- 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
-
fromCampaignArn
@Stability(Stable) @NotNull public static ICampaignRef fromCampaignArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn) Creates a new ICampaignRef from an ARN.- Parameters:
scope- This parameter is required.id- This parameter is required.arn- This parameter is required.
-
fromCampaignName
@Stability(Stable) @NotNull public static ICampaignRef fromCampaignName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String campaignName) Creates a new ICampaignRef from a campaignName.- Parameters:
scope- This parameter is required.id- This parameter is required.campaignName- This parameter is required.
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- 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:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the campaign. -
getAttrCreationTime
The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time). -
getAttrLastModificationTime
The last time the campaign was modified. -
getAttrStatus
The state of the campaign.The status can be one of:
CREATING,WAITING_FOR_APPROVAL,RUNNING, andSUSPENDED. -
getCampaignRef
A reference to a Campaign resource.- Specified by:
getCampaignRefin interfaceICampaignRef
-
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getCollectionScheme
The data collection scheme associated with the campaign.Returns union: either
IResolvableorCfnCampaign.CollectionSchemeProperty -
setCollectionScheme
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
The name of a campaign. -
setName
The name of a campaign. -
getSignalCatalogArn
The Amazon Resource Name (ARN) of the signal catalog associated with the campaign. -
setSignalCatalogArn
The Amazon Resource Name (ARN) of the signal catalog associated with the campaign. -
getTargetArn
The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed. -
setTargetArn
The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed. -
getAction
Specifies how to update a campaign.The action can be one of the following:.
-
setAction
Specifies how to update a campaign.The action can be one of the following:.
-
getCompression
Whether to compress signals before transmitting data to AWS IoT FleetWise . -
setCompression
Whether to compress signals before transmitting data to AWS IoT FleetWise . -
getDataDestinationConfigs
The destination where the campaign sends data.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnCampaign.DataDestinationConfigProperty> -
setDataDestinationConfigs
The destination where the campaign sends data. -
setDataDestinationConfigs
The destination where the campaign sends data. -
getDataExtraDimensions
A list of vehicle attributes to associate with a campaign. -
setDataExtraDimensions
A list of vehicle attributes to associate with a campaign. -
getDataPartitions
The data partitions associated with the signals collected from the vehicle.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnCampaign.DataPartitionProperty> -
setDataPartitions
The data partitions associated with the signals collected from the vehicle. -
setDataPartitions
The data partitions associated with the signals collected from the vehicle. -
getDescription
The description of the campaign. -
setDescription
The description of the campaign. -
getDiagnosticsMode
Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise . -
setDiagnosticsMode
Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise . -
getExpiryTime
The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). -
setExpiryTime
The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). -
getPostTriggerCollectionDuration
How long (in milliseconds) to collect raw data after a triggering event initiates the collection. -
setPostTriggerCollectionDuration
How long (in milliseconds) to collect raw data after a triggering event initiates the collection. -
getPriority
A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. -
setPriority
A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. -
getSignalsToCollect
A list of information about signals to collect.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnCampaign.SignalInformationProperty> -
setSignalsToCollect
A list of information about signals to collect. -
setSignalsToCollect
A list of information about signals to collect. -
getSignalsToFetch
A list of information about signals to fetch.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnCampaign.SignalFetchInformationProperty> -
setSignalsToFetch
A list of information about signals to fetch. -
setSignalsToFetch
A list of information about signals to fetch. -
getSpoolingMode
Whether to store collected data after a vehicle lost a connection with the cloud. -
setSpoolingMode
Whether to store collected data after a vehicle lost a connection with the cloud. -
getStartTime
The time, in milliseconds, to deliver a campaign after it was approved.If it's not specified,
0is used. -
setStartTime
The time, in milliseconds, to deliver a campaign after it was approved.If it's not specified,
0is used. -
getTagsRaw
Metadata that can be used to manage the campaign. -
setTagsRaw
Metadata that can be used to manage the campaign.
-