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

Class: Aws::Firehose::Types::ElasticsearchDestinationDescription

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

The destination description in Amazon ES.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#buffering_hints ⇒ Types::ElasticsearchBufferingHints

The buffering options.

Returns:

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

The Amazon CloudWatch logging options.

Returns:

#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 ES.

Returns:

  • (String) —

    The endpoint to use when communicating with the cluster.

#domain_arn ⇒ String

The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.

Returns:

  • (String) —

    The ARN of the Amazon ES domain.

#index_name ⇒ String

The Elasticsearch index name.

Returns:

  • (String) —

    The Elasticsearch index name.

#index_rotation_period ⇒ String

The Elasticsearch index rotation period

Possible values:

  • NoRotation
  • OneHour
  • OneDay
  • OneWeek
  • OneMonth

Returns:

  • (String) —

    The Elasticsearch index rotation period.

#processing_configuration ⇒ Types::ProcessingConfiguration

The data processing configuration.

Returns:

#retry_options ⇒ Types::ElasticsearchRetryOptions

The Amazon ES retry options.

Returns:

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the AWS credentials.

#s3_backup_mode ⇒ String

The Amazon S3 backup mode.

Possible values:

  • FailedDocumentsOnly
  • AllDocuments

Returns:

  • (String) —

    The Amazon S3 backup mode.

#s3_destination_description ⇒ Types::S3DestinationDescription

The Amazon S3 destination.

Returns:

#type_name ⇒ String

The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x, there\'s no value for TypeName.

Returns:

  • (String) —

    The Elasticsearch type name.

#vpc_configuration_description ⇒ Types::VpcConfigurationDescription

The details of the VPC of the Amazon ES destination.

Returns: