AWSFirehoseElasticsearchDestinationUpdate Class Reference

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

Overview

Describes an update for a destination in Amazon ES.

  bufferingHints

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

@property (nonatomic, strong) AWSFirehoseElasticsearchBufferingHints *bufferingHints

Declared In

AWSFirehoseModel.h

  cloudWatchLoggingOptions

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

@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 IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.

@property (nonatomic, assign) AWSFirehoseElasticsearchIndexRotationPeriod indexRotationPeriod

Declared In

AWSFirehoseModel.h

  processingConfiguration

The data processing configuration.

@property (nonatomic, strong) AWSFirehoseProcessingConfiguration *processingConfiguration

Declared In

AWSFirehoseModel.h

  retryOptions

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

@property (nonatomic, strong) AWSFirehoseElasticsearchRetryOptions *retryOptions

Declared In

AWSFirehoseModel.h

  roleARN

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 and Amazon Resource Names (ARNs) and AWS Service Namespaces.

@property (nonatomic, strong) NSString *roleARN

Declared In

AWSFirehoseModel.h

  s3Update

The Amazon S3 destination.

@property (nonatomic, strong) AWSFirehoseS3DestinationUpdate *s3Update

Declared In

AWSFirehoseModel.h

  typeName

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.

@property (nonatomic, strong) NSString *typeName

Declared In

AWSFirehoseModel.h