Class: Aws::Firehose::Types::ElasticsearchDestinationConfiguration

Inherits:

Struct

Object
Struct
Aws::Firehose::Types::ElasticsearchDestinationConfiguration

show all

Defined in:: gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb

Overview

Describes the configuration of a destination in Amazon ES.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#buffering_hints ⇒ Types::ElasticsearchBufferingHints
The buffering options.
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
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 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 retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents.
#s3_backup_mode ⇒ String
Defines how documents should be delivered to Amazon S3.
#s3_configuration ⇒ Types::S3DestinationConfiguration
The configuration for the backup Amazon S3 location.
#type_name ⇒ String
The Elasticsearch type name.
#vpc_configuration ⇒ Types::VpcConfiguration
The details of the VPC of the Amazon destination.

Instance Attribute Details

#buffering_hints ⇒ `Types::ElasticsearchBufferingHints`

The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

Returns:

(Types::ElasticsearchBufferingHints)

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

class ElasticsearchDestinationConfiguration < 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`

The Amazon CloudWatch logging options for your delivery stream.

Returns:

(Types::CloudWatchLoggingOptions)

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

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

Returns:

(String)

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

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

Returns:

(Types::DocumentIdOptions)

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

class ElasticsearchDestinationConfiguration < 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 ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

Returns:

(String)

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

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

Returns:

(String)

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

class ElasticsearchDestinationConfiguration < 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 Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.

Returns:

(String)

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

class ElasticsearchDestinationConfiguration < 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`

The data processing configuration.

Returns:

(Types::ProcessingConfiguration)

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

class ElasticsearchDestinationConfiguration < 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::ElasticsearchRetryOptions`

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

Returns:

(Types::ElasticsearchRetryOptions)

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

class ElasticsearchDestinationConfiguration < 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 ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Returns:

(String)

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

class ElasticsearchDestinationConfiguration < 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. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.

You can't change this backup mode after you create the delivery stream.

Returns:

(String)

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

class ElasticsearchDestinationConfiguration < 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`

The configuration for the backup Amazon S3 location.

Returns:

(Types::S3DestinationConfiguration)

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

class ElasticsearchDestinationConfiguration < 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 Elasticsearch 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.

For Elasticsearch 7.x, don't specify a TypeName.

Returns:

(String)

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

class ElasticsearchDestinationConfiguration < 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 destination.

Returns:

(Types::VpcConfiguration)

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

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

Class: Aws::Firehose::Types::ElasticsearchDestinationConfiguration

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#buffering_hints ⇒ Types::ElasticsearchBufferingHints

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

#cluster_endpoint ⇒ String

#document_id_options ⇒ Types::DocumentIdOptions

#domain_arn ⇒ String

#index_name ⇒ String

#index_rotation_period ⇒ String

#processing_configuration ⇒ Types::ProcessingConfiguration

#retry_options ⇒ Types::ElasticsearchRetryOptions

#role_arn ⇒ String

#s3_backup_mode ⇒ String

#s3_configuration ⇒ Types::S3DestinationConfiguration

#type_name ⇒ String

#vpc_configuration ⇒ Types::VpcConfiguration

#buffering_hints ⇒ `Types::ElasticsearchBufferingHints`

#cloud_watch_logging_options ⇒ `Types::CloudWatchLoggingOptions`

#cluster_endpoint ⇒ `String`

#document_id_options ⇒ `Types::DocumentIdOptions`

#domain_arn ⇒ `String`

#index_name ⇒ `String`

#index_rotation_period ⇒ `String`

#processing_configuration ⇒ `Types::ProcessingConfiguration`

#retry_options ⇒ `Types::ElasticsearchRetryOptions`

#role_arn ⇒ `String`

#s3_backup_mode ⇒ `String`

#s3_configuration ⇒ `Types::S3DestinationConfiguration`

#type_name ⇒ `String`

#vpc_configuration ⇒ `Types::VpcConfiguration`