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

Class: Aws::Firehose::Types::ElasticsearchDestinationUpdate

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 ElasticsearchDestinationUpdate data as a hash:

{
  role_arn: "RoleARN",
  domain_arn: "ElasticsearchDomainARN",
  index_name: "ElasticsearchIndexName",
  type_name: "ElasticsearchTypeName",
  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_update: {
    role_arn: "RoleARN",
    bucket_arn: "BucketARN",
    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, RoleArn, BufferSizeInMBs, BufferIntervalInSeconds
            parameter_value: "ProcessorParameterValue", # required
          },
        ],
      },
    ],
  },
  cloud_watch_logging_options: {
    enabled: false,
    log_group_name: "LogGroupName",
    log_stream_name: "LogStreamName",
  },
}

Describes an update for a destination in Amazon ES.

Instance Attribute Summary collapse

Instance Attribute Details

#buffering_hintsTypes::ElasticsearchBufferingHints

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



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1026

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

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1026

class ElasticsearchDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :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 IAM role specified in RoleARN.

Returns:

  • (String)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1026

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

#index_nameString

The Elasticsearch index name.

Returns:

  • (String)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1026

class ElasticsearchDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :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 IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is OneDay.

Returns:

  • (String)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1026

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

#processing_configurationTypes::ProcessingConfiguration

The data processing configuration.



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1026

class ElasticsearchDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :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).



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1026

class ElasticsearchDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :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)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1026

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

#s3_updateTypes::S3DestinationUpdate

The Amazon S3 destination.



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1026

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

#type_nameString

The Elasticsearch type name.

Returns:

  • (String)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1026

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