Class CfnCampaignProps.Jsii$Proxy
- All Implemented Interfaces:
CfnCampaignProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnCampaignProps
CfnCampaignProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iotfleetwise.CfnCampaignProps
CfnCampaignProps.Builder, CfnCampaignProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(CfnCampaignProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnCampaignProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final String
Specifies how to update a campaign.final Object
The data collection scheme associated with the campaign.final String
(Optional) Whether to compress signals before transmitting data to AWS IoT FleetWise .final Object
(Optional) The destination where the campaign sends data.(Optional) A list of vehicle attributes to associate with a campaign.final Object
final String
(Optional) The description of the campaign.final String
(Optional) Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .final String
(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).final String
getName()
The name of a campaign.final Number
(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.final Number
(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.final String
The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.final Object
(Optional) A list of information about signals to collect.final Object
final String
(Optional) Whether to store collected data after a vehicle lost a connection with the cloud.final String
(Optional) The time, in milliseconds, to deliver a campaign after it was approved.getTags()
(Optional) Metadata that can be used to manage the campaign.final String
The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnCampaignProps.Builder
.
-
-
Method Details
-
getCollectionScheme
Description copied from interface:CfnCampaignProps
The data collection scheme associated with the campaign.You can specify a scheme that collects data based on time or an event.
- Specified by:
getCollectionScheme
in interfaceCfnCampaignProps
- See Also:
-
getName
Description copied from interface:CfnCampaignProps
The name of a campaign.- Specified by:
getName
in interfaceCfnCampaignProps
- See Also:
-
getSignalCatalogArn
Description copied from interface:CfnCampaignProps
The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.- Specified by:
getSignalCatalogArn
in interfaceCfnCampaignProps
- See Also:
-
getTargetArn
Description copied from interface:CfnCampaignProps
The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.- Specified by:
getTargetArn
in interfaceCfnCampaignProps
- See Also:
-
getAction
Description copied from interface:CfnCampaignProps
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 theSUSPEND
campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.UPDATE
- To update a campaign.
- Specified by:
getAction
in interfaceCfnCampaignProps
- See Also:
-
getCompression
Description copied from interface:CfnCampaignProps
(Optional) 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,SNAPPY
is used.Default:
SNAPPY
Default: - "OFF"
- Specified by:
getCompression
in interfaceCfnCampaignProps
- See Also:
-
getDataDestinationConfigs
Description copied from interface:CfnCampaignProps
(Optional) 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.
- Specified by:
getDataDestinationConfigs
in interfaceCfnCampaignProps
- See Also:
-
getDataExtraDimensions
Description copied from interface:CfnCampaignProps
(Optional) A list of vehicle attributes to associate with a campaign.Enrich the data with specified vehicle attributes. For example, add
make
andmodel
to the campaign, and AWS IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream . You can then query the data againstmake
andmodel
.Default: An empty array
- Specified by:
getDataExtraDimensions
in interfaceCfnCampaignProps
- See Also:
-
getDataPartitions
- Specified by:
getDataPartitions
in interfaceCfnCampaignProps
- See Also:
-
getDescription
Description copied from interface:CfnCampaignProps
(Optional) The description of the campaign.- Specified by:
getDescription
in interfaceCfnCampaignProps
- See Also:
-
getDiagnosticsMode
Description copied from interface:CfnCampaignProps
(Optional) 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,OFF
is used.Default:
OFF
Default: - "OFF"
- Specified by:
getDiagnosticsMode
in interfaceCfnCampaignProps
- See Also:
-
getExpiryTime
Description copied from interface:CfnCampaignProps
(Optional) 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"
- Specified by:
getExpiryTime
in interfaceCfnCampaignProps
- See Also:
-
getPostTriggerCollectionDuration
Description copied from interface:CfnCampaignProps
(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.If it's not specified,
0
is used.Default:
0
Default: - 0
- Specified by:
getPostTriggerCollectionDuration
in interfaceCfnCampaignProps
- See Also:
-
getPriority
Description copied from interface:CfnCampaignProps
(Optional) 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,
0
is used.Default:
0
Default: - 0
- Specified by:
getPriority
in interfaceCfnCampaignProps
- See Also:
-
getSignalsToCollect
Description copied from interface:CfnCampaignProps
(Optional) A list of information about signals to collect.- Specified by:
getSignalsToCollect
in interfaceCfnCampaignProps
- See Also:
-
getSignalsToFetch
- Specified by:
getSignalsToFetch
in interfaceCfnCampaignProps
- See Also:
-
getSpoolingMode
Description copied from interface:CfnCampaignProps
(Optional) 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,OFF
is used.Default:
OFF
Default: - "OFF"
- Specified by:
getSpoolingMode
in interfaceCfnCampaignProps
- See Also:
-
getStartTime
Description copied from interface:CfnCampaignProps
(Optional) The time, in milliseconds, to deliver a campaign after it was approved.If it's not specified,
0
is used.Default:
0
Default: - "0"
- Specified by:
getStartTime
in interfaceCfnCampaignProps
- See Also:
-
getTags
Description copied from interface:CfnCampaignProps
(Optional) Metadata that can be used to manage the campaign.- Specified by:
getTags
in interfaceCfnCampaignProps
- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-