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

Class: Aws::KinesisAnalytics::Types::OutputUpdate

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

{
  output_id: "Id", # required
  name_update: "InAppStreamName",
  kinesis_streams_output_update: {
    resource_arn_update: "ResourceARN",
    role_arn_update: "RoleARN",
  },
  kinesis_firehose_output_update: {
    resource_arn_update: "ResourceARN",
    role_arn_update: "RoleARN",
  },
  destination_schema_update: {
    record_format_type: "JSON", # accepts JSON, CSV
  },
}

Describes updates to the output configuration identified by the OutputId.

Instance Attribute Summary collapse

Instance Attribute Details

#destination_schema_updateTypes::DestinationSchema

Describes the data format when records are written to the destination. For more information, see Configuring Application Output.



2087
2088
2089
2090
2091
2092
2093
2094
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2087

class OutputUpdate < Struct.new(
  :output_id,
  :name_update,
  :kinesis_streams_output_update,
  :kinesis_firehose_output_update,
  :destination_schema_update)
  include Aws::Structure
end

#kinesis_firehose_output_updateTypes::KinesisFirehoseOutputUpdate

Describes a Amazon Kinesis Firehose delivery stream as the destination for the output.



2087
2088
2089
2090
2091
2092
2093
2094
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2087

class OutputUpdate < Struct.new(
  :output_id,
  :name_update,
  :kinesis_streams_output_update,
  :kinesis_firehose_output_update,
  :destination_schema_update)
  include Aws::Structure
end

#kinesis_streams_output_updateTypes::KinesisStreamsOutputUpdate

Describes an Amazon Kinesis stream as the destination for the output.



2087
2088
2089
2090
2091
2092
2093
2094
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2087

class OutputUpdate < Struct.new(
  :output_id,
  :name_update,
  :kinesis_streams_output_update,
  :kinesis_firehose_output_update,
  :destination_schema_update)
  include Aws::Structure
end

#name_updateString

If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name.

Returns:

  • (String)


2087
2088
2089
2090
2091
2092
2093
2094
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2087

class OutputUpdate < Struct.new(
  :output_id,
  :name_update,
  :kinesis_streams_output_update,
  :kinesis_firehose_output_update,
  :destination_schema_update)
  include Aws::Structure
end

#output_idString

Identifies the specific output configuration that you want to update.

Returns:

  • (String)


2087
2088
2089
2090
2091
2092
2093
2094
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2087

class OutputUpdate < Struct.new(
  :output_id,
  :name_update,
  :kinesis_streams_output_update,
  :kinesis_firehose_output_update,
  :destination_schema_update)
  include Aws::Structure
end