Package software.amazon.awscdk.services.iotfleetwise

Interface CfnCampaign.S3ConfigProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnCampaign.S3ConfigProperty.Jsii$Proxy
Enclosing class:
CfnCampaign
@Stability(Stable) public static interface CfnCampaign.S3ConfigProperty extends software.amazon.jsii.JsiiSerializable
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 in the Amazon Simple Storage Service User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotfleetwise.*;
 S3ConfigProperty s3ConfigProperty = S3ConfigProperty.builder()
         .bucketArn("bucketArn")
         // the properties below are optional
         .dataFormat("dataFormat")
         .prefix("prefix")
         .storageCompressionFormat("storageCompressionFormat")
         .build();

  • Method Details

    • getBucketArn

      @Stability(Stable) @NotNull String getBucketArn()
      The Amazon Resource Name (ARN) of the Amazon S3 bucket.

    • getDataFormat

      @Stability(Stable) @Nullable default String getDataFormat()
      (Optional) Specify the format that files are saved in the Amazon S3 bucket.

      You can save files in an Apache Parquet or JSON format.

      • Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.
      • JSON - Store data in a standard text-based JSON file format.

    • getPrefix

      @Stability(Stable) @Nullable default String getPrefix()
      (Optional) Enter an S3 bucket prefix.

      The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide .

      By default, AWS IoT FleetWise sets the prefix processed-data/year=YY/month=MM/date=DD/hour=HH/ (in UTC) to data it delivers to Amazon S3 . You can enter a prefix to append it to this default prefix. For example, if you enter the prefix vehicles , the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/ .

    • getStorageCompressionFormat

      @Stability(Stable) @Nullable default String getStorageCompressionFormat()
      (Optional) By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.

    • builder

      @Stability(Stable) static CfnCampaign.S3ConfigProperty.Builder builder()
      Returns:
      a CfnCampaign.S3ConfigProperty.Builder of CfnCampaign.S3ConfigProperty