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

Class: Aws::KinesisAnalytics::Types::AddApplicationReferenceDataSourceRequest

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 AddApplicationReferenceDataSourceRequest data as a hash:

{
  application_name: "ApplicationName", # required
  current_application_version_id: 1, # required
  reference_data_source: { # required
    table_name: "InAppTableName", # required
    s3_reference_data_source: {
      bucket_arn: "BucketARN", # required
      file_key: "FileKey", # required
      reference_role_arn: "RoleARN", # required
    },
    reference_schema: { # required
      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
        },
      ],
    },
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#application_nameString

Name of an existing application.

Returns:

  • (String)


297
298
299
300
301
302
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 297

class AddApplicationReferenceDataSourceRequest < Struct.new(
  :application_name,
  :current_application_version_id,
  :reference_data_source)
  include Aws::Structure
end

#current_application_version_idInteger

Version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

Returns:

  • (Integer)


297
298
299
300
301
302
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 297

class AddApplicationReferenceDataSourceRequest < Struct.new(
  :application_name,
  :current_application_version_id,
  :reference_data_source)
  include Aws::Structure
end

#reference_data_sourceTypes::ReferenceDataSource

The reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.



297
298
299
300
301
302
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 297

class AddApplicationReferenceDataSourceRequest < Struct.new(
  :application_name,
  :current_application_version_id,
  :reference_data_source)
  include Aws::Structure
end