You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTAnalytics::Types::S3DestinationConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing S3DestinationConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  bucket: "BucketName", # required
  key: "BucketKeyExpression", # required
  glue_configuration: {
    table_name: "GlueTableName", # required
    database_name: "GlueDatabaseName", # required
  },
  role_arn: "RoleArn", # required
}

Configuration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3).

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The name of the S3 bucket to which dataset contents are delivered.

Returns:

  • (String) —

    The name of the S3 bucket to which dataset contents are delivered.

#glue_configuration ⇒ Types::GlueConfiguration

Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL) service.

Returns:

  • (Types::GlueConfiguration) —

    Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL) service.

#key ⇒ String

The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key.

You can create a unique key with the following options:

  • Use !`{iotanalytics:scheduleTime}` to insert the time of a scheduled SQL query run.

  • Use !`{iotanalytics:versionId}` to insert a unique hash that identifies a dataset content.

  • Use !`{iotanalytics:creationTime}` to insert the creation time of a dataset content.

The following example creates a unique key for a CSV file: dataset/mydataset/!`{iotanalytics:scheduleTime}/!{iotanalytics:versionId}`.csv

If you don\'t use !`{iotanalytics:versionId}` to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same scheduleTime but different versionIds. This means that one dataset content overwrites the other.

Returns:

  • (String) —

    The key of the dataset contents object in an S3 bucket.

#role_arn ⇒ String

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.

Returns:

  • (String) —

    The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.