Class CfnCampaign.S3ConfigProperty
The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.IoTFleetWise
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class S3ConfigProperty : Object, CfnCampaign.IS3ConfigProperty
Syntax (vb)
Public Class S3ConfigProperty
Inherits Object
Implements CfnCampaign.IS3ConfigProperty
Remarks
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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTFleetWise;
var s3ConfigProperty = new S3ConfigProperty {
BucketArn = "bucketArn",
// the properties below are optional
DataFormat = "dataFormat",
Prefix = "prefix",
StorageCompressionFormat = "storageCompressionFormat"
};
Synopsis
Constructors
S3ConfigProperty() |
Properties
BucketArn | The Amazon Resource Name (ARN) of the Amazon S3 bucket. |
DataFormat | (Optional) Specify the format that files are saved in the Amazon S3 bucket. |
Prefix | (Optional) Enter an S3 bucket prefix. |
StorageCompressionFormat | (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. |
Constructors
S3ConfigProperty()
public S3ConfigProperty()
Properties
BucketArn
The Amazon Resource Name (ARN) of the Amazon S3 bucket.
public string BucketArn { get; set; }
Property Value
System.String
Remarks
DataFormat
(Optional) Specify the format that files are saved in the Amazon S3 bucket.
public string DataFormat { get; set; }
Property Value
System.String
Remarks
You can save files in an Apache Parquet or JSON format.
Prefix
(Optional) Enter an S3 bucket prefix.
public string Prefix { get; set; }
Property Value
System.String
Remarks
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/
.
StorageCompressionFormat
(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.
public string StorageCompressionFormat { get; set; }
Property Value
System.String