Struct aws_sdk_iotfleetwise::types::builders::S3ConfigBuilder

#[non_exhaustive]
pub struct S3ConfigBuilder { /* private fields */ }

A builder for S3Config.

Implementations

impl S3ConfigBuilder

pub fn bucket_arn(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_bucket_arn(self, input: Option<String>) -> Self

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

pub fn get_bucket_arn(&self) -> &Option<String>

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

pub fn data_format(self, input: DataFormat) -> Self

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 set_data_format(self, input: Option<DataFormat>) -> Self

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 get_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, input: StorageCompressionFormat) -> Self

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 set_storage_compression_format( self, input: Option<StorageCompressionFormat> ) -> Self

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 get_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, input: impl Into<String>) -> Self

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

pub fn set_prefix(self, input: Option<String>) -> Self

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

pub fn get_prefix(&self) -> &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/.

pub fn build(self) -> Result<S3Config, BuildError>

Consumes the builder and constructs a S3Config. This method will fail if any of the following fields are not set:

• bucket_arn

Trait Implementations

impl Clone for S3ConfigBuilder

fn clone(&self) -> S3ConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for S3ConfigBuilder

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

Formats the value using the given formatter.

impl Default for S3ConfigBuilder

fn default() -> S3ConfigBuilder

Returns the “default value” for a type.

impl PartialEq for S3ConfigBuilder

fn eq(&self, other: &S3ConfigBuilder) -> 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 S3ConfigBuilder