AWSFirehoseElasticsearchDestinationDescription Class Reference


                    
                    
                    bufferingHints

The buffering options.

Declaration

Objective-C

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

Swift

var bufferingHints: AWSFirehoseElasticsearchBufferingHints? { get set }


                    
                    
                    cloudWatchLoggingOptions

The Amazon CloudWatch logging options.

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. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.

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. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.

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

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 Amazon ES retry options.

Declaration

Objective-C

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

Swift

var retryOptions: AWSFirehoseElasticsearchRetryOptions? { get set }


                    
                    
                    roleARN

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see 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

The Amazon S3 backup mode.

Declaration

Objective-C

@property (nonatomic) AWSFirehoseElasticsearchS3BackupMode s3BackupMode;

Swift

var s3BackupMode: AWSFirehoseElasticsearchS3BackupMode { get set }


                    
                    
                    s3DestinationDescription

The Amazon S3 destination.

Declaration

Objective-C

@property (nonatomic, strong) AWSFirehoseS3DestinationDescription *_Nullable s3DestinationDescription;

Swift

var s3DestinationDescription: AWSFirehoseS3DestinationDescription? { get set }


                    
                    
                    typeName

The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there’s no value for TypeName.

Declaration

Objective-C

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

Swift

var typeName: String? { get set }


                    
                    
                    vpcConfigurationDescription

The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.

Declaration

Objective-C

@property (nonatomic, strong) AWSFirehoseVpcConfigurationDescription *_Nullable vpcConfigurationDescription;

Swift

var vpcConfigurationDescription: AWSFirehoseVpcConfigurationDescription? { get set }