Class: Aws::Firehose::Types::ElasticsearchDestinationUpdate
- Inherits:
-
Struct
- Object
- Struct
- Aws::Firehose::Types::ElasticsearchDestinationUpdate
- 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
-
#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.
-
#document_id_options ⇒ Types::DocumentIdOptions
Indicates the method for setting up document ID.
-
#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 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 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.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1685 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_options ⇒ Types::CloudWatchLoggingOptions
The CloudWatch logging options for your delivery stream.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1685 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_endpoint ⇒ String
The endpoint to use when communicating with the cluster. Specify
either this ClusterEndpoint
or the DomainARN
field.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1685 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_options ⇒ Types::DocumentIdOptions
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1685 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_arn ⇒ String
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
.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1685 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_name ⇒ String
The Elasticsearch index name.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1685 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_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
.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1685 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_configuration ⇒ Types::ProcessingConfiguration
The data processing configuration.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1685 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_options ⇒ Types::ElasticsearchRetryOptions
The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1685 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_arn ⇒ String
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.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1685 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_update ⇒ Types::S3DestinationUpdate
The Amazon S3 destination.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1685 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_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, 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
.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1685 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 |