Class: Aws::Firehose::Types::AmazonOpenSearchServerlessDestinationUpdate

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb

Overview

Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#buffering_hints ⇒ Types::AmazonOpenSearchServerlessBufferingHints

The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.

Returns:



220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 220

class AmazonOpenSearchServerlessDestinationUpdate < Struct.new(
  :role_arn,
  :collection_endpoint,
  :index_name,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your delivery stream.

Returns:



220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 220

class AmazonOpenSearchServerlessDestinationUpdate < Struct.new(
  :role_arn,
  :collection_endpoint,
  :index_name,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end

#collection_endpoint ⇒ String

The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

Returns:

  • (String) 


220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 220

class AmazonOpenSearchServerlessDestinationUpdate < Struct.new(
  :role_arn,
  :collection_endpoint,
  :index_name,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end

#index_name ⇒ String

The Serverless offering for Amazon OpenSearch Service index name.

Returns:

  • (String) 


220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 220

class AmazonOpenSearchServerlessDestinationUpdate < Struct.new(
  :role_arn,
  :collection_endpoint,
  :index_name,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end

#processing_configuration ⇒ Types::ProcessingConfiguration

Describes a data processing configuration.

Returns:



220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 220

class AmazonOpenSearchServerlessDestinationUpdate < Struct.new(
  :role_arn,
  :collection_endpoint,
  :index_name,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end

#retry_options ⇒ Types::AmazonOpenSearchServerlessRetryOptions

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

Returns:



220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 220

class AmazonOpenSearchServerlessDestinationUpdate < Struct.new(
  :role_arn,
  :collection_endpoint,
  :index_name,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

Returns:

  • (String) 


220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 220

class AmazonOpenSearchServerlessDestinationUpdate < Struct.new(
  :role_arn,
  :collection_endpoint,
  :index_name,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end

#s3_update ⇒ Types::S3DestinationUpdate

Describes an update for a destination in Amazon S3.

Returns:



220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 220

class AmazonOpenSearchServerlessDestinationUpdate < Struct.new(
  :role_arn,
  :collection_endpoint,
  :index_name,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end