NAME

Paws::Firehose::ElasticsearchDestinationUpdate

USAGE

This class represents one of two things:

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::ElasticsearchDestinationUpdate object:

  $service_obj->Method(Att1 => { BufferingHints => $value, ..., TypeName => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::ElasticsearchDestinationUpdate object:

  $result = $service_obj->Method(...);
  $result->Att1->BufferingHints

DESCRIPTION

Describes an update for a destination in Amazon ES.

ATTRIBUTES

BufferingHints => Paws::Firehose::ElasticsearchBufferingHints

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

CloudWatchLoggingOptions => Paws::Firehose::CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.

ClusterEndpoint => Str

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

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 (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).

Specify either "ClusterEndpoint" or "DomainARN".

IndexName => Str

The Elasticsearch index name.

IndexRotationPeriod => Str

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 (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation). Default value is "OneDay".

ProcessingConfiguration => Paws::Firehose::ProcessingConfiguration

The data processing configuration.

RetryOptions => Paws::Firehose::ElasticsearchRetryOptions

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

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).

S3Update => Paws::Firehose::S3DestinationUpdate

The Amazon S3 destination.

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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data 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".

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>