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

Inherits:

Struct

• Object
• Struct
• Aws::Firehose::Types::ElasticsearchDestinationDescription

Includes:

Structure

Defined in:

lib/aws-sdk-firehose/types.rb

Overview

The destination description in Amazon ES.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #buffering_hints ⇒ Types::ElasticsearchBufferingHints

  The buffering options.

• #cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

  The Amazon CloudWatch logging options.

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

• #index_name ⇒ String

  The Elasticsearch index name.

• #index_rotation_period ⇒ String

  The Elasticsearch index rotation period.

• #processing_configuration ⇒ Types::ProcessingConfiguration

  The data processing configuration.

• #retry_options ⇒ Types::ElasticsearchRetryOptions

  The Amazon ES 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

  The Amazon S3 destination.

• #type_name ⇒ String

  The Elasticsearch type name.

• #vpc_configuration_description ⇒ Types::VpcConfigurationDescription

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

Instance Attribute Details

#buffering_hints ⇒ Types::ElasticsearchBufferingHints

The buffering options.

Returns:

• (Types::ElasticsearchBufferingHints)

# File 'lib/aws-sdk-firehose/types.rb', line 1567

class ElasticsearchDestinationDescription < 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

The Amazon CloudWatch logging options.

Returns:

• (Types::CloudWatchLoggingOptions)

# File 'lib/aws-sdk-firehose/types.rb', line 1567

class ElasticsearchDestinationDescription < 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 ES.

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 1567

class ElasticsearchDestinationDescription < 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.

Returns:

• (Types::DocumentIdOptions)

# File 'lib/aws-sdk-firehose/types.rb', line 1567

class ElasticsearchDestinationDescription < 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 ES domain. For more information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces].

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

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 1567

class ElasticsearchDestinationDescription < 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 Elasticsearch index name.

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 1567

class ElasticsearchDestinationDescription < 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 Elasticsearch index rotation period

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 1567

class ElasticsearchDestinationDescription < 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

The data processing configuration.

Returns:

• (Types::ProcessingConfiguration)

# File 'lib/aws-sdk-firehose/types.rb', line 1567

class ElasticsearchDestinationDescription < 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::ElasticsearchRetryOptions

The Amazon ES retry options.

Returns:

• (Types::ElasticsearchRetryOptions)

# File 'lib/aws-sdk-firehose/types.rb', line 1567

class ElasticsearchDestinationDescription < 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. For more information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces].

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 1567

class ElasticsearchDestinationDescription < 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.

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 1567

class ElasticsearchDestinationDescription < 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

The Amazon S3 destination.

Returns:

• (Types::S3DestinationDescription)

# File 'lib/aws-sdk-firehose/types.rb', line 1567

class ElasticsearchDestinationDescription < 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 Elasticsearch 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`.

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 1567

class ElasticsearchDestinationDescription < 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 OpenSearch or the Amazon OpenSearch Serverless destination.

Returns:

• (Types::VpcConfigurationDescription)

# File 'lib/aws-sdk-firehose/types.rb', line 1567

class ElasticsearchDestinationDescription < 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