AWSFirehoseElasticsearchDestinationConfiguration Class Reference

Inherits from AWSModel : AWSMTLModel
Declared in AWSFirehoseModel.h
AWSFirehoseModel.m

Overview

Describes the configuration of a destination in Amazon ES.

Required parameters: [RoleARN, DomainARN, IndexName, TypeName, S3Configuration]

  bufferingHints

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

@property (nonatomic, strong) AWSFirehoseElasticsearchBufferingHints *bufferingHints

Declared In

AWSFirehoseModel.h

  cloudWatchLoggingOptions

Describes CloudWatch logging options for your delivery stream.

@property (nonatomic, strong) AWSFirehoseCloudWatchLoggingOptions *cloudWatchLoggingOptions

Declared In

AWSFirehoseModel.h

  domainARN

The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.

@property (nonatomic, strong) NSString *domainARN

Declared In

AWSFirehoseModel.h

  indexName

The Elasticsearch index name.

@property (nonatomic, strong) NSString *indexName

Declared In

AWSFirehoseModel.h

  indexRotationPeriod

The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is OneDay.

@property (nonatomic, assign) AWSFirehoseElasticsearchIndexRotationPeriod indexRotationPeriod

Declared In

AWSFirehoseModel.h

  retryOptions

Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).

@property (nonatomic, strong) AWSFirehoseElasticsearchRetryOptions *retryOptions

Declared In

AWSFirehoseModel.h

  roleARN

The 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 Amazon S3 Bucket Access.

@property (nonatomic, strong) NSString *roleARN

Declared In

AWSFirehoseModel.h

  s3BackupMode

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.

@property (nonatomic, assign) AWSFirehoseElasticsearchS3BackupMode s3BackupMode

Declared In

AWSFirehoseModel.h

  s3Configuration

Describes the configuration of a destination in Amazon S3.

@property (nonatomic, strong) AWSFirehoseS3DestinationConfiguration *s3Configuration

Declared In

AWSFirehoseModel.h

  typeName

The Elasticsearch type name.

@property (nonatomic, strong) NSString *typeName

Declared In

AWSFirehoseModel.h