CfnCampaign
- class aws_cdk.aws_iotfleetwise.CfnCampaign(scope, id, *, action, collection_scheme, name, signal_catalog_arn, target_arn, compression=None, data_destination_configs=None, data_extra_dimensions=None, description=None, diagnostics_mode=None, expiry_time=None, post_trigger_collection_duration=None, priority=None, signals_to_collect=None, spooling_mode=None, start_time=None, tags=None)
Bases:
CfnResourceA CloudFormation
AWS::IoTFleetWise::Campaign.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 .
- CloudformationResource:
AWS::IoTFleetWise::Campaign
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iotfleetwise as iotfleetwise cfn_campaign = iotfleetwise.CfnCampaign(self, "MyCfnCampaign", action="action", collection_scheme=iotfleetwise.CfnCampaign.CollectionSchemeProperty( condition_based_collection_scheme=iotfleetwise.CfnCampaign.ConditionBasedCollectionSchemeProperty( expression="expression", # the properties below are optional condition_language_version=123, minimum_trigger_interval_ms=123, trigger_mode="triggerMode" ), time_based_collection_scheme=iotfleetwise.CfnCampaign.TimeBasedCollectionSchemeProperty( period_ms=123 ) ), name="name", signal_catalog_arn="signalCatalogArn", target_arn="targetArn", # the properties below are optional compression="compression", data_destination_configs=[iotfleetwise.CfnCampaign.DataDestinationConfigProperty( s3_config=iotfleetwise.CfnCampaign.S3ConfigProperty( bucket_arn="bucketArn", # the properties below are optional data_format="dataFormat", prefix="prefix", storage_compression_format="storageCompressionFormat" ), timestream_config=iotfleetwise.CfnCampaign.TimestreamConfigProperty( execution_role_arn="executionRoleArn", timestream_table_arn="timestreamTableArn" ) )], data_extra_dimensions=["dataExtraDimensions"], description="description", diagnostics_mode="diagnosticsMode", expiry_time="expiryTime", post_trigger_collection_duration=123, priority=123, signals_to_collect=[iotfleetwise.CfnCampaign.SignalInformationProperty( name="name", # the properties below are optional max_sample_count=123, minimum_sampling_interval_ms=123 )], spooling_mode="spoolingMode", start_time="startTime", tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::IoTFleetWise::Campaign.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
action (
str) – 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.collection_scheme (
Union[CollectionSchemeProperty,Dict[str,Any],IResolvable]) – The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.name (
str) – The name of a campaign.signal_catalog_arn (
str) – The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.target_arn (
str) – The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.compression (
Optional[str]) – (Optional) Whether to compress signals before transmitting data to AWS IoT FleetWise . If you don’t want to compress the signals, useOFF. If it’s not specified,SNAPPYis used. Default:SNAPPYdata_destination_configs (
Union[IResolvable,Sequence[Union[IResolvable,DataDestinationConfigProperty,Dict[str,Any]]],None]) – (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.data_extra_dimensions (
Optional[Sequence[str]]) – (Optional) A list of vehicle attributes to associate with a campaign. Enrich the data with specified vehicle attributes. For example, addmakeandmodelto 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 arraydescription (
Optional[str]) – (Optional) The description of the campaign.diagnostics_mode (
Optional[str]) – (Optional) Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise . If you want to send diagnostic trouble codes, useSEND_ACTIVE_DTCS. If it’s not specified,OFFis used. Default:OFFexpiry_time (
Optional[str]) – (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)post_trigger_collection_duration (
Union[int,float,None]) – (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it’s not specified,0is used. Default:0priority (
Union[int,float,None]) – (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,0is used. Default:0signals_to_collect (
Union[IResolvable,Sequence[Union[IResolvable,SignalInformationProperty,Dict[str,Any]]],None]) – (Optional) A list of information about signals to collect.spooling_mode (
Optional[str]) – (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, useTO_DISK. If it’s not specified,OFFis used. Default:OFFstart_time (
Optional[str]) – (Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it’s not specified,0is used. Default:0tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – (Optional) Metadata that can be used to manage the campaign.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str) –value (
Any) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).- Parameters:
policy (
Optional[RemovalPolicy]) –apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::IoTFleetWise::Campaign'
- action
.
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.
- Link:
- Type:
Specifies how to update a campaign. The action can be one of the following
- attr_arn
The Amazon Resource Name (ARN) of the campaign.
- CloudformationAttribute:
Arn
- attr_creation_time
The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
- CloudformationAttribute:
CreationTime
- attr_last_modification_time
The last time the campaign was modified.
- CloudformationAttribute:
LastModificationTime
- attr_status
The state of the campaign.
The status can be one of:
CREATING,WAITING_FOR_APPROVAL,RUNNING, andSUSPENDED.- CloudformationAttribute:
Status
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- collection_scheme
The data collection scheme associated with the campaign.
You can specify a scheme that collects data based on time or an event.
- compression
(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,SNAPPYis used.Default:
SNAPPY
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- data_destination_configs
(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.
- data_extra_dimensions
(Optional) 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
- description
(Optional) The description of the campaign.
- diagnostics_mode
(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,OFFis used.Default:
OFF
- expiry_time
(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)
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of a campaign.
- node
The construct tree node associated with this construct.
- post_trigger_collection_duration
(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
If it’s not specified,
0is used.Default:
0
- priority
(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,
0is used.Default:
0
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- signal_catalog_arn
The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.
- signals_to_collect
(Optional) A list of information about signals to collect.
- spooling_mode
(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,OFFis used.Default:
OFF
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- start_time
(Optional) The time, in milliseconds, to deliver a campaign after it was approved.
If it’s not specified,
0is used.Default:
0
- tags
(Optional) Metadata that can be used to manage the campaign.
- target_arn
The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any) –- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any) –- Return type:
bool
CollectionSchemeProperty
- class CfnCampaign.CollectionSchemeProperty(*, condition_based_collection_scheme=None, time_based_collection_scheme=None)
Bases:
objectSpecifies what data to collect and how often or when to collect it.
- Parameters:
condition_based_collection_scheme (
Union[IResolvable,ConditionBasedCollectionSchemeProperty,Dict[str,Any],None]) – (Optional) Information about a collection scheme that uses a simple logical expression to recognize what data to collect.time_based_collection_scheme (
Union[IResolvable,TimeBasedCollectionSchemeProperty,Dict[str,Any],None]) – (Optional) Information about a collection scheme that uses a time period to decide how often to collect data.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iotfleetwise as iotfleetwise collection_scheme_property = iotfleetwise.CfnCampaign.CollectionSchemeProperty( condition_based_collection_scheme=iotfleetwise.CfnCampaign.ConditionBasedCollectionSchemeProperty( expression="expression", # the properties below are optional condition_language_version=123, minimum_trigger_interval_ms=123, trigger_mode="triggerMode" ), time_based_collection_scheme=iotfleetwise.CfnCampaign.TimeBasedCollectionSchemeProperty( period_ms=123 ) )
Attributes
- condition_based_collection_scheme
(Optional) Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
- time_based_collection_scheme
(Optional) Information about a collection scheme that uses a time period to decide how often to collect data.
ConditionBasedCollectionSchemeProperty
- class CfnCampaign.ConditionBasedCollectionSchemeProperty(*, expression, condition_language_version=None, minimum_trigger_interval_ms=None, trigger_mode=None)
Bases:
objectInformation about a collection scheme that uses a simple logical expression to recognize what data to collect.
- Parameters:
expression (
str) – The logical expression used to recognize what data to collect. For example,$variable.Vehicle.OutsideAirTemperature >= 105.0.condition_language_version (
Union[int,float,None]) – (Optional) Specifies the version of the conditional expression language.minimum_trigger_interval_ms (
Union[int,float,None]) – (Optional) The minimum duration of time between two triggering events to collect data, in milliseconds. .. epigraph:: If a signal changes often, you might want to collect data at a slower rate.trigger_mode (
Optional[str]) – (Optional) Whether to collect data for all triggering events (ALWAYS). Specify (RISING_EDGE), or specify only when the condition first evaluates to false. For example, triggering on “AirbagDeployed”; Users aren’t interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iotfleetwise as iotfleetwise condition_based_collection_scheme_property = iotfleetwise.CfnCampaign.ConditionBasedCollectionSchemeProperty( expression="expression", # the properties below are optional condition_language_version=123, minimum_trigger_interval_ms=123, trigger_mode="triggerMode" )
Attributes
- condition_language_version
(Optional) Specifies the version of the conditional expression language.
- expression
The logical expression used to recognize what data to collect.
For example,
$variable.Vehicle.OutsideAirTemperature >= 105.0.
- minimum_trigger_interval_ms
(Optional) The minimum duration of time between two triggering events to collect data, in milliseconds.
If a signal changes often, you might want to collect data at a slower rate.
- trigger_mode
(Optional) Whether to collect data for all triggering events (
ALWAYS).Specify (
RISING_EDGE), or specify only when the condition first evaluates to false. For example, triggering on “AirbagDeployed”; Users aren’t interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.
DataDestinationConfigProperty
- class CfnCampaign.DataDestinationConfigProperty(*, s3_config=None, timestream_config=None)
Bases:
objectThe destination where the AWS IoT FleetWise campaign sends data.
You can send data to be stored in Amazon S3 or Amazon Timestream .
- Parameters:
s3_config (
Union[IResolvable,S3ConfigProperty,Dict[str,Any],None]) – (Optional) The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.timestream_config (
Union[IResolvable,TimestreamConfigProperty,Dict[str,Any],None]) – (Optional) The Amazon Timestream table where the campaign sends data.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iotfleetwise as iotfleetwise data_destination_config_property = iotfleetwise.CfnCampaign.DataDestinationConfigProperty( s3_config=iotfleetwise.CfnCampaign.S3ConfigProperty( bucket_arn="bucketArn", # the properties below are optional data_format="dataFormat", prefix="prefix", storage_compression_format="storageCompressionFormat" ), timestream_config=iotfleetwise.CfnCampaign.TimestreamConfigProperty( execution_role_arn="executionRoleArn", timestream_table_arn="timestreamTableArn" ) )
Attributes
- s3_config
(Optional) The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.
- timestream_config
(Optional) The Amazon Timestream table where the campaign sends data.
S3ConfigProperty
- class CfnCampaign.S3ConfigProperty(*, bucket_arn, data_format=None, prefix=None, storage_compression_format=None)
Bases:
objectThe Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.
Amazon S3 is an object storage service that stores data as objects within buckets. For more information, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide .
- Parameters:
bucket_arn (
str) – The Amazon Resource Name (ARN) of the Amazon S3 bucket.data_format (
Optional[str]) – (Optional) Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format. - Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default. - JSON - Store data in a standard text-based JSON file format.prefix (
Optional[str]) – (Optional) Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide . By default, AWS IoT FleetWise sets the prefixprocessed-data/year=YY/month=MM/date=DD/hour=HH/(in UTC) to data it delivers to Amazon S3 . You can enter a prefix to append it to this default prefix. For example, if you enter the prefixvehicles, the prefix will bevehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/.storage_compression_format (
Optional[str]) – (Optional) By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iotfleetwise as iotfleetwise s3_config_property = iotfleetwise.CfnCampaign.S3ConfigProperty( bucket_arn="bucketArn", # the properties below are optional data_format="dataFormat", prefix="prefix", storage_compression_format="storageCompressionFormat" )
Attributes
- bucket_arn
The Amazon Resource Name (ARN) of the Amazon S3 bucket.
- data_format
(Optional) Specify the format that files are saved in the Amazon S3 bucket.
You can save files in an Apache Parquet or JSON format.
Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.
JSON - Store data in a standard text-based JSON file format.
- prefix
(Optional) Enter an S3 bucket prefix.
The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide .
By default, AWS IoT FleetWise sets the prefix
processed-data/year=YY/month=MM/date=DD/hour=HH/(in UTC) to data it delivers to Amazon S3 . You can enter a prefix to append it to this default prefix. For example, if you enter the prefixvehicles, the prefix will bevehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/.
- storage_compression_format
(Optional) By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.
SignalInformationProperty
- class CfnCampaign.SignalInformationProperty(*, name, max_sample_count=None, minimum_sampling_interval_ms=None)
Bases:
objectInformation about a signal.
- Parameters:
name (
str) – The name of the signal.max_sample_count (
Union[int,float,None]) – (Optional) The maximum number of samples to collect.minimum_sampling_interval_ms (
Union[int,float,None]) – (Optional) The minimum duration of time (in milliseconds) between two triggering events to collect data. .. epigraph:: If a signal changes often, you might want to collect data at a slower rate.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iotfleetwise as iotfleetwise signal_information_property = iotfleetwise.CfnCampaign.SignalInformationProperty( name="name", # the properties below are optional max_sample_count=123, minimum_sampling_interval_ms=123 )
Attributes
- max_sample_count
(Optional) The maximum number of samples to collect.
- minimum_sampling_interval_ms
(Optional) The minimum duration of time (in milliseconds) between two triggering events to collect data.
If a signal changes often, you might want to collect data at a slower rate.
TimeBasedCollectionSchemeProperty
- class CfnCampaign.TimeBasedCollectionSchemeProperty(*, period_ms)
Bases:
objectInformation about a collection scheme that uses a time period to decide how often to collect data.
- Parameters:
period_ms (
Union[int,float]) – The time period (in milliseconds) to decide how often to collect data. For example, if the time period is60000, the Edge Agent software collects data once every minute.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iotfleetwise as iotfleetwise time_based_collection_scheme_property = iotfleetwise.CfnCampaign.TimeBasedCollectionSchemeProperty( period_ms=123 )
Attributes
- period_ms
The time period (in milliseconds) to decide how often to collect data.
For example, if the time period is
60000, the Edge Agent software collects data once every minute.
TimestreamConfigProperty
- class CfnCampaign.TimestreamConfigProperty(*, execution_role_arn, timestream_table_arn)
Bases:
objectThe Amazon Timestream table where the AWS IoT FleetWise campaign sends data.
Timestream stores and organizes data to optimize query processing time and to reduce storage costs. For more information, see Data modeling in the Amazon Timestream Developer Guide .
- Parameters:
execution_role_arn (
str) – The Amazon Resource Name (ARN) of the task execution role that grants AWS IoT FleetWise permission to deliver data to the Amazon Timestream table.timestream_table_arn (
str) – The Amazon Resource Name (ARN) of the Amazon Timestream table.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iotfleetwise as iotfleetwise timestream_config_property = iotfleetwise.CfnCampaign.TimestreamConfigProperty( execution_role_arn="executionRoleArn", timestream_table_arn="timestreamTableArn" )
Attributes
- execution_role_arn
The Amazon Resource Name (ARN) of the task execution role that grants AWS IoT FleetWise permission to deliver data to the Amazon Timestream table.
- timestream_table_arn
The Amazon Resource Name (ARN) of the Amazon Timestream table.