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

Class: Aws::KinesisAnalytics::Types::Output

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

{
  name: "InAppStreamName", # required
  kinesis_streams_output: {
    resource_arn: "ResourceARN", # required
    role_arn: "RoleARN", # required
  },
  kinesis_firehose_output: {
    resource_arn: "ResourceARN", # required
    role_arn: "RoleARN", # required
  },
  lambda_output: {
    resource_arn: "ResourceARN", # required
    role_arn: "RoleARN", # required
  },
  destination_schema: { # required
    record_format_type: "JSON", # required, accepts JSON, CSV
  },
}

Describes application output configuration in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream.

For limits on how many destinations an application can write and other limitations, see Limits.

Instance Attribute Summary collapse

Instance Attribute Details

#destination_schemaTypes::DestinationSchema

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



2695
2696
2697
2698
2699
2700
2701
2702
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2695

class Output < Struct.new(
  :name,
  :kinesis_streams_output,
  :kinesis_firehose_output,
  :lambda_output,
  :destination_schema)
  include Aws::Structure
end

#kinesis_firehose_outputTypes::KinesisFirehoseOutput

Identifies an Amazon Kinesis Firehose delivery stream as the destination.



2695
2696
2697
2698
2699
2700
2701
2702
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2695

class Output < Struct.new(
  :name,
  :kinesis_streams_output,
  :kinesis_firehose_output,
  :lambda_output,
  :destination_schema)
  include Aws::Structure
end

#kinesis_streams_outputTypes::KinesisStreamsOutput

Identifies an Amazon Kinesis stream as the destination.



2695
2696
2697
2698
2699
2700
2701
2702
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2695

class Output < Struct.new(
  :name,
  :kinesis_streams_output,
  :kinesis_firehose_output,
  :lambda_output,
  :destination_schema)
  include Aws::Structure
end

#lambda_outputTypes::LambdaOutput

Identifies an AWS Lambda function as the destination.

Returns:



2695
2696
2697
2698
2699
2700
2701
2702
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2695

class Output < Struct.new(
  :name,
  :kinesis_streams_output,
  :kinesis_firehose_output,
  :lambda_output,
  :destination_schema)
  include Aws::Structure
end

#nameString

Name of the in-application stream.

Returns:

  • (String)


2695
2696
2697
2698
2699
2700
2701
2702
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2695

class Output < Struct.new(
  :name,
  :kinesis_streams_output,
  :kinesis_firehose_output,
  :lambda_output,
  :destination_schema)
  include Aws::Structure
end