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

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

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

Overview

The destination description in Amazon ES.

Instance Attribute Summary collapse

Instance Attribute Details

#buffering_hintsTypes::ElasticsearchBufferingHints

The buffering options.



1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1117

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

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The Amazon CloudWatch logging options.



1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1117

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

#domain_arnString

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

Returns:

  • (String)


1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1117

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

#index_nameString

The Elasticsearch index name.

Returns:

  • (String)


1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1117

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

#index_rotation_periodString

The Elasticsearch index rotation period

Returns:

  • (String)


1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1117

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

#processing_configurationTypes::ProcessingConfiguration

The data processing configuration.



1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1117

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

#retry_optionsTypes::ElasticsearchRetryOptions

The Amazon ES retry options.



1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1117

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

#role_arnString

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

Returns:

  • (String)


1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1117

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

#s3_backup_modeString

The Amazon S3 backup mode.

Returns:

  • (String)


1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1117

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

#s3_destination_descriptionTypes::S3DestinationDescription

The Amazon S3 destination.



1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1117

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

#type_nameString

The Elasticsearch type name.

Returns:

  • (String)


1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1117

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