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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb

Overview

Note:

When making an API call, you may pass ElasticsearchDestinationConfiguration data as a hash:

{
  role_arn: "RoleARN", # required
  domain_arn: "ElasticsearchDomainARN", # required
  index_name: "ElasticsearchIndexName", # required
  type_name: "ElasticsearchTypeName", # required
  index_rotation_period: "NoRotation", # accepts NoRotation, OneHour, OneDay, OneWeek, OneMonth
  buffering_hints: {
    interval_in_seconds: 1,
    size_in_m_bs: 1,
  },
  retry_options: {
    duration_in_seconds: 1,
  },
  s3_backup_mode: "FailedDocumentsOnly", # accepts FailedDocumentsOnly, AllDocuments
  s3_configuration: { # required
    role_arn: "RoleARN", # required
    bucket_arn: "BucketARN", # required
    prefix: "Prefix",
    buffering_hints: {
      size_in_m_bs: 1,
      interval_in_seconds: 1,
    },
    compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
    encryption_configuration: {
      no_encryption_config: "NoEncryption", # accepts NoEncryption
      kms_encryption_config: {
        awskms_key_arn: "AWSKMSKeyARN", # required
      },
    },
    cloud_watch_logging_options: {
      enabled: false,
      log_group_name: "LogGroupName",
      log_stream_name: "LogStreamName",
    },
  },
  processing_configuration: {
    enabled: false,
    processors: [
      {
        type: "Lambda", # required, accepts Lambda
        parameters: [
          {
            parameter_name: "LambdaArn", # required, accepts LambdaArn, NumberOfRetries
            parameter_value: "ProcessorParameterValue", # required
          },
        ],
      },
    ],
  },
  cloud_watch_logging_options: {
    enabled: false,
    log_group_name: "LogGroupName",
    log_stream_name: "LogStreamName",
  },
}

Describes the configuration of a destination in Amazon ES.

Instance Attribute Summary collapse

Instance Attribute Details

#buffering_hintsTypes::ElasticsearchBufferingHints

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



768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 768

class ElasticsearchDestinationConfiguration < Struct.new(
  :role_arn,
  :domain_arn,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :processing_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.



768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 768

class ElasticsearchDestinationConfiguration < Struct.new(
  :role_arn,
  :domain_arn,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :processing_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#domain_arnString

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.

Returns:

  • (String)


768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 768

class ElasticsearchDestinationConfiguration < Struct.new(
  :role_arn,
  :domain_arn,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :processing_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#index_nameString

The Elasticsearch index name.

Returns:

  • (String)


768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 768

class ElasticsearchDestinationConfiguration < Struct.new(
  :role_arn,
  :domain_arn,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :processing_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#index_rotation_periodString

The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. The default value is OneDay.

Returns:

  • (String)


768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 768

class ElasticsearchDestinationConfiguration < Struct.new(
  :role_arn,
  :domain_arn,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :processing_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#processing_configurationTypes::ProcessingConfiguration

The data processing configuration.



768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 768

class ElasticsearchDestinationConfiguration < Struct.new(
  :role_arn,
  :domain_arn,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :processing_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#retry_optionsTypes::ElasticsearchRetryOptions

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



768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 768

class ElasticsearchDestinationConfiguration < Struct.new(
  :role_arn,
  :domain_arn,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :processing_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#role_arnString

The ARN of the IAM role to be assumed by Kinesis Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access.

Returns:

  • (String)


768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 768

class ElasticsearchDestinationConfiguration < Struct.new(
  :role_arn,
  :domain_arn,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :processing_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#s3_backup_modeString

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.

Returns:

  • (String)


768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 768

class ElasticsearchDestinationConfiguration < Struct.new(
  :role_arn,
  :domain_arn,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :processing_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#s3_configurationTypes::S3DestinationConfiguration

The configuration for the backup Amazon S3 location.



768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 768

class ElasticsearchDestinationConfiguration < Struct.new(
  :role_arn,
  :domain_arn,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :processing_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end

#type_nameString

The Elasticsearch type name.

Returns:

  • (String)


768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 768

class ElasticsearchDestinationConfiguration < Struct.new(
  :role_arn,
  :domain_arn,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :processing_configuration,
  :cloud_watch_logging_options)
  include Aws::Structure
end