Class CfnCampaignPropsMixin.S3ConfigProperty

The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.

Inheritance

object

CfnCampaignPropsMixin.S3ConfigProperty

Implements

CfnCampaignPropsMixin.IS3ConfigProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.IoTFleetWise.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnCampaignPropsMixin.S3ConfigProperty : CfnCampaignPropsMixin.IS3ConfigProperty

Syntax (vb)

Public Class CfnCampaignPropsMixin.S3ConfigProperty Implements CfnCampaignPropsMixin.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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html

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.Mixins.Preview.AWS.IoTFleetWise.Mixins;

             var s3ConfigProperty = new S3ConfigProperty {
                 BucketArn = "bucketArn",
                 DataFormat = "dataFormat",
                 Prefix = "prefix",
                 StorageCompressionFormat = "storageCompressionFormat"
             };

Synopsis

Constructors

S3ConfigProperty()

The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.

Properties

BucketArn	The Amazon Resource Name (ARN) of the Amazon S3 bucket.
DataFormat	Specify the format that files are saved in the Amazon S3 bucket.
Prefix	Enter an S3 bucket prefix.
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.

Constructors

S3ConfigProperty()

The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.

public S3ConfigProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html

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.Mixins.Preview.AWS.IoTFleetWise.Mixins;

             var s3ConfigProperty = new S3ConfigProperty {
                 BucketArn = "bucketArn",
                 DataFormat = "dataFormat",
                 Prefix = "prefix",
                 StorageCompressionFormat = "storageCompressionFormat"
             };

Properties

BucketArn

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

public string? BucketArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html#cfn-iotfleetwise-campaign-s3config-bucketarn

DataFormat

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

public string? DataFormat { get; set; }

Property Value

string

Remarks

You can save files in an Apache Parquet or JSON format.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html#cfn-iotfleetwise-campaign-s3config-dataformat

Prefix

Enter an S3 bucket prefix.

public string? Prefix { get; set; }

Property Value

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html#cfn-iotfleetwise-campaign-s3config-prefix

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.

public string? StorageCompressionFormat { get; set; }