Class: Aws::IoTFleetWise::Types::S3Config

Inherits:

Struct

• Object
• Struct
• Aws::IoTFleetWise::Types::S3Config

Includes:

Structure

Defined in:

lib/aws-sdk-iotfleetwise/types.rb

Overview

The Amazon S3 bucket where the Amazon Web Services 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][1

in the

*Amazon Simple Storage Service User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket_arn ⇒ String

  The Amazon Resource Name (ARN) of the Amazon S3 bucket.

• #data_format ⇒ String

  Specify the format that files are saved in the Amazon S3 bucket.

• #prefix ⇒ String

  Enter an S3 bucket prefix.

• #storage_compression_format ⇒ String

  By default, stored data is compressed as a .gzip file.

Instance Attribute Details

#bucket_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon S3 bucket.

Returns:

• (String)

# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3923

class S3Config < Struct.new(
  :bucket_arn,
  :data_format,
  :storage_compression_format,
  :prefix)
  SENSITIVE = []
  include Aws::Structure
end

#data_format ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3923

class S3Config < Struct.new(
  :bucket_arn,
  :data_format,
  :storage_compression_format,
  :prefix)
  SENSITIVE = []
  include Aws::Structure
end

#prefix ⇒ 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] in the *Amazon Simple Storage Service User Guide*.

By default, Amazon Web Services 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/`.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html

Returns:

• (String)

# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3923

class S3Config < Struct.new(
  :bucket_arn,
  :data_format,
  :storage_compression_format,
  :prefix)
  SENSITIVE = []
  include Aws::Structure
end

#storage_compression_format ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-iotfleetwise/types.rb', line 3923

class S3Config < Struct.new(
  :bucket_arn,
  :data_format,
  :storage_compression_format,
  :prefix)
  SENSITIVE = []
  include Aws::Structure
end