Class: Aws::Firehose::Types::ElasticsearchDestinationConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::Firehose::Types::ElasticsearchDestinationConfiguration
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-firehose/types.rb
Overview
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",
error_output_prefix: "ErrorOutputPrefix",
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 the configuration of a destination in Amazon ES.
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.
-
#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.
Instance Attribute Details
#buffering_hints ⇒ Types::ElasticsearchBufferingHints
The buffering options. If no value is specified, the default values for ‘ElasticsearchBufferingHints` are used.
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 |
# File 'lib/aws-sdk-firehose/types.rb', line 1095 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_options ⇒ Types::CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 |
# File 'lib/aws-sdk-firehose/types.rb', line 1095 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_arn ⇒ String
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. For more information, see [Amazon Resource Names (ARNs) and AWS Service Namespaces].
[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 |
# File 'lib/aws-sdk-firehose/types.rb', line 1095 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_name ⇒ String
The Elasticsearch index name.
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 |
# File 'lib/aws-sdk-firehose/types.rb', line 1095 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_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`.
[1]: docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 |
# File 'lib/aws-sdk-firehose/types.rb', line 1095 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_configuration ⇒ Types::ProcessingConfiguration
The data processing configuration.
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 |
# File 'lib/aws-sdk-firehose/types.rb', line 1095 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_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).
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 |
# File 'lib/aws-sdk-firehose/types.rb', line 1095 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_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 AWS Service Namespaces].
[1]: docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3 [2]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 |
# File 'lib/aws-sdk-firehose/types.rb', line 1095 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_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 `elasticsearch-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 `elasticsearch-failed/` appended to the prefix. For more information, see [Amazon S3 Backup for the Amazon ES Destination]. Default value is `FailedDocumentsOnly`.
[1]: docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 |
# File 'lib/aws-sdk-firehose/types.rb', line 1095 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_configuration ⇒ Types::S3DestinationConfiguration
The configuration for the backup Amazon S3 location.
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 |
# File 'lib/aws-sdk-firehose/types.rb', line 1095 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_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.
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 |
# File 'lib/aws-sdk-firehose/types.rb', line 1095 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 |