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.103.1 (build bef2dea)",
date="2024-10-11T15:56:00.393Z")
@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")) .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())) .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
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnCampaign
.static interface
Specifies what data to collect and how often or when to collect it.static interface
Information about a collection scheme that uses a simple logical expression to recognize what data to collect.static interface
Example:static interface
The destination where the AWS IoT FleetWise campaign sends data.static interface
Example:static interface
The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.static interface
Example:static interface
Example:static interface
Information about a signal.static interface
Information about a collection scheme that uses a time period to decide how often to collect data.static interface
Example:static interface
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
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
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 TypeMethodDescriptionSpecifies 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.The data collection scheme associated with the campaign.(Optional) Whether to compress signals before transmitting data to AWS IoT FleetWise .(Optional) The destination where the campaign sends data.(Optional) A list of vehicle attributes to associate with a campaign.(Optional) The description of the campaign.(Optional) Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).getName()
The name of a campaign.(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.(Optional) 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.(Optional) A list of information about signals to collect.(Optional) Whether to store collected data after a vehicle lost a connection with the cloud.(Optional) The time, in milliseconds, to deliver a campaign after it was approved.getTags()
Tag Manager which manages the tags for this resource.(Optional) 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.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
Specifies how to update a campaign.void
setCollectionScheme
(IResolvable value) The data collection scheme associated with the campaign.void
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
(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
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
The name of a campaign.void
(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
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in 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:
renderProperties
in 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
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getCollectionScheme
The data collection scheme associated with the campaign. -
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
(Optional) Whether to compress signals before transmitting data to AWS IoT FleetWise . -
setCompression
(Optional) Whether to compress signals before transmitting data to AWS IoT FleetWise . -
getDataDestinationConfigs
(Optional) The destination where the campaign sends data. -
setDataDestinationConfigs
(Optional) The destination where the campaign sends data. -
setDataDestinationConfigs
(Optional) The destination where the campaign sends data. -
getDataExtraDimensions
(Optional) A list of vehicle attributes to associate with a campaign. -
setDataExtraDimensions
(Optional) A list of vehicle attributes to associate with a campaign. -
getDescription
(Optional) The description of the campaign. -
setDescription
(Optional) The description of the campaign. -
getDiagnosticsMode
(Optional) Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise . -
setDiagnosticsMode
(Optional) Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise . -
getExpiryTime
(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). -
setExpiryTime
(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). -
getPostTriggerCollectionDuration
(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. -
setPostTriggerCollectionDuration
(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. -
getPriority
(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. -
setPriority
(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. -
getSignalsToCollect
(Optional) A list of information about signals to collect. -
setSignalsToCollect
(Optional) A list of information about signals to collect. -
setSignalsToCollect
(Optional) A list of information about signals to collect. -
getSignalsToFetch
-
setSignalsToFetch
-
setSignalsToFetch
-
getSpoolingMode
(Optional) Whether to store collected data after a vehicle lost a connection with the cloud. -
setSpoolingMode
(Optional) Whether to store collected data after a vehicle lost a connection with the cloud. -
getStartTime
(Optional) The time, in milliseconds, to deliver a campaign after it was approved. -
setStartTime
(Optional) The time, in milliseconds, to deliver a campaign after it was approved. -
getTagsRaw
(Optional) Metadata that can be used to manage the campaign. -
setTagsRaw
(Optional) Metadata that can be used to manage the campaign.
-