Class: Aws::Firehose::Types::ElasticsearchDestinationDescription
- Inherits:
-
Struct
- Object
- Struct
- Aws::Firehose::Types::ElasticsearchDestinationDescription
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-firehose/types.rb
Overview
The destination description 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 Amazon CloudWatch logging options.
-
#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 Amazon ES retry options.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
-
#s3_backup_mode ⇒ String
The Amazon S3 backup mode.
-
#s3_destination_description ⇒ Types::S3DestinationDescription
The Amazon S3 destination.
-
#type_name ⇒ String
The Elasticsearch type name.
-
#vpc_configuration_description ⇒ Types::VpcConfigurationDescription
The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.
Instance Attribute Details
#buffering_hints ⇒ Types::ElasticsearchBufferingHints
The buffering options.
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 |
# File 'lib/aws-sdk-firehose/types.rb', line 1574 class ElasticsearchDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
The Amazon CloudWatch logging options.
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 |
# File 'lib/aws-sdk-firehose/types.rb', line 1574 class ElasticsearchDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#cluster_endpoint ⇒ String
The endpoint to use when communicating with the cluster. Firehose uses either this ‘ClusterEndpoint` or the `DomainARN` field to send data to Amazon ES.
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 |
# File 'lib/aws-sdk-firehose/types.rb', line 1574 class ElasticsearchDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :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.
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 |
# File 'lib/aws-sdk-firehose/types.rb', line 1574 class ElasticsearchDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#domain_arn ⇒ String
The ARN of the Amazon ES domain. For more information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces].
Firehose uses either ‘ClusterEndpoint` or `DomainARN` to send data to Amazon ES.
[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 |
# File 'lib/aws-sdk-firehose/types.rb', line 1574 class ElasticsearchDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#index_name ⇒ String
The Elasticsearch index name.
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 |
# File 'lib/aws-sdk-firehose/types.rb', line 1574 class ElasticsearchDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#index_rotation_period ⇒ String
The Elasticsearch index rotation period
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 |
# File 'lib/aws-sdk-firehose/types.rb', line 1574 class ElasticsearchDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#processing_configuration ⇒ Types::ProcessingConfiguration
The data processing configuration.
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 |
# File 'lib/aws-sdk-firehose/types.rb', line 1574 class ElasticsearchDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#retry_options ⇒ Types::ElasticsearchRetryOptions
The Amazon ES retry options.
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 |
# File 'lib/aws-sdk-firehose/types.rb', line 1574 class ElasticsearchDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces].
[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 |
# File 'lib/aws-sdk-firehose/types.rb', line 1574 class ElasticsearchDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#s3_backup_mode ⇒ String
The Amazon S3 backup mode.
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 |
# File 'lib/aws-sdk-firehose/types.rb', line 1574 class ElasticsearchDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#s3_destination_description ⇒ Types::S3DestinationDescription
The Amazon S3 destination.
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 |
# File 'lib/aws-sdk-firehose/types.rb', line 1574 class ElasticsearchDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#type_name ⇒ String
The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there’s no value for ‘TypeName`.
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 |
# File 'lib/aws-sdk-firehose/types.rb', line 1574 class ElasticsearchDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |
#vpc_configuration_description ⇒ Types::VpcConfigurationDescription
The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 |
# File 'lib/aws-sdk-firehose/types.rb', line 1574 class ElasticsearchDestinationDescription < Struct.new( :role_arn, :domain_arn, :cluster_endpoint, :index_name, :type_name, :index_rotation_period, :buffering_hints, :retry_options, :s3_backup_mode, :s3_destination_description, :processing_configuration, :cloud_watch_logging_options, :vpc_configuration_description, :document_id_options) SENSITIVE = [] include Aws::Structure end |