AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::KinesisAnalyticsV2::Types::ReferenceDataSourceUpdate

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

Overview

Note:

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

{
  reference_id: "Id", # required
  table_name_update: "InAppTableName",
  s3_reference_data_source_update: {
    bucket_arn_update: "BucketARN",
    file_key_update: "FileKey",
  },
  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 a SQL-based Kinesis Data Analytics 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

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

Returns:

  • (String)

    The ID of the reference data source that is being updated.

#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:

  • (Types::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.

#s3_reference_data_source_updateTypes::S3ReferenceDataSourceUpdate

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

Returns:

  • (Types::S3ReferenceDataSourceUpdate)

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

#table_name_updateString

The in-application table name that is created by this update.

Returns:

  • (String)

    The in-application table name that is created by this update.