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

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

Overview

Describes an update for a destination in Amazon ES.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#buffering_hintsTypes::ElasticsearchBufferingHints

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



1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1668

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,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.



1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1668

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,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_endpointString

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

Returns:

  • (String)


1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1668

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,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#document_id_optionsTypes::DocumentIdOptions

Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.



1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1668

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,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#domain_arnString

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

Returns:

  • (String)


1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1668

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,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#index_nameString

The Elasticsearch index name.

Returns:

  • (String)


1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1668

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,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#index_rotation_periodString

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.

Returns:

  • (String)


1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1668

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,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#processing_configurationTypes::ProcessingConfiguration

The data processing configuration.



1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1668

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,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#retry_optionsTypes::ElasticsearchRetryOptions

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



1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1668

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,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Returns:

  • (String)


1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1668

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,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#s3_updateTypes::S3DestinationUpdate

The Amazon S3 destination.



1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1668

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,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#type_nameString

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, Firehose returns an error during runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

Returns:

  • (String)


1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1668

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,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end