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

Class: Aws::KinesisAnalytics::Types::InputUpdate

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

{
  input_id: "Id", # required
  name_prefix_update: "InAppStreamName",
  kinesis_streams_input_update: {
    resource_arn_update: "ResourceARN",
    role_arn_update: "RoleARN",
  },
  kinesis_firehose_input_update: {
    resource_arn_update: "ResourceARN",
    role_arn_update: "RoleARN",
  },
  input_schema_update: {
    record_format_update: {
      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_update: "RecordEncoding",
    record_column_updates: [
      {
        name: "RecordColumnName", # required
        mapping: "RecordColumnMapping",
        sql_type: "RecordColumnSqlType", # required
      },
    ],
  },
  input_parallelism_update: {
    count_update: 1,
  },
}

Describes updates to a specific input configuration (identified by the InputId of an application).

Instance Attribute Summary collapse

Instance Attribute Details

#input_idString

Input ID of the application input to be updated.

Returns:

  • (String)


1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1489

class InputUpdate < Struct.new(
  :input_id,
  :name_prefix_update,
  :kinesis_streams_input_update,
  :kinesis_firehose_input_update,
  :input_schema_update,
  :input_parallelism_update)
  include Aws::Structure
end

#input_parallelism_updateTypes::InputParallelismUpdate

Describes the parallelism updates (the number in-application streams Amazon Kinesis Analytics creates for the specific streaming source).



1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1489

class InputUpdate < Struct.new(
  :input_id,
  :name_prefix_update,
  :kinesis_streams_input_update,
  :kinesis_firehose_input_update,
  :input_schema_update,
  :input_parallelism_update)
  include Aws::Structure
end

#input_schema_updateTypes::InputSchemaUpdate

Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.



1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1489

class InputUpdate < Struct.new(
  :input_id,
  :name_prefix_update,
  :kinesis_streams_input_update,
  :kinesis_firehose_input_update,
  :input_schema_update,
  :input_parallelism_update)
  include Aws::Structure
end

#kinesis_firehose_input_updateTypes::KinesisFirehoseInputUpdate

If an Amazon Kinesis Firehose delivery stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN) and IAM role ARN.



1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1489

class InputUpdate < Struct.new(
  :input_id,
  :name_prefix_update,
  :kinesis_streams_input_update,
  :kinesis_firehose_input_update,
  :input_schema_update,
  :input_parallelism_update)
  include Aws::Structure
end

#kinesis_streams_input_updateTypes::KinesisStreamsInputUpdate

If a Amazon Kinesis stream is the streaming source to be updated, provides an updated stream ARN and IAM role ARN.



1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1489

class InputUpdate < Struct.new(
  :input_id,
  :name_prefix_update,
  :kinesis_streams_input_update,
  :kinesis_firehose_input_update,
  :input_schema_update,
  :input_parallelism_update)
  include Aws::Structure
end

#name_prefix_updateString

Name prefix for in-application streams that Amazon Kinesis Analytics creates for the specific streaming source.

Returns:

  • (String)


1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1489

class InputUpdate < Struct.new(
  :input_id,
  :name_prefix_update,
  :kinesis_streams_input_update,
  :kinesis_firehose_input_update,
  :input_schema_update,
  :input_parallelism_update)
  include Aws::Structure
end