Class: AWSCDK::IoTFleetWise::CfnCampaign::S3ConfigProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::IoTFleetWise::CfnCampaign::S3ConfigProperty

Defined in:

io_t_fleet_wise/cfn_campaign.rb

Overview

The Amazon S3 bucket where the AWS 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 .

See Also:

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

Instance Attribute Summary

• #bucket_arn ⇒ String readonly

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

• #data_format ⇒ String^? readonly

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

• #prefix ⇒ String^? readonly

  Enter an S3 bucket prefix.

• #storage_compression_format ⇒ String^? readonly

  By default, stored data is compressed as a .gzip file.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(bucket_arn:, data_format: nil, prefix: nil, storage_compression_format: nil) ⇒ S3ConfigProperty constructor

  A new instance of S3ConfigProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(bucket_arn:, data_format: nil, prefix: nil, storage_compression_format: nil) ⇒ S3ConfigProperty

Returns a new instance of S3ConfigProperty.

Parameters:

• bucket_arn (String) —

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

• data_format (String, nil) (defaults to: nil) —

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

• prefix (String, nil) (defaults to: nil) —

  Enter an S3 bucket prefix.

• storage_compression_format (String, nil) (defaults to: nil) —

  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.

# File 'io_t_fleet_wise/cfn_campaign.rb', line 1247

def initialize(bucket_arn:, data_format: nil, prefix: nil, storage_compression_format: nil)
  @bucket_arn = bucket_arn
  Jsii::Type.check_type(@bucket_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketArn")
  @data_format = data_format
  Jsii::Type.check_type(@data_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataFormat") unless @data_format.nil?
  @prefix = prefix
  Jsii::Type.check_type(@prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefix") unless @prefix.nil?
  @storage_compression_format = storage_compression_format
  Jsii::Type.check_type(@storage_compression_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "storageCompressionFormat") unless @storage_compression_format.nil?
end

Instance Attribute Details

#bucket_arn ⇒ String (readonly)

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

Returns:

• (String)

See Also:

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

# File 'io_t_fleet_wise/cfn_campaign.rb', line 1262

def bucket_arn
  @bucket_arn
end

#data_format ⇒ String^? (readonly)

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:

• (String, nil)

See Also:

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

# File 'io_t_fleet_wise/cfn_campaign.rb', line 1272

def data_format
  @data_format
end

#prefix ⇒ String^? (readonly)

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 prefix vehicles , the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/ .

Returns:

• (String, nil)

See Also:

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

# File 'io_t_fleet_wise/cfn_campaign.rb', line 1281

def prefix
  @prefix
end

#storage_compression_format ⇒ String^? (readonly)

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:

• (String, nil)

See Also:

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

# File 'io_t_fleet_wise/cfn_campaign.rb', line 1286

def storage_compression_format
  @storage_compression_format
end

Class Method Details

.jsii_properties ⇒ Object

# File 'io_t_fleet_wise/cfn_campaign.rb', line 1288

def self.jsii_properties
  {
    :bucket_arn => "bucketArn",
    :data_format => "dataFormat",
    :prefix => "prefix",
    :storage_compression_format => "storageCompressionFormat",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'io_t_fleet_wise/cfn_campaign.rb', line 1297

def to_jsii
  result = {}
  result.merge!({
    "bucketArn" => @bucket_arn,
    "dataFormat" => @data_format,
    "prefix" => @prefix,
    "storageCompressionFormat" => @storage_compression_format,
  })
  result.compact
end