# Generated by default/object.tt package Paws::Firehose::ElasticsearchDestinationConfiguration; use Moose; has BufferingHints => (is => 'ro', isa => 'Paws::Firehose::ElasticsearchBufferingHints'); has CloudWatchLoggingOptions => (is => 'ro', isa => 'Paws::Firehose::CloudWatchLoggingOptions'); has ClusterEndpoint => (is => 'ro', isa => 'Str'); has DomainARN => (is => 'ro', isa => 'Str'); has IndexName => (is => 'ro', isa => 'Str', required => 1); has IndexRotationPeriod => (is => 'ro', isa => 'Str'); has ProcessingConfiguration => (is => 'ro', isa => 'Paws::Firehose::ProcessingConfiguration'); has RetryOptions => (is => 'ro', isa => 'Paws::Firehose::ElasticsearchRetryOptions'); has RoleARN => (is => 'ro', isa => 'Str', required => 1); has S3BackupMode => (is => 'ro', isa => 'Str'); has S3Configuration => (is => 'ro', isa => 'Paws::Firehose::S3DestinationConfiguration', required => 1); has TypeName => (is => 'ro', isa => 'Str'); has VpcConfiguration => (is => 'ro', isa => 'Paws::Firehose::VpcConfiguration'); 1; ### main pod documentation begin ### =head1 NAME Paws::Firehose::ElasticsearchDestinationConfiguration =head1 USAGE This class represents one of two things: =head3 Arguments in a call to a service Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object. As an example, if Att1 is expected to be a Paws::Firehose::ElasticsearchDestinationConfiguration object: $service_obj->Method(Att1 => { BufferingHints => $value, ..., VpcConfiguration => $value }); =head3 Results returned from an API call Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::ElasticsearchDestinationConfiguration object: $result = $service_obj->Method(...); $result->Att1->BufferingHints =head1 DESCRIPTION Describes the configuration of a destination in Amazon ES. =head1 ATTRIBUTES =head2 BufferingHints => L The buffering options. If no value is specified, the default values for C are used. =head2 CloudWatchLoggingOptions => L The Amazon CloudWatch logging options for your delivery stream. =head2 ClusterEndpoint => Str The endpoint to use when communicating with the cluster. Specify either this C or the C field. =head2 DomainARN => Str The ARN of the Amazon ES domain. The IAM role must have permissions for C, C, and C after assuming the role specified in B. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). Specify either C or C. =head2 B IndexName => Str The Elasticsearch index name. =head2 IndexRotationPeriod => Str The Elasticsearch index rotation period. Index rotation appends a timestamp to the C to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation). The default value is C. =head2 ProcessingConfiguration => L The data processing configuration. =head2 RetryOptions => L The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes). =head2 B RoleARN => Str 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 (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) and Amazon Resource Names (ARNs) and AWS Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). =head2 S3BackupMode => Str Defines how documents should be delivered to Amazon S3. When it is set to C, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with C appended to the key prefix. When set to C, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with C appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup). Default value is C. You can't change this backup mode after you create the delivery stream. =head2 B S3Configuration => L The configuration for the backup Amazon S3 location. =head2 TypeName => Str 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. For Elasticsearch 7.x, don't specify a C. =head2 VpcConfiguration => L The details of the VPC of the Amazon ES destination. =head1 SEE ALSO This class forms part of L, describing an object used in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut