AWSFirehoseElasticsearchDestinationConfiguration Class Reference


                    
                    
                    bufferingHints

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

Declaration

Objective-C

@property (nonatomic, strong) AWSFirehoseElasticsearchBufferingHints *_Nullable bufferingHints;

Swift

var bufferingHints: AWSFirehoseElasticsearchBufferingHints? { get set }


                    
                    
                    cloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.

Declaration

Objective-C

@property (nonatomic, strong) AWSFirehoseCloudWatchLoggingOptions *_Nullable cloudWatchLoggingOptions;

Swift

var cloudWatchLoggingOptions: AWSFirehoseCloudWatchLoggingOptions? { get set }


                    
                    
                    clusterEndpoint

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

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable clusterEndpoint;

Swift

var clusterEndpoint: String? { get set }


                    
                    
                    documentIdOptions

Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

Declaration

Objective-C

@property (nonatomic, strong) AWSFirehoseDocumentIdOptions *_Nullable documentIdOptions;

Swift

var documentIdOptions: AWSFirehoseDocumentIdOptions? { get set }


                    
                    
                    domainARN

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable domainARN;

Swift

var domainARN: String? { get set }


                    
                    
                    indexName

The Elasticsearch index name.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable indexName;

Swift

var indexName: String? { get set }


                    
                    
                    indexRotationPeriod

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

Declaration

Objective-C

@property (nonatomic) AWSFirehoseElasticsearchIndexRotationPeriod indexRotationPeriod;

Swift

var indexRotationPeriod: AWSFirehoseElasticsearchIndexRotationPeriod { get set }


                    
                    
                    processingConfiguration

The data processing configuration.

Declaration

Objective-C

@property (nonatomic, strong) AWSFirehoseProcessingConfiguration *_Nullable processingConfiguration;

Swift

var processingConfiguration: AWSFirehoseProcessingConfiguration? { get set }


                    
                    
                    retryOptions

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

Declaration

Objective-C

@property (nonatomic, strong) AWSFirehoseElasticsearchRetryOptions *_Nullable retryOptions;

Swift

var retryOptions: AWSFirehoseElasticsearchRetryOptions? { get set }


                    
                    
                    roleARN

The Amazon Resource Name (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 Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable roleARN;

Swift

var roleARN: String? { get set }


                    
                    
                    s3BackupMode

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

You can’t change this backup mode after you create the delivery stream.

Declaration

Objective-C

@property (nonatomic) AWSFirehoseElasticsearchS3BackupMode s3BackupMode;

Swift

var s3BackupMode: AWSFirehoseElasticsearchS3BackupMode { get set }


                    
                    
                    s3Configuration

The configuration for the backup Amazon S3 location.

Declaration

Objective-C

@property (nonatomic, strong) AWSFirehoseS3DestinationConfiguration *_Nullable s3Configuration;

Swift

var s3Configuration: AWSFirehoseS3DestinationConfiguration? { get set }


                    
                    
                    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, Firehose returns an error during run time.

For Elasticsearch 7.x, don’t specify a TypeName.

Declaration

Objective-C

@property (nonatomic, strong) NSString *_Nullable typeName;

Swift

var typeName: String? { get set }


                    
                    
                    vpcConfiguration

The details of the VPC of the Amazon destination.

Declaration

Objective-C

@property (nonatomic, strong) AWSFirehoseVpcConfiguration *_Nullable vpcConfiguration;

Swift

var vpcConfiguration: AWSFirehoseVpcConfiguration? { get set }