Class: Aws::Firehose::Types::ElasticsearchDestinationUpdate
- Inherits:
-
Struct
- Object
- Struct
- Aws::Firehose::Types::ElasticsearchDestinationUpdate
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-firehose/types.rb
Overview
When making an API call, you may pass ElasticsearchDestinationUpdate data as a hash:
{
role_arn: "RoleARN",
domain_arn: "ElasticsearchDomainARN",
cluster_endpoint: "ElasticsearchClusterEndpoint",
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",
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 an update for a destination in Amazon ES.
Instance Attribute Summary collapse
-
#buffering_hints ⇒ Types::ElasticsearchBufferingHints
The buffering options.
-
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
The CloudWatch logging options for your delivery stream.
-
#cluster_endpoint ⇒ String
The endpoint to use when communicating with the cluster.
-
#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_update ⇒ Types::S3DestinationUpdate
The Amazon S3 destination.
-
#type_name ⇒ String
The Elasticsearch type name.
Instance Attribute Details
#buffering_hints ⇒ Types::ElasticsearchBufferingHints
The buffering options. If no value is specified, ‘ElasticsearchBufferingHints` object default values are used.
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 |
# File 'lib/aws-sdk-firehose/types.rb', line 1365 class ElasticsearchDestinationUpdate < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :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_options ⇒ Types::CloudWatchLoggingOptions
The CloudWatch logging options for your delivery stream.
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 |
# File 'lib/aws-sdk-firehose/types.rb', line 1365 class ElasticsearchDestinationUpdate < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_update, :processing_configuration, :cloud_watch_logging_options) include Aws::Structure end |
#cluster_endpoint ⇒ String
The endpoint to use when communicating with the cluster. Specify either this ‘ClusterEndpoint` or the `DomainARN` field.
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 |
# File 'lib/aws-sdk-firehose/types.rb', line 1365 class ElasticsearchDestinationUpdate < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_update, :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 IAM role specified in `RoleARN`. For more information, see [Amazon Resource Names (ARNs) and AWS Service Namespaces].
Specify either ‘ClusterEndpoint` or `DomainARN`.
[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 |
# File 'lib/aws-sdk-firehose/types.rb', line 1365 class ElasticsearchDestinationUpdate < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_update, :processing_configuration, :cloud_watch_logging_options) include Aws::Structure end |
#index_name ⇒ String
The Elasticsearch index name.
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 |
# File 'lib/aws-sdk-firehose/types.rb', line 1365 class ElasticsearchDestinationUpdate < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :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_period ⇒ String
The Elasticsearch index rotation period. Index rotation appends a timestamp to ‘IndexName` to facilitate the expiration of old data. For more information, see [Index Rotation for the Amazon ES Destination]. Default value is `OneDay`.
[1]: docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 |
# File 'lib/aws-sdk-firehose/types.rb', line 1365 class ElasticsearchDestinationUpdate < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_update, :processing_configuration, :cloud_watch_logging_options) include Aws::Structure end |
#processing_configuration ⇒ Types::ProcessingConfiguration
The data processing configuration.
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 |
# File 'lib/aws-sdk-firehose/types.rb', line 1365 class ElasticsearchDestinationUpdate < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_update, :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).
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 |
# File 'lib/aws-sdk-firehose/types.rb', line 1365 class ElasticsearchDestinationUpdate < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_update, :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
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 |
# File 'lib/aws-sdk-firehose/types.rb', line 1365 class ElasticsearchDestinationUpdate < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_update, :processing_configuration, :cloud_watch_logging_options) include Aws::Structure end |
#s3_update ⇒ Types::S3DestinationUpdate
The Amazon S3 destination.
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 |
# File 'lib/aws-sdk-firehose/types.rb', line 1365 class ElasticsearchDestinationUpdate < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_update, :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 runtime.
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 |
# File 'lib/aws-sdk-firehose/types.rb', line 1365 class ElasticsearchDestinationUpdate < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_update, :processing_configuration, :cloud_watch_logging_options) include Aws::Structure end |