Class CfnCampaign.S3ConfigProperty.Builder
java.lang.Object
software.amazon.awscdk.services.iotfleetwise.CfnCampaign.S3ConfigProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCampaign.S3ConfigProperty>
- Enclosing interface:
CfnCampaign.S3ConfigProperty
@Stability(Stable)
public static final class CfnCampaign.S3ConfigProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCampaign.S3ConfigProperty>
A builder for
CfnCampaign.S3ConfigProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionSets the value ofCfnCampaign.S3ConfigProperty.getBucketArn()
build()
Builds the configured instance.dataFormat
(String dataFormat) Sets the value ofCfnCampaign.S3ConfigProperty.getDataFormat()
Sets the value ofCfnCampaign.S3ConfigProperty.getPrefix()
storageCompressionFormat
(String storageCompressionFormat) Sets the value ofCfnCampaign.S3ConfigProperty.getStorageCompressionFormat()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
bucketArn
Sets the value ofCfnCampaign.S3ConfigProperty.getBucketArn()
- Parameters:
bucketArn
- The Amazon Resource Name (ARN) of the Amazon S3 bucket. This parameter is required.- Returns:
this
-
dataFormat
Sets the value ofCfnCampaign.S3ConfigProperty.getDataFormat()
- Parameters:
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.
- Returns:
this
-
prefix
Sets the value ofCfnCampaign.S3ConfigProperty.getPrefix()
- Parameters:
prefix
- 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 prefixvehicles
, the prefix will bevehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/
.- Returns:
this
-
storageCompressionFormat
@Stability(Stable) public CfnCampaign.S3ConfigProperty.Builder storageCompressionFormat(String storageCompressionFormat) Sets the value ofCfnCampaign.S3ConfigProperty.getStorageCompressionFormat()
- Parameters:
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.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnCampaign.S3ConfigProperty>
- Returns:
- a new instance of
CfnCampaign.S3ConfigProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-