Class: Aws::Firehose::Types::AmazonopensearchserviceDestinationDescription
- Inherits:
-
Struct
- Object
- Struct
- Aws::Firehose::Types::AmazonopensearchserviceDestinationDescription
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-firehose/types.rb
Overview
The destination description 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 Amazon 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 Amazon OpenSearch Service retry options.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
-
#s3_backup_mode ⇒ String
The Amazon S3 backup mode.
-
#s3_destination_description ⇒ Types::S3DestinationDescription
Describes a destination in Amazon S3.
-
#type_name ⇒ String
The Amazon OpenSearch Service type name.
-
#vpc_configuration_description ⇒ Types::VpcConfigurationDescription
The details of the VPC of the Amazon ES destination.
Instance Attribute Details
#buffering_hints ⇒ Types::AmazonopensearchserviceBufferingHints
The buffering options.
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/aws-sdk-firehose/types.rb', line 456 class AmazonopensearchserviceDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
Describes the Amazon CloudWatch logging options for your delivery stream.
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/aws-sdk-firehose/types.rb', line 456 class AmazonopensearchserviceDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#cluster_endpoint ⇒ String
The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/aws-sdk-firehose/types.rb', line 456 class AmazonopensearchserviceDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :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.
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/aws-sdk-firehose/types.rb', line 456 class AmazonopensearchserviceDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#domain_arn ⇒ String
The ARN of the Amazon OpenSearch Service domain.
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/aws-sdk-firehose/types.rb', line 456 class AmazonopensearchserviceDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#index_name ⇒ String
The Amazon OpenSearch Service index name.
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/aws-sdk-firehose/types.rb', line 456 class AmazonopensearchserviceDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#index_rotation_period ⇒ String
The Amazon OpenSearch Service index rotation period
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/aws-sdk-firehose/types.rb', line 456 class AmazonopensearchserviceDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#processing_configuration ⇒ Types::ProcessingConfiguration
Describes a data processing configuration.
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/aws-sdk-firehose/types.rb', line 456 class AmazonopensearchserviceDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#retry_options ⇒ Types::AmazonopensearchserviceRetryOptions
The Amazon OpenSearch Service retry options.
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/aws-sdk-firehose/types.rb', line 456 class AmazonopensearchserviceDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/aws-sdk-firehose/types.rb', line 456 class AmazonopensearchserviceDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#s3_backup_mode ⇒ String
The Amazon S3 backup mode.
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/aws-sdk-firehose/types.rb', line 456 class AmazonopensearchserviceDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#s3_destination_description ⇒ Types::S3DestinationDescription
Describes a destination in Amazon S3.
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/aws-sdk-firehose/types.rb', line 456 class AmazonopensearchserviceDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#type_name ⇒ String
The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there’s no value for TypeName.
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/aws-sdk-firehose/types.rb', line 456 class AmazonopensearchserviceDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#vpc_configuration_description ⇒ Types::VpcConfigurationDescription
The details of the VPC of the Amazon ES destination.
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/aws-sdk-firehose/types.rb', line 456 class AmazonopensearchserviceDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |