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

Class: Aws::KinesisAnalytics::Types::ReferenceDataSourceUpdate

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

Overview

Note:

When making an API call, you may pass ReferenceDataSourceUpdate data as a hash:

{
  reference_id: "Id", # required
  table_name_update: "InAppTableName",
  s3_reference_data_source_update: {
    bucket_arn_update: "BucketARN",
    file_key_update: "FileKey",
    reference_role_arn_update: "RoleARN",
  },
  reference_schema_update: {
    record_format: { # required
      record_format_type: "JSON", # required, accepts JSON, CSV
      mapping_parameters: {
        json_mapping_parameters: {
          record_row_path: "RecordRowPath", # required
        },
        csv_mapping_parameters: {
          record_row_delimiter: "RecordRowDelimiter", # required
          record_column_delimiter: "RecordColumnDelimiter", # required
        },
      },
    },
    record_encoding: "RecordEncoding",
    record_columns: [ # required
      {
        name: "RecordColumnName", # required
        mapping: "RecordColumnMapping",
        sql_type: "RecordColumnSqlType", # required
      },
    ],
  },
}

When you update a reference data source configuration for an application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.

Instance Attribute Summary collapse

Instance Attribute Details

#reference_idString

ID of the reference data source being updated. You can use the DescribeApplication operation to get this value.

Returns:

  • (String)


2342
2343
2344
2345
2346
2347
2348
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2342

class ReferenceDataSourceUpdate < Struct.new(
  :reference_id,
  :table_name_update,
  :s3_reference_data_source_update,
  :reference_schema_update)
  include Aws::Structure
end

#reference_schema_updateTypes::SourceSchema

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

Returns:



2342
2343
2344
2345
2346
2347
2348
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2342

class ReferenceDataSourceUpdate < Struct.new(
  :reference_id,
  :table_name_update,
  :s3_reference_data_source_update,
  :reference_schema_update)
  include Aws::Structure
end

#s3_reference_data_source_updateTypes::S3ReferenceDataSourceUpdate

Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.



2342
2343
2344
2345
2346
2347
2348
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2342

class ReferenceDataSourceUpdate < Struct.new(
  :reference_id,
  :table_name_update,
  :s3_reference_data_source_update,
  :reference_schema_update)
  include Aws::Structure
end

#table_name_updateString

In-application table name that is created by this update.

Returns:

  • (String)


2342
2343
2344
2345
2346
2347
2348
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2342

class ReferenceDataSourceUpdate < Struct.new(
  :reference_id,
  :table_name_update,
  :s3_reference_data_source_update,
  :reference_schema_update)
  include Aws::Structure
end