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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb

Overview

Note:

When making an API call, you may pass S3DestinationConfiguration data as a 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).

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

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

Returns:

  • (String)


3669
3670
3671
3672
3673
3674
3675
3676
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 3669

class S3DestinationConfiguration < Struct.new(
  :bucket,
  :key,
  :glue_configuration,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#glue_configurationTypes::GlueConfiguration

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



3669
3670
3671
3672
3673
3674
3675
3676
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 3669

class S3DestinationConfiguration < Struct.new(
  :bucket,
  :key,
  :glue_configuration,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#keyString

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)


3669
3670
3671
3672
3673
3674
3675
3676
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 3669

class S3DestinationConfiguration < Struct.new(
  :bucket,
  :key,
  :glue_configuration,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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

Returns:

  • (String)


3669
3670
3671
3672
3673
3674
3675
3676
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 3669

class S3DestinationConfiguration < Struct.new(
  :bucket,
  :key,
  :glue_configuration,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end