AWSFirehoseAmazonOpenSearchServerlessDestinationConfiguration Class Reference


                    
                    
                    bufferingHints

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

Declaration

Objective-C

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

Swift

var bufferingHints: AWSFirehoseAmazonOpenSearchServerlessBufferingHints? { get set }


                    
                    
                    cloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your delivery stream.

Declaration

Objective-C

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

Swift

var cloudWatchLoggingOptions: AWSFirehoseCloudWatchLoggingOptions? { get set }


                    
                    
                    collectionEndpoint

The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

Declaration

Objective-C

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

Swift

var collectionEndpoint: String? { get set }


                    
                    
                    indexName

The Serverless offering for Amazon OpenSearch Service index name.

Declaration

Objective-C

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

Swift

var indexName: String? { get set }


                    
                    
                    processingConfiguration

Describes a 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 the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

Declaration

Objective-C

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

Swift

var retryOptions: AWSFirehoseAmazonOpenSearchServerlessRetryOptions? { get set }


                    
                    
                    roleARN

The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

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.

Declaration

Objective-C

@property (nonatomic) AWSFirehoseAmazonOpenSearchServerlessS3BackupMode s3BackupMode;

Swift

var s3BackupMode: AWSFirehoseAmazonOpenSearchServerlessS3BackupMode { get set }


                    
                    
                    s3Configuration

Describes the configuration of a destination in Amazon S3.

Declaration

Objective-C

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

Swift

var s3Configuration: AWSFirehoseS3DestinationConfiguration? { get set }


                    
                    
                    vpcConfiguration

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

Declaration

Objective-C

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

Swift

var vpcConfiguration: AWSFirehoseVpcConfiguration? { get set }