import * as cdk from "../../core/lib"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; import { CampaignReference, DecoderManifestReference, FleetReference, ICampaignRef, IDecoderManifestRef, IFleetRef, IModelManifestRef, ISignalCatalogRef, IStateTemplateRef, IVehicleRef, ModelManifestReference, SignalCatalogReference, StateTemplateReference, VehicleReference } from "../../interfaces/generated/aws-iotfleetwise-interfaces.generated"; /** * 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 [Campaigns](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/campaigns.html) 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](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* . * * @cloudformationResource AWS::IoTFleetWise::Campaign * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html */ export declare class CfnCampaign extends cdk.CfnResource implements cdk.IInspectable, ICampaignRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnCampaign from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCampaign; /** * Checks whether the given object is a CfnCampaign */ static isCfnCampaign(x: any): x is CfnCampaign; /** * Creates a new ICampaignRef from an ARN */ static fromCampaignArn(scope: constructs.Construct, id: string, arn: string): ICampaignRef; /** * Creates a new ICampaignRef from a campaignName */ static fromCampaignName(scope: constructs.Construct, id: string, campaignName: string): ICampaignRef; static arnForCampaign(resource: ICampaignRef): string; /** * Specifies how to update a campaign. The action can be one of the following:. */ action?: string; /** * The data collection scheme associated with the campaign. */ collectionScheme: CfnCampaign.CollectionSchemeProperty | cdk.IResolvable; /** * Whether to compress signals before transmitting data to AWS IoT FleetWise . */ compression?: string; /** * The destination where the campaign sends data. */ dataDestinationConfigs?: Array | cdk.IResolvable; /** * A list of vehicle attributes to associate with a campaign. */ dataExtraDimensions?: Array; /** * The data partitions associated with the signals collected from the vehicle. */ dataPartitions?: Array | cdk.IResolvable; /** * The description of the campaign. */ description?: string; /** * Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise . */ diagnosticsMode?: string; /** * The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). */ expiryTime?: string; /** * The name of a campaign. */ name: string; /** * How long (in milliseconds) to collect raw data after a triggering event initiates the collection. */ postTriggerCollectionDuration?: number; /** * A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. */ priority?: number; /** * The Amazon Resource Name (ARN) of the signal catalog associated with the campaign. */ signalCatalogArn: string; /** * A list of information about signals to collect. */ signalsToCollect?: Array | cdk.IResolvable; /** * A list of information about signals to fetch. */ signalsToFetch?: Array | cdk.IResolvable; /** * Whether to store collected data after a vehicle lost a connection with the cloud. */ spoolingMode?: string; /** * The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, `0` is used. */ startTime?: string; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Metadata that can be used to manage the campaign. */ tagsRaw?: Array; /** * The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed. */ targetArn: string; /** * Create a new `AWS::IoTFleetWise::Campaign`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnCampaignProps); get campaignRef(): CampaignReference; /** * The Amazon Resource Name (ARN) of the campaign. * * @cloudformationAttribute Arn */ get attrArn(): string; /** * The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time). * * @cloudformationAttribute CreationTime */ get attrCreationTime(): string; /** * The last time the campaign was modified. * * @cloudformationAttribute LastModificationTime */ get attrLastModificationTime(): string; /** * The state of the campaign. The status can be one of: `CREATING` , `WAITING_FOR_APPROVAL` , `RUNNING` , and `SUSPENDED` . * * @cloudformationAttribute Status */ get attrStatus(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnCampaign { /** * Information about a signal. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html */ interface SignalInformationProperty { /** * The ID of the data partition this signal is associated with. * * The ID must match one of the IDs provided in `dataPartitions` . This is accomplished either by specifying a particular data partition ID or by using `default` for an established default partition. You can establish a default partition in the `DataPartition` data type. * * > If you upload a signal as a condition for a campaign's data partition, the same signal must be included in `signalsToCollect` . > Access to certain AWS IoT FleetWise features is currently gated. For more information, see [AWS Region and feature availability](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html#cfn-iotfleetwise-campaign-signalinformation-datapartitionid */ readonly dataPartitionId?: string; /** * The maximum number of samples to collect. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html#cfn-iotfleetwise-campaign-signalinformation-maxsamplecount */ readonly maxSampleCount?: number; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html#cfn-iotfleetwise-campaign-signalinformation-minimumsamplingintervalms */ readonly minimumSamplingIntervalMs?: number; /** * The name of the signal. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html#cfn-iotfleetwise-campaign-signalinformation-name */ readonly name: string; } /** * The destination where the AWS IoT FleetWise campaign sends data. * * You can send data to be stored in Amazon S3 or Amazon Timestream . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.html */ interface DataDestinationConfigProperty { /** * The MQTT topic to which the AWS IoT FleetWise campaign routes data. * * > Access to certain AWS IoT FleetWise features is currently gated. For more information, see [AWS Region and feature availability](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.html#cfn-iotfleetwise-campaign-datadestinationconfig-mqtttopicconfig */ readonly mqttTopicConfig?: cdk.IResolvable | CfnCampaign.MqttTopicConfigProperty; /** * The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.html#cfn-iotfleetwise-campaign-datadestinationconfig-s3config */ readonly s3Config?: cdk.IResolvable | CfnCampaign.S3ConfigProperty; /** * The Amazon Timestream table where the campaign sends data. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.html#cfn-iotfleetwise-campaign-datadestinationconfig-timestreamconfig */ readonly timestreamConfig?: cdk.IResolvable | CfnCampaign.TimestreamConfigProperty; } /** * The 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the *Amazon Simple Storage Service User Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html */ interface S3ConfigProperty { /** * The Amazon Resource Name (ARN) of the Amazon S3 bucket. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html#cfn-iotfleetwise-campaign-s3config-bucketarn */ readonly bucketArn: string; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html#cfn-iotfleetwise-campaign-s3config-dataformat */ readonly dataFormat?: string; /** * 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html) 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 prefix `vehicles` , the prefix will be `vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html#cfn-iotfleetwise-campaign-s3config-prefix */ readonly prefix?: string; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html#cfn-iotfleetwise-campaign-s3config-storagecompressionformat */ readonly storageCompressionFormat?: string; } /** * The 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](https://docs.aws.amazon.com/timestream/latest/developerguide/data-modeling.html) in the *Amazon Timestream Developer Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timestreamconfig.html */ interface TimestreamConfigProperty { /** * The Amazon Resource Name (ARN) of the task execution role that grants AWS IoT FleetWise permission to deliver data to the Amazon Timestream table. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timestreamconfig.html#cfn-iotfleetwise-campaign-timestreamconfig-executionrolearn */ readonly executionRoleArn: string; /** * The Amazon Resource Name (ARN) of the Amazon Timestream table. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timestreamconfig.html#cfn-iotfleetwise-campaign-timestreamconfig-timestreamtablearn */ readonly timestreamTableArn: string; } /** * The MQTT topic to which the AWS IoT FleetWise campaign routes data. * * For more information, see [Device communication protocols](https://docs.aws.amazon.com/iot/latest/developerguide/protocols.html) in the *AWS IoT Core Developer Guide* . * * > Access to certain AWS IoT FleetWise features is currently gated. For more information, see [AWS Region and feature availability](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-mqtttopicconfig.html */ interface MqttTopicConfigProperty { /** * The ARN of the role that grants AWS IoT FleetWise permission to access and act on messages sent to the MQTT topic. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-mqtttopicconfig.html#cfn-iotfleetwise-campaign-mqtttopicconfig-executionrolearn */ readonly executionRoleArn: string; /** * The ARN of the MQTT topic. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-mqtttopicconfig.html#cfn-iotfleetwise-campaign-mqtttopicconfig-mqtttopicarn */ readonly mqttTopicArn: string; } /** * Specifies what data to collect and how often or when to collect it. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html */ interface CollectionSchemeProperty { /** * Information about a collection scheme that uses a simple logical expression to recognize what data to collect. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html#cfn-iotfleetwise-campaign-collectionscheme-conditionbasedcollectionscheme */ readonly conditionBasedCollectionScheme?: CfnCampaign.ConditionBasedCollectionSchemeProperty | cdk.IResolvable; /** * Information about a collection scheme that uses a time period to decide how often to collect data. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html#cfn-iotfleetwise-campaign-collectionscheme-timebasedcollectionscheme */ readonly timeBasedCollectionScheme?: cdk.IResolvable | CfnCampaign.TimeBasedCollectionSchemeProperty; } /** * Information about a collection scheme that uses a time period to decide how often to collect data. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedcollectionscheme.html */ interface TimeBasedCollectionSchemeProperty { /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedcollectionscheme.html#cfn-iotfleetwise-campaign-timebasedcollectionscheme-periodms */ readonly periodMs: number; } /** * Information about a collection scheme that uses a simple logical expression to recognize what data to collect. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html */ interface ConditionBasedCollectionSchemeProperty { /** * Specifies the version of the conditional expression language. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-conditionlanguageversion */ readonly conditionLanguageVersion?: number; /** * The logical expression used to recognize what data to collect. * * For example, `$variable.Vehicle.OutsideAirTemperature >= 105.0` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-expression */ readonly expression: string; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-minimumtriggerintervalms */ readonly minimumTriggerIntervalMs?: number; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-triggermode */ readonly triggerMode?: string; } /** * Information about the signal to be fetched. * * > Access to certain AWS IoT FleetWise features is currently gated. For more information, see [AWS Region and feature availability](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html */ interface SignalFetchInformationProperty { /** * The actions to be performed by the signal fetch. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-actions */ readonly actions: Array; /** * The version of the condition language used. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-conditionlanguageversion */ readonly conditionLanguageVersion?: number; /** * The fully qualified name of the signal to be fetched. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-fullyqualifiedname */ readonly fullyQualifiedName: string; /** * The configuration of the signal fetch operation. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-signalfetchconfig */ readonly signalFetchConfig: cdk.IResolvable | CfnCampaign.SignalFetchConfigProperty; } /** * The configuration of the signal fetch operation. * * > Access to certain AWS IoT FleetWise features is currently gated. For more information, see [AWS Region and feature availability](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchconfig.html */ interface SignalFetchConfigProperty { /** * The configuration of a condition-based signal fetch operation. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchconfig.html#cfn-iotfleetwise-campaign-signalfetchconfig-conditionbased */ readonly conditionBased?: CfnCampaign.ConditionBasedSignalFetchConfigProperty | cdk.IResolvable; /** * The configuration of a time-based signal fetch operation. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchconfig.html#cfn-iotfleetwise-campaign-signalfetchconfig-timebased */ readonly timeBased?: cdk.IResolvable | CfnCampaign.TimeBasedSignalFetchConfigProperty; } /** * Used to configure a frequency-based vehicle signal fetch. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedsignalfetchconfig.html */ interface TimeBasedSignalFetchConfigProperty { /** * The frequency with which the signal fetch will be executed. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedsignalfetchconfig.html#cfn-iotfleetwise-campaign-timebasedsignalfetchconfig-executionfrequencyms */ readonly executionFrequencyMs: number; } /** * Specifies the condition under which a signal fetch occurs. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedsignalfetchconfig.html */ interface ConditionBasedSignalFetchConfigProperty { /** * The condition that must be satisfied to trigger a signal fetch. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedsignalfetchconfig.html#cfn-iotfleetwise-campaign-conditionbasedsignalfetchconfig-conditionexpression */ readonly conditionExpression: string; /** * Indicates the mode in which the signal fetch is triggered. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedsignalfetchconfig.html#cfn-iotfleetwise-campaign-conditionbasedsignalfetchconfig-triggermode */ readonly triggerMode: string; } /** * The configuration for signal data storage and upload options. * * You can only specify these options when the campaign's spooling mode is `TO_DISK` . * * > Access to certain AWS IoT FleetWise features is currently gated. For more information, see [AWS Region and feature availability](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.html */ interface DataPartitionProperty { /** * The ID of the data partition. * * The data partition ID must be unique within a campaign. You can establish a data partition as the default partition for a campaign by using `default` as the ID. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.html#cfn-iotfleetwise-campaign-datapartition-id */ readonly id: string; /** * The storage options for a data partition. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.html#cfn-iotfleetwise-campaign-datapartition-storageoptions */ readonly storageOptions: CfnCampaign.DataPartitionStorageOptionsProperty | cdk.IResolvable; /** * The upload options for the data partition. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.html#cfn-iotfleetwise-campaign-datapartition-uploadoptions */ readonly uploadOptions?: CfnCampaign.DataPartitionUploadOptionsProperty | cdk.IResolvable; } /** * Size, time, and location options for the data partition. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html */ interface DataPartitionStorageOptionsProperty { /** * The maximum storage size of the data stored in the data partition. * * > Newer data overwrites older data when the partition reaches the maximum size. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html#cfn-iotfleetwise-campaign-datapartitionstorageoptions-maximumsize */ readonly maximumSize: cdk.IResolvable | CfnCampaign.StorageMaximumSizeProperty; /** * The amount of time that data in this partition will be kept on disk. * * - After the designated amount of time passes, the data can be removed, but it's not guaranteed to be removed. * - Before the time expires, data in this partition can still be deleted if the partition reaches its configured maximum size. * - Newer data will overwrite older data when the partition reaches the maximum size. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html#cfn-iotfleetwise-campaign-datapartitionstorageoptions-minimumtimetolive */ readonly minimumTimeToLive: cdk.IResolvable | CfnCampaign.StorageMinimumTimeToLiveProperty; /** * The folder name for the data partition under the campaign storage folder. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html#cfn-iotfleetwise-campaign-datapartitionstorageoptions-storagelocation */ readonly storageLocation: string; } /** * The maximum storage size for the data partition. * * > Access to certain AWS IoT FleetWise features is currently gated. For more information, see [AWS Region and feature availability](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storagemaximumsize.html */ interface StorageMaximumSizeProperty { /** * The data type of the data to store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storagemaximumsize.html#cfn-iotfleetwise-campaign-storagemaximumsize-unit */ readonly unit: string; /** * The maximum amount of time to store data. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storagemaximumsize.html#cfn-iotfleetwise-campaign-storagemaximumsize-value */ readonly value: number; } /** * Information about the minimum amount of time that data will be kept. * * > Access to certain AWS IoT FleetWise features is currently gated. For more information, see [AWS Region and feature availability](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storageminimumtimetolive.html */ interface StorageMinimumTimeToLiveProperty { /** * The time increment type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storageminimumtimetolive.html#cfn-iotfleetwise-campaign-storageminimumtimetolive-unit */ readonly unit: string; /** * The minimum amount of time to store the data. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storageminimumtimetolive.html#cfn-iotfleetwise-campaign-storageminimumtimetolive-value */ readonly value: number; } /** * The upload options for the data partition. * * If upload options are specified, you must also specify storage options. See [DataPartitionStorageOptions](https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_DataPartitionStorageOptions.html) . * * > Access to certain AWS IoT FleetWise features is currently gated. For more information, see [AWS Region and feature availability](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionuploadoptions.html */ interface DataPartitionUploadOptionsProperty { /** * The version of the condition language. * * Defaults to the most recent condition language version. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionuploadoptions.html#cfn-iotfleetwise-campaign-datapartitionuploadoptions-conditionlanguageversion */ readonly conditionLanguageVersion?: number; /** * The logical expression used to recognize what data to collect. * * For example, `$variable.`Vehicle.OutsideAirTemperature` >= 105.0` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionuploadoptions.html#cfn-iotfleetwise-campaign-datapartitionuploadoptions-expression */ readonly expression: string; } } /** * Properties for defining a `CfnCampaign` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html */ export 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 the `SUSPEND` campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data. * - `UPDATE` - To update a campaign. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-action */ readonly action?: string; /** * The data collection scheme associated with the campaign. * * You can specify a scheme that collects data based on time or an event. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-collectionscheme */ readonly collectionScheme: CfnCampaign.CollectionSchemeProperty | cdk.IResolvable; /** * 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" * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-compression */ readonly compression?: string; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-datadestinationconfigs */ readonly dataDestinationConfigs?: Array | cdk.IResolvable; /** * A list of vehicle attributes to associate with a campaign. * * Enrich the data with specified vehicle attributes. For example, add `make` and `model` 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 against `make` and `model` . * * Default: An empty array * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-dataextradimensions */ readonly dataExtraDimensions?: Array; /** * The data partitions associated with the signals collected from the vehicle. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-datapartitions */ readonly dataPartitions?: Array | cdk.IResolvable; /** * The description of the campaign. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-description */ readonly description?: string; /** * 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" * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-diagnosticsmode */ readonly diagnosticsMode?: string; /** * 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" * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-expirytime */ readonly expiryTime?: string; /** * The name of a campaign. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-name */ readonly name: string; /** * 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 * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-posttriggercollectionduration */ readonly postTriggerCollectionDuration?: number; /** * 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 * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-priority */ readonly priority?: number; /** * The Amazon Resource Name (ARN) of the signal catalog associated with the campaign. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-signalcatalogarn */ readonly signalCatalogArn: string; /** * A list of information about signals to collect. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-signalstocollect */ readonly signalsToCollect?: Array | cdk.IResolvable; /** * A list of information about signals to fetch. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-signalstofetch */ readonly signalsToFetch?: Array | cdk.IResolvable; /** * 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" * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-spoolingmode */ readonly spoolingMode?: string; /** * The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, `0` is used. * * Default: `0` * * @default - "0" * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-starttime */ readonly startTime?: string; /** * Metadata that can be used to manage the campaign. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-tags */ readonly tags?: Array; /** * The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-targetarn */ readonly targetArn: string; } /** * Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true:. * * - Every signal decoder has a unique name. * - Each signal decoder is associated with a network interface. * - Each network interface has a unique ID. * - The signal decoders are specified in the model manifest. * * For more information, see [Decoder manifests](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/decoder-manifests.html) 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](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* . * * @cloudformationResource AWS::IoTFleetWise::DecoderManifest * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html */ export declare class CfnDecoderManifest extends cdk.CfnResource implements cdk.IInspectable, IDecoderManifestRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnDecoderManifest from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDecoderManifest; /** * Checks whether the given object is a CfnDecoderManifest */ static isCfnDecoderManifest(x: any): x is CfnDecoderManifest; static arnForDecoderManifest(resource: IDecoderManifestRef): string; /** * Use default decoders for all unmapped signals in the model. */ defaultForUnmappedSignals?: string; /** * A brief description of the decoder manifest. */ description?: string; /** * The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest. */ modelManifestArn: string; /** * The name of the decoder manifest. */ name: string; /** * A list of information about available network interfaces. */ networkInterfaces?: Array | cdk.IResolvable; /** * A list of information about signal decoders. */ signalDecoders?: Array | cdk.IResolvable; /** * The state of the decoder manifest. */ status?: string; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Metadata that can be used to manage the decoder manifest. */ tagsRaw?: Array; /** * Create a new `AWS::IoTFleetWise::DecoderManifest`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnDecoderManifestProps); get decoderManifestRef(): DecoderManifestReference; /** * The Amazon Resource Name (ARN) of the decoder manifest. * * @cloudformationAttribute Arn */ get attrArn(): string; /** * The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time). * * @cloudformationAttribute CreationTime */ get attrCreationTime(): string; /** * The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). * * @cloudformationAttribute LastModificationTime */ get attrLastModificationTime(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnDecoderManifest { /** * Information about signal decoder using the Controller Area Network (CAN) protocol. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignaldecoder.html */ interface CanSignalDecoderProperty { /** * Information about a single controller area network (CAN) signal and the messages it receives and transmits. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignaldecoder.html#cfn-iotfleetwise-decodermanifest-cansignaldecoder-cansignal */ readonly canSignal: CfnDecoderManifest.CanSignalProperty | cdk.IResolvable; /** * The fully qualified name of a signal decoder as defined in a vehicle model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignaldecoder.html#cfn-iotfleetwise-decodermanifest-cansignaldecoder-fullyqualifiedname */ readonly fullyQualifiedName: string; /** * The ID of a network interface that specifies what network protocol a vehicle follows. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignaldecoder.html#cfn-iotfleetwise-decodermanifest-cansignaldecoder-interfaceid */ readonly interfaceId: string; /** * The network protocol for the vehicle. * * For example, `CAN_SIGNAL` specifies a protocol that defines how data is communicated between electronic control units (ECUs). `OBD_SIGNAL` specifies a protocol that defines how self-diagnostic data is communicated between ECUs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignaldecoder.html#cfn-iotfleetwise-decodermanifest-cansignaldecoder-type */ readonly type: string; } /** * Information about a single controller area network (CAN) signal and the messages it receives and transmits. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html */ interface CanSignalProperty { /** * A multiplier used to decode the CAN message. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-factor */ readonly factor: string; /** * Whether the byte ordering of a CAN message is big-endian. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-isbigendian */ readonly isBigEndian: string; /** * Whether the message data is specified as a signed value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-issigned */ readonly isSigned: string; /** * How many bytes of data are in the message. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-length */ readonly length: string; /** * The ID of the message. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-messageid */ readonly messageId: string; /** * The name of the signal. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-name */ readonly name?: string; /** * The offset used to calculate the signal value. * * Combined with factor, the calculation is `value = raw_value * factor + offset` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-offset */ readonly offset: string; /** * The value type of the signal. * * The default value is `INTEGER` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-signalvaluetype */ readonly signalValueType?: string; /** * Indicates the beginning of the CAN message. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-startbit */ readonly startBit: string; } /** * A list of information about signal decoders. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html */ interface ObdSignalDecoderProperty { /** * The fully qualified name of a signal decoder as defined in a vehicle model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html#cfn-iotfleetwise-decodermanifest-obdsignaldecoder-fullyqualifiedname */ readonly fullyQualifiedName: string; /** * The ID of a network interface that specifies what network protocol a vehicle follows. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html#cfn-iotfleetwise-decodermanifest-obdsignaldecoder-interfaceid */ readonly interfaceId: string; /** * Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html#cfn-iotfleetwise-decodermanifest-obdsignaldecoder-obdsignal */ readonly obdSignal: cdk.IResolvable | CfnDecoderManifest.ObdSignalProperty; /** * The network protocol for the vehicle. * * For example, `CAN_SIGNAL` specifies a protocol that defines how data is communicated between electronic control units (ECUs). `OBD_SIGNAL` specifies a protocol that defines how self-diagnostic data is communicated between ECUs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html#cfn-iotfleetwise-decodermanifest-obdsignaldecoder-type */ readonly type: string; } /** * Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html */ interface ObdSignalProperty { /** * The number of bits to mask in a message. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-bitmasklength */ readonly bitMaskLength?: string; /** * The number of positions to shift bits in the message. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-bitrightshift */ readonly bitRightShift?: string; /** * The length of a message. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-bytelength */ readonly byteLength: string; /** * Determines whether the message is signed ( `true` ) or not ( `false` ). * * If it's signed, the message can represent both positive and negative numbers. The `isSigned` parameter only applies to the `INTEGER` raw signal type, and it doesn't affect the `FLOATING_POINT` raw signal type. The default value is `false` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-issigned */ readonly isSigned?: boolean | cdk.IResolvable | string; /** * The offset used to calculate the signal value. * * Combined with scaling, the calculation is `value = raw_value * scaling + offset` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-offset */ readonly offset: string; /** * The diagnostic code used to request data from a vehicle for this signal. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-pid */ readonly pid: string; /** * The length of the requested data. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-pidresponselength */ readonly pidResponseLength: string; /** * A multiplier used to decode the message. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-scaling */ readonly scaling: string; /** * The mode of operation (diagnostic service) in a message. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-servicemode */ readonly serviceMode: string; /** * The value type of the signal. * * The default value is `INTEGER` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-signalvaluetype */ readonly signalValueType?: string; /** * Indicates the beginning of the message. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-startbyte */ readonly startByte: string; } /** * Information about a signal decoder. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-signaldecodersitems.html */ interface SignalDecodersItemsProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-signaldecodersitems.html#cfn-iotfleetwise-decodermanifest-signaldecodersitems-cansignal */ readonly canSignal?: CfnDecoderManifest.CanSignalProperty | cdk.IResolvable; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-signaldecodersitems.html#cfn-iotfleetwise-decodermanifest-signaldecodersitems-fullyqualifiedname */ readonly fullyQualifiedName: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-signaldecodersitems.html#cfn-iotfleetwise-decodermanifest-signaldecodersitems-interfaceid */ readonly interfaceId: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-signaldecodersitems.html#cfn-iotfleetwise-decodermanifest-signaldecodersitems-obdsignal */ readonly obdSignal?: cdk.IResolvable | CfnDecoderManifest.ObdSignalProperty; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-signaldecodersitems.html#cfn-iotfleetwise-decodermanifest-signaldecodersitems-type */ readonly type: string; } /** * Represents a node and its specifications in an in-vehicle communication network. * * All signal decoders must be associated with a network node. * * To return this information about all the network interfaces specified in a decoder manifest, use the [ListDecoderManifestNetworkInterfaces](https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_ListDecoderManifestNetworkInterfaces.html) in the *AWS IoT FleetWise API Reference* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cannetworkinterface.html */ interface CanNetworkInterfaceProperty { /** * Information about a network interface specified by the Controller Area Network (CAN) protocol. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cannetworkinterface.html#cfn-iotfleetwise-decodermanifest-cannetworkinterface-caninterface */ readonly canInterface: CfnDecoderManifest.CanInterfaceProperty | cdk.IResolvable; /** * The ID of the network interface. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cannetworkinterface.html#cfn-iotfleetwise-decodermanifest-cannetworkinterface-interfaceid */ readonly interfaceId: string; /** * The network protocol for the vehicle. * * For example, `CAN_SIGNAL` specifies a protocol that defines how data is communicated between electronic control units (ECUs). `OBD_SIGNAL` specifies a protocol that defines how self-diagnostic data is communicated between ECUs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cannetworkinterface.html#cfn-iotfleetwise-decodermanifest-cannetworkinterface-type */ readonly type: string; } /** * A single controller area network (CAN) device interface. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html */ interface CanInterfaceProperty { /** * The unique name of the interface. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html#cfn-iotfleetwise-decodermanifest-caninterface-name */ readonly name: string; /** * The name of the communication protocol for the interface. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html#cfn-iotfleetwise-decodermanifest-caninterface-protocolname */ readonly protocolName?: string; /** * The version of the communication protocol for the interface. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html#cfn-iotfleetwise-decodermanifest-caninterface-protocolversion */ readonly protocolVersion?: string; } /** * Information about a network interface specified by the On-board diagnostic (OBD) II protocol. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdnetworkinterface.html */ interface ObdNetworkInterfaceProperty { /** * The ID of the network interface. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdnetworkinterface.html#cfn-iotfleetwise-decodermanifest-obdnetworkinterface-interfaceid */ readonly interfaceId: string; /** * Information about a network interface specified by the On-board diagnostic (OBD) II protocol. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdnetworkinterface.html#cfn-iotfleetwise-decodermanifest-obdnetworkinterface-obdinterface */ readonly obdInterface: cdk.IResolvable | CfnDecoderManifest.ObdInterfaceProperty; /** * The network protocol for the vehicle. * * For example, `CAN_SIGNAL` specifies a protocol that defines how data is communicated between electronic control units (ECUs). `OBD_SIGNAL` specifies a protocol that defines how self-diagnostic data is communicated between ECUs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdnetworkinterface.html#cfn-iotfleetwise-decodermanifest-obdnetworkinterface-type */ readonly type: string; } /** * A network interface that specifies the On-board diagnostic (OBD) II network protocol. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html */ interface ObdInterfaceProperty { /** * The maximum number message requests per diagnostic trouble code per second. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-dtcrequestintervalseconds */ readonly dtcRequestIntervalSeconds?: string; /** * Whether the vehicle has a transmission control module (TCM). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-hastransmissionecu */ readonly hasTransmissionEcu?: string; /** * The name of the interface. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-name */ readonly name: string; /** * The standard OBD II PID. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-obdstandard */ readonly obdStandard?: string; /** * The maximum number message requests per second. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-pidrequestintervalseconds */ readonly pidRequestIntervalSeconds?: string; /** * The ID of the message requesting vehicle data. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-requestmessageid */ readonly requestMessageId: string; /** * Whether to use extended IDs in the message. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-useextendedids */ readonly useExtendedIds?: string; } /** * A list of information about available network interfaces. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html */ interface NetworkInterfacesItemsProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html#cfn-iotfleetwise-decodermanifest-networkinterfacesitems-caninterface */ readonly canInterface?: CfnDecoderManifest.CanInterfaceProperty | cdk.IResolvable; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html#cfn-iotfleetwise-decodermanifest-networkinterfacesitems-interfaceid */ readonly interfaceId: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html#cfn-iotfleetwise-decodermanifest-networkinterfacesitems-obdinterface */ readonly obdInterface?: cdk.IResolvable | CfnDecoderManifest.ObdInterfaceProperty; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html#cfn-iotfleetwise-decodermanifest-networkinterfacesitems-type */ readonly type: string; } } /** * Properties for defining a `CfnDecoderManifest` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html */ export interface CfnDecoderManifestProps { /** * Use default decoders for all unmapped signals in the model. * * You don't need to provide any detailed decoding information. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-defaultforunmappedsignals */ readonly defaultForUnmappedSignals?: string; /** * A brief description of the decoder manifest. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-description */ readonly description?: string; /** * The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-modelmanifestarn */ readonly modelManifestArn: string; /** * The name of the decoder manifest. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-name */ readonly name: string; /** * A list of information about available network interfaces. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-networkinterfaces */ readonly networkInterfaces?: Array | cdk.IResolvable; /** * A list of information about signal decoders. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-signaldecoders */ readonly signalDecoders?: Array | cdk.IResolvable; /** * The state of the decoder manifest. * * If the status is `ACTIVE` , the decoder manifest can't be edited. If the status is marked `DRAFT` , you can edit the decoder manifest. * * @default - "DRAFT" * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-status */ readonly status?: string; /** * Metadata that can be used to manage the decoder manifest. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-tags */ readonly tags?: Array; } /** * Creates a fleet that represents a group of vehicles. * * > You must create both a signal catalog and vehicles before you can create a fleet. * * For more information, see [Fleets](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleets.html) in the *AWS IoT FleetWise Developer Guide* . * * @cloudformationResource AWS::IoTFleetWise::Fleet * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-fleet.html */ export declare class CfnFleet extends cdk.CfnResource implements cdk.IInspectable, IFleetRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnFleet from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnFleet; /** * Checks whether the given object is a CfnFleet */ static isCfnFleet(x: any): x is CfnFleet; /** * Creates a new IFleetRef from an ARN */ static fromFleetArn(scope: constructs.Construct, id: string, arn: string): IFleetRef; /** * Creates a new IFleetRef from a fleetId */ static fromFleetId(scope: constructs.Construct, id: string, fleetId: string): IFleetRef; static arnForFleet(resource: IFleetRef): string; /** * A brief description of the fleet. */ description?: string; /** * The unique ID of the fleet. */ id: string; /** * The ARN of the signal catalog associated with the fleet. */ signalCatalogArn: string; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Metadata that can be used to manage the fleet. */ tagsRaw?: Array; /** * Create a new `AWS::IoTFleetWise::Fleet`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnFleetProps); get fleetRef(): FleetReference; /** * The Amazon Resource Name (ARN) of the created fleet. * * @cloudformationAttribute Arn */ get attrArn(): string; /** * The time the fleet was created in seconds since epoch (January 1, 1970 at midnight UTC time). * * @cloudformationAttribute CreationTime */ get attrCreationTime(): string; /** * The time the fleet was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time). * * @cloudformationAttribute LastModificationTime */ get attrLastModificationTime(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } /** * Properties for defining a `CfnFleet` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-fleet.html */ export interface CfnFleetProps { /** * A brief description of the fleet. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-fleet.html#cfn-iotfleetwise-fleet-description */ readonly description?: string; /** * The unique ID of the fleet. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-fleet.html#cfn-iotfleetwise-fleet-id */ readonly id: string; /** * The ARN of the signal catalog associated with the fleet. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-fleet.html#cfn-iotfleetwise-fleet-signalcatalogarn */ readonly signalCatalogArn: string; /** * Metadata that can be used to manage the fleet. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-fleet.html#cfn-iotfleetwise-fleet-tags */ readonly tags?: Array; } /** * Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators). * * For more information, see [Vehicle models](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/vehicle-models.html) in the *AWS IoT FleetWise Developer Guide* . * * @cloudformationResource AWS::IoTFleetWise::ModelManifest * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html */ export declare class CfnModelManifest extends cdk.CfnResource implements cdk.IInspectable, IModelManifestRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnModelManifest from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnModelManifest; /** * Checks whether the given object is a CfnModelManifest */ static isCfnModelManifest(x: any): x is CfnModelManifest; static arnForModelManifest(resource: IModelManifestRef): string; /** * A brief description of the vehicle model. */ description?: string; /** * The name of the vehicle model. */ name: string; /** * A list of nodes, which are a general abstraction of signals. */ nodes?: Array; /** * The Amazon Resource Name (ARN) of the signal catalog associated with the vehicle model. */ signalCatalogArn: string; /** * The state of the vehicle model. */ status?: string; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Metadata that can be used to manage the vehicle model. */ tagsRaw?: Array; /** * Create a new `AWS::IoTFleetWise::ModelManifest`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnModelManifestProps); get modelManifestRef(): ModelManifestReference; /** * The Amazon Resource Name (ARN) of the vehicle model. * * @cloudformationAttribute Arn */ get attrArn(): string; /** * The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time). * * @cloudformationAttribute CreationTime */ get attrCreationTime(): string; /** * The time the vehicle model was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time). * * @cloudformationAttribute LastModificationTime */ get attrLastModificationTime(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } /** * Properties for defining a `CfnModelManifest` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html */ export interface CfnModelManifestProps { /** * A brief description of the vehicle model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html#cfn-iotfleetwise-modelmanifest-description */ readonly description?: string; /** * The name of the vehicle model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html#cfn-iotfleetwise-modelmanifest-name */ readonly name: string; /** * A list of nodes, which are a general abstraction of signals. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html#cfn-iotfleetwise-modelmanifest-nodes */ readonly nodes?: Array; /** * The Amazon Resource Name (ARN) of the signal catalog associated with the vehicle model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html#cfn-iotfleetwise-modelmanifest-signalcatalogarn */ readonly signalCatalogArn: string; /** * The state of the vehicle model. * * If the status is `ACTIVE` , the vehicle model can't be edited. If the status is `DRAFT` , you can edit the vehicle model. * * @default - "DRAFT" * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html#cfn-iotfleetwise-modelmanifest-status */ readonly status?: string; /** * Metadata that can be used to manage the vehicle model. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html#cfn-iotfleetwise-modelmanifest-tags */ readonly tags?: Array; } /** * Creates a collection of standardized signals that can be reused to create vehicle models. * * For more information, see [Signal catalogs](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/signal-catalogs.html) in the *AWS IoT FleetWise Developer Guide* . * * @cloudformationResource AWS::IoTFleetWise::SignalCatalog * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html */ export declare class CfnSignalCatalog extends cdk.CfnResource implements cdk.IInspectable, ISignalCatalogRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnSignalCatalog from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnSignalCatalog; /** * Checks whether the given object is a CfnSignalCatalog */ static isCfnSignalCatalog(x: any): x is CfnSignalCatalog; static arnForSignalCatalog(resource: ISignalCatalogRef): string; /** * A brief description of the signal catalog. */ description?: string; /** * The name of the signal catalog. */ name?: string; /** * Information about the number of nodes and node types in a vehicle network. */ nodeCounts?: cdk.IResolvable | CfnSignalCatalog.NodeCountsProperty; /** * A list of information about nodes, which are a general abstraction of signals. */ nodes?: Array | cdk.IResolvable; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Metadata that can be used to manage the signal catalog. */ tagsRaw?: Array; /** * Create a new `AWS::IoTFleetWise::SignalCatalog`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props?: CfnSignalCatalogProps); get signalCatalogRef(): SignalCatalogReference; /** * The Amazon Resource Name (ARN) of the signal catalog. * * @cloudformationAttribute Arn */ get attrArn(): string; /** * The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time). * * @cloudformationAttribute CreationTime */ get attrCreationTime(): string; /** * The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). * * @cloudformationAttribute LastModificationTime */ get attrLastModificationTime(): string; /** * The total number of nodes in a vehicle network that represent actuators. * * @cloudformationAttribute NodeCounts.TotalActuators */ get attrNodeCountsTotalActuators(): cdk.IResolvable; /** * The total number of nodes in a vehicle network that represent attributes. * * @cloudformationAttribute NodeCounts.TotalAttributes */ get attrNodeCountsTotalAttributes(): cdk.IResolvable; /** * The total number of nodes in a vehicle network that represent branches. * * @cloudformationAttribute NodeCounts.TotalBranches */ get attrNodeCountsTotalBranches(): cdk.IResolvable; /** * The total number of nodes in a vehicle network. * * @cloudformationAttribute NodeCounts.TotalNodes */ get attrNodeCountsTotalNodes(): cdk.IResolvable; /** * The total number of nodes in a vehicle network that represent sensors. * * @cloudformationAttribute NodeCounts.TotalSensors */ get attrNodeCountsTotalSensors(): cdk.IResolvable; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnSignalCatalog { /** * Information about the number of nodes and node types in a vehicle network. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html */ interface NodeCountsProperty { /** * The total number of nodes in a vehicle network that represent actuators. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalactuators */ readonly totalActuators?: number; /** * The total number of nodes in a vehicle network that represent attributes. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalattributes */ readonly totalAttributes?: number; /** * The total number of nodes in a vehicle network that represent branches. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalbranches */ readonly totalBranches?: number; /** * The total number of nodes in a vehicle network. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalnodes */ readonly totalNodes?: number; /** * The total number of nodes in a vehicle network that represent sensors. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalsensors */ readonly totalSensors?: number; } /** * A general abstraction of a signal. * * A node can be specified as an actuator, attribute, branch, or sensor. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html */ interface NodeProperty { /** * Information about a node specified as an actuator. * * > An actuator is a digital representation of a vehicle device. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html#cfn-iotfleetwise-signalcatalog-node-actuator */ readonly actuator?: CfnSignalCatalog.ActuatorProperty | cdk.IResolvable; /** * Information about a node specified as an attribute. * * > An attribute represents static information about a vehicle. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html#cfn-iotfleetwise-signalcatalog-node-attribute */ readonly attribute?: CfnSignalCatalog.AttributeProperty | cdk.IResolvable; /** * Information about a node specified as a branch. * * > A group of signals that are defined in a hierarchical structure. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html#cfn-iotfleetwise-signalcatalog-node-branch */ readonly branch?: CfnSignalCatalog.BranchProperty | cdk.IResolvable; /** * An input component that reports the environmental condition of a vehicle. * * > You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html#cfn-iotfleetwise-signalcatalog-node-sensor */ readonly sensor?: cdk.IResolvable | CfnSignalCatalog.SensorProperty; } /** * A signal that represents static information about the vehicle, such as engine type or manufacturing date. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html */ interface AttributeProperty { /** * A list of possible values an attribute can be assigned. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-allowedvalues */ readonly allowedValues?: Array; /** * A specified value for the attribute. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-assignedvalue */ readonly assignedValue?: string; /** * The specified data type of the attribute. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-datatype */ readonly dataType: string; /** * The default value of the attribute. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-defaultvalue */ readonly defaultValue?: string; /** * A brief description of the attribute. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-description */ readonly description?: string; /** * The fully qualified name of the attribute. * * For example, the fully qualified name of an attribute might be `Vehicle.Body.Engine.Type` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-fullyqualifiedname */ readonly fullyQualifiedName: string; /** * The specified possible maximum value of the attribute. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-max */ readonly max?: number; /** * The specified possible minimum value of the attribute. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-min */ readonly min?: number; /** * The scientific unit for the attribute. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-unit */ readonly unit?: string; } /** * A group of signals that are defined in a hierarchical structure. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html */ interface BranchProperty { /** * A brief description of the branch. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html#cfn-iotfleetwise-signalcatalog-branch-description */ readonly description?: string; /** * The fully qualified name of the branch. * * For example, the fully qualified name of a branch might be `Vehicle.Body.Engine` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html#cfn-iotfleetwise-signalcatalog-branch-fullyqualifiedname */ readonly fullyQualifiedName: string; } /** * An input component that reports the environmental condition of a vehicle. * * > You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html */ interface SensorProperty { /** * A list of possible values a sensor can take. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-allowedvalues */ readonly allowedValues?: Array; /** * The specified data type of the sensor. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-datatype */ readonly dataType: string; /** * A brief description of a sensor. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-description */ readonly description?: string; /** * The fully qualified name of the sensor. * * For example, the fully qualified name of a sensor might be `Vehicle.Body.Engine.Battery` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-fullyqualifiedname */ readonly fullyQualifiedName: string; /** * The specified possible maximum value of the sensor. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-max */ readonly max?: number; /** * The specified possible minimum value of the sensor. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-min */ readonly min?: number; /** * The scientific unit of measurement for data collected by the sensor. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-unit */ readonly unit?: string; } /** * A signal that represents a vehicle device such as the engine, heater, and door locks. * * Data from an actuator reports the state of a certain vehicle device. * * > Updating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html */ interface ActuatorProperty { /** * A list of possible values an actuator can take. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-allowedvalues */ readonly allowedValues?: Array; /** * A specified value for the actuator. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-assignedvalue */ readonly assignedValue?: string; /** * The specified data type of the actuator. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-datatype */ readonly dataType: string; /** * A brief description of the actuator. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-description */ readonly description?: string; /** * The fully qualified name of the actuator. * * For example, the fully qualified name of an actuator might be `Vehicle.Front.Left.Door.Lock` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-fullyqualifiedname */ readonly fullyQualifiedName: string; /** * The specified possible maximum value of an actuator. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-max */ readonly max?: number; /** * The specified possible minimum value of an actuator. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-min */ readonly min?: number; /** * The scientific unit for the actuator. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-unit */ readonly unit?: string; } } /** * Properties for defining a `CfnSignalCatalog` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html */ export interface CfnSignalCatalogProps { /** * A brief description of the signal catalog. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-description */ readonly description?: string; /** * The name of the signal catalog. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-name */ readonly name?: string; /** * Information about the number of nodes and node types in a vehicle network. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-nodecounts */ readonly nodeCounts?: cdk.IResolvable | CfnSignalCatalog.NodeCountsProperty; /** * A list of information about nodes, which are a general abstraction of signals. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-nodes */ readonly nodes?: Array | cdk.IResolvable; /** * Metadata that can be used to manage the signal catalog. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-tags */ readonly tags?: Array; } /** * Creates a vehicle, which is an instance of a vehicle model (model manifest). * * Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model. * * > If you have an existing AWS IoT thing, you can use AWS IoT FleetWise to create a vehicle and collect data from your thing. * * For more information, see [Vehicles](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/vehicles.html) in the *AWS IoT FleetWise Developer Guide* . * * @cloudformationResource AWS::IoTFleetWise::Vehicle * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html */ export declare class CfnVehicle extends cdk.CfnResource implements cdk.IInspectable, IVehicleRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnVehicle from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnVehicle; /** * Checks whether the given object is a CfnVehicle */ static isCfnVehicle(x: any): x is CfnVehicle; static arnForVehicle(resource: IVehicleRef): string; /** * An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle. */ associationBehavior?: string; /** * Static information about a vehicle in a key-value pair. */ attributes?: cdk.IResolvable | Record; /** * The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create. */ decoderManifestArn: string; /** * The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from. */ modelManifestArn: string; /** * The unique ID of the vehicle. */ name: string; /** * Associate state templates to track the state of the vehicle. */ stateTemplates?: Array | cdk.IResolvable; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Metadata which can be used to manage the vehicle. */ tagsRaw?: Array; /** * Create a new `AWS::IoTFleetWise::Vehicle`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnVehicleProps); get vehicleRef(): VehicleReference; /** * The Amazon Resource Name (ARN) of the vehicle. * * @cloudformationAttribute Arn */ get attrArn(): string; /** * The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time). * * @cloudformationAttribute CreationTime */ get attrCreationTime(): string; /** * The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). * * @cloudformationAttribute LastModificationTime */ get attrLastModificationTime(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnVehicle { /** * The state template associated with a vehicle. * * State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the AWS IoT FleetWise Edge and the AWS Cloud . * * > Access to certain AWS IoT FleetWise features is currently gated. For more information, see [AWS Region and feature availability](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateassociation.html */ interface StateTemplateAssociationProperty { /** * The unique ID of the state template. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateassociation.html#cfn-iotfleetwise-vehicle-statetemplateassociation-identifier */ readonly identifier: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateassociation.html#cfn-iotfleetwise-vehicle-statetemplateassociation-statetemplateupdatestrategy */ readonly stateTemplateUpdateStrategy: cdk.IResolvable | CfnVehicle.StateTemplateUpdateStrategyProperty; } /** * The update strategy for the state template. * * Vehicles associated with the state template can stream telemetry data with either an `onChange` or `periodic` update strategy. * * > Access to certain AWS IoT FleetWise features is currently gated. For more information, see [AWS Region and feature availability](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateupdatestrategy.html */ interface StateTemplateUpdateStrategyProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateupdatestrategy.html#cfn-iotfleetwise-vehicle-statetemplateupdatestrategy-onchange */ readonly onChange?: any | cdk.IResolvable; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateupdatestrategy.html#cfn-iotfleetwise-vehicle-statetemplateupdatestrategy-periodic */ readonly periodic?: cdk.IResolvable | CfnVehicle.PeriodicStateTemplateUpdateStrategyProperty; } /** * Vehicles associated with the state template will stream telemetry data during a specified time period. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-periodicstatetemplateupdatestrategy.html */ interface PeriodicStateTemplateUpdateStrategyProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-periodicstatetemplateupdatestrategy.html#cfn-iotfleetwise-vehicle-periodicstatetemplateupdatestrategy-statetemplateupdaterate */ readonly stateTemplateUpdateRate: cdk.IResolvable | CfnVehicle.TimePeriodProperty; } /** * The length of time between state template updates. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-timeperiod.html */ interface TimePeriodProperty { /** * A unit of time. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-timeperiod.html#cfn-iotfleetwise-vehicle-timeperiod-unit */ readonly unit: string; /** * A number of time units. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-timeperiod.html#cfn-iotfleetwise-vehicle-timeperiod-value */ readonly value: number; } } /** * Properties for defining a `CfnVehicle` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html */ export interface CfnVehicleProps { /** * An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-associationbehavior */ readonly associationBehavior?: string; /** * Static information about a vehicle in a key-value pair. * * For example: `"engine Type"` : `"v6"` * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-attributes */ readonly attributes?: cdk.IResolvable | Record; /** * The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-decodermanifestarn */ readonly decoderManifestArn: string; /** * The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-modelmanifestarn */ readonly modelManifestArn: string; /** * The unique ID of the vehicle. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-name */ readonly name: string; /** * Associate state templates to track the state of the vehicle. * * State templates determine which signal updates the vehicle sends to the cloud. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-statetemplates */ readonly stateTemplates?: Array | cdk.IResolvable; /** * Metadata which can be used to manage the vehicle. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-tags */ readonly tags?: Array; } /** * Creates a mechanism for vehicle owners to track the state of their vehicles. * * State templates determine which signal updates the vehicle sends to the cloud. * * For more information, see [State templates](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/state-templates.html) 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](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* . * * @cloudformationResource AWS::IoTFleetWise::StateTemplate * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html */ export declare class CfnStateTemplate extends cdk.CfnResource implements cdk.IInspectable, IStateTemplateRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnStateTemplate from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnStateTemplate; /** * Checks whether the given object is a CfnStateTemplate */ static isCfnStateTemplate(x: any): x is CfnStateTemplate; static arnForStateTemplate(resource: IStateTemplateRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * A list of vehicle attributes associated with the payload published on the state template's MQTT topic. */ dataExtraDimensions?: Array; /** * A brief description of the state template. */ description?: string; /** * A list of vehicle attributes to associate with the user properties of the messages published on the state template's MQTT topic. */ metadataExtraDimensions?: Array; /** * The unique alias of the state template. */ name: string; /** * The Amazon Resource Name (ARN) of the signal catalog associated with the state template. */ signalCatalogArn: string; /** * A list of signals from which data is collected. */ stateTemplateProperties: Array; /** * Metadata that can be used to manage the state template. */ tags?: Array; /** * Create a new `AWS::IoTFleetWise::StateTemplate`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnStateTemplateProps); get stateTemplateRef(): StateTemplateReference; /** * The Amazon Resource Name (ARN) of the state template. * * @cloudformationAttribute Arn */ get attrArn(): string; /** * The time the state template was created, in seconds since epoch (January 1, 1970 at midnight UTC time). * * @cloudformationAttribute CreationTime */ get attrCreationTime(): string; /** * The unique ID of the state template. * * @cloudformationAttribute Id */ get attrId(): string; /** * The time the state template was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time). * * @cloudformationAttribute LastModificationTime */ get attrLastModificationTime(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } /** * Properties for defining a `CfnStateTemplate` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html */ export interface CfnStateTemplateProps { /** * A list of vehicle attributes associated with the payload published on the state template's MQTT topic. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-dataextradimensions */ readonly dataExtraDimensions?: Array; /** * A brief description of the state template. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-description */ readonly description?: string; /** * A list of vehicle attributes to associate with the user properties of the messages published on the state template's MQTT topic. * * For example, if you add `Vehicle.Attributes.Make` and `Vehicle.Attributes.Model` attributes, these attributes are included as user properties with the MQTT message. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-metadataextradimensions */ readonly metadataExtraDimensions?: Array; /** * The unique alias of the state template. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-name */ readonly name: string; /** * The Amazon Resource Name (ARN) of the signal catalog associated with the state template. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-signalcatalogarn */ readonly signalCatalogArn: string; /** * A list of signals from which data is collected. * * The state template properties contain the fully qualified names of the signals. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-statetemplateproperties */ readonly stateTemplateProperties: Array; /** * Metadata that can be used to manage the state template. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-tags */ readonly tags?: Array; } export type { ICampaignRef, CampaignReference }; export type { IDecoderManifestRef, DecoderManifestReference }; export type { IFleetRef, FleetReference }; export type { IModelManifestRef, ModelManifestReference }; export type { ISignalCatalogRef, SignalCatalogReference }; export type { IVehicleRef, VehicleReference }; export type { IStateTemplateRef, StateTemplateReference };