Class: Aws::Firehose::Types::AmazonOpenSearchServerlessDestinationConfiguration

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

Overview

Describes the configuration of 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, the default values for AmazonopensearchserviceBufferingHints are used.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 100

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

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your Firehose stream.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 100

class AmazonOpenSearchServerlessDestinationConfiguration < Struct.new(
  :role_arn,
  :collection_endpoint,
  :index_name,
  :buffering_hints,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :processing_configuration,
  :cloud_watch_logging_options,
  :vpc_configuration)
  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) 


100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 100

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

#index_name ⇒ String

The Serverless offering for Amazon OpenSearch Service index name.

Returns:

  • (String) 


100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 100

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

#processing_configuration ⇒ Types::ProcessingConfiguration

Describes a data processing configuration.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 100

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

#retry_options ⇒ Types::AmazonOpenSearchServerlessRetryOptions

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

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 100

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

#role_arn ⇒ String

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

Returns:

  • (String) 


100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 100

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

#s3_backup_mode ⇒ String

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.

Returns:

  • (String) 


100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 100

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

#s3_configuration ⇒ Types::S3DestinationConfiguration

Describes the configuration of a destination in Amazon S3.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 100

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

#vpc_configuration ⇒ Types::VpcConfiguration

The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 100

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