Struct aws_sdk_iotfleetwise::types::S3Config

#[non_exhaustive]
pub struct S3Config {
    pub bucket_arn: String,
    pub data_format: Option<DataFormat>,
    pub storage_compression_format: Option<StorageCompressionFormat>,
    pub prefix: Option<String>,
}

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 in the Amazon Simple Storage Service User Guide.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bucket_arn: String

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

data_format: Option<DataFormat>

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.

storage_compression_format: Option<StorageCompressionFormat>

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.

prefix: Option<String>

(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, 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/.

Implementations

impl S3Config

pub fn bucket_arn(&self) -> &str

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

pub fn data_format(&self) -> Option<&DataFormat>

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.

pub fn storage_compression_format(&self) -> Option<&StorageCompressionFormat>

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.

pub fn prefix(&self) -> Option<&str>

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

By default, 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/.

impl S3Config

pub fn builder() -> S3ConfigBuilder

Creates a new builder-style object to manufacture S3Config.

Trait Implementations

impl Clone for S3Config

fn clone(&self) -> S3Config

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for S3Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for S3Config

fn eq(&self, other: &S3Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for S3Config