Class: Aws::Firehose::Types::AmazonopensearchserviceDestinationConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::Firehose::Types::AmazonopensearchserviceDestinationConfiguration
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-firehose/types.rb
Overview
Describes the configuration of a destination in Amazon OpenSearch Service
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#buffering_hints ⇒ Types::AmazonopensearchserviceBufferingHints
The buffering options.
-
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
Describes the Amazon CloudWatch logging options for your delivery stream.
-
#cluster_endpoint ⇒ String
The endpoint to use when communicating with the cluster.
-
#document_id_options ⇒ Types::DocumentIdOptions
Indicates the method for setting up document ID.
-
#domain_arn ⇒ String
The ARN of the Amazon OpenSearch Service domain.
-
#index_name ⇒ String
The ElasticsearAmazon OpenSearch Service index name.
-
#index_rotation_period ⇒ String
The Amazon OpenSearch Service index rotation period.
-
#processing_configuration ⇒ Types::ProcessingConfiguration
Describes a data processing configuration.
-
#retry_options ⇒ Types::AmazonopensearchserviceRetryOptions
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
-
#s3_backup_mode ⇒ String
Defines how documents should be delivered to Amazon S3.
-
#s3_configuration ⇒ Types::S3DestinationConfiguration
Describes the configuration of a destination in Amazon S3.
-
#type_name ⇒ String
The Amazon OpenSearch Service type name.
-
#vpc_configuration ⇒ Types::VpcConfiguration
The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
Instance Attribute Details
#buffering_hints ⇒ Types::AmazonopensearchserviceBufferingHints
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/aws-sdk-firehose/types.rb', line 369 class AmazonopensearchserviceDestinationConfiguration < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_configuration, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
Describes the Amazon CloudWatch logging options for your delivery stream.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/aws-sdk-firehose/types.rb', line 369 class AmazonopensearchserviceDestinationConfiguration < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_configuration, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#cluster_endpoint ⇒ String
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/aws-sdk-firehose/types.rb', line 369 class AmazonopensearchserviceDestinationConfiguration < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_configuration, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#document_id_options ⇒ Types::DocumentIdOptions
Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/aws-sdk-firehose/types.rb', line 369 class AmazonopensearchserviceDestinationConfiguration < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_configuration, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#domain_arn ⇒ String
The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/aws-sdk-firehose/types.rb', line 369 class AmazonopensearchserviceDestinationConfiguration < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_configuration, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#index_name ⇒ String
The ElasticsearAmazon OpenSearch Service index name.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/aws-sdk-firehose/types.rb', line 369 class AmazonopensearchserviceDestinationConfiguration < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_configuration, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#index_rotation_period ⇒ String
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/aws-sdk-firehose/types.rb', line 369 class AmazonopensearchserviceDestinationConfiguration < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_configuration, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#processing_configuration ⇒ Types::ProcessingConfiguration
Describes a data processing configuration.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/aws-sdk-firehose/types.rb', line 369 class AmazonopensearchserviceDestinationConfiguration < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_configuration, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#retry_options ⇒ Types::AmazonopensearchserviceRetryOptions
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/aws-sdk-firehose/types.rb', line 369 class AmazonopensearchserviceDestinationConfiguration < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_configuration, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration, :document_id_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 Amazon OpenSearch Service Configuration API and for indexing documents.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/aws-sdk-firehose/types.rb', line 369 class AmazonopensearchserviceDestinationConfiguration < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_configuration, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#s3_backup_mode ⇒ String
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data 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, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/aws-sdk-firehose/types.rb', line 369 class AmazonopensearchserviceDestinationConfiguration < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_configuration, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#s3_configuration ⇒ Types::S3DestinationConfiguration
Describes the configuration of a destination in Amazon S3.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/aws-sdk-firehose/types.rb', line 369 class AmazonopensearchserviceDestinationConfiguration < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_configuration, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#type_name ⇒ String
The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/aws-sdk-firehose/types.rb', line 369 class AmazonopensearchserviceDestinationConfiguration < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_configuration, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#vpc_configuration ⇒ Types::VpcConfiguration
The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/aws-sdk-firehose/types.rb', line 369 class AmazonopensearchserviceDestinationConfiguration < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_configuration, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration, :document_id_options) SENSITIVE = [] include Aws::Structure end |