AWSFirehoseAmazonopensearchserviceDestinationUpdate

Objective-C

@interface AWSFirehoseAmazonopensearchserviceDestinationUpdate

Swift

class AWSFirehoseAmazonopensearchserviceDestinationUpdate

Describes an update for a destination in Amazon OpenSearch Service.

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

    Declaration

    Objective-C

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

    Swift

    var bufferingHints: AWSFirehoseAmazonopensearchserviceBufferingHints? { get set }

  • 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 }

  • 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 }

  • 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 }

  • The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.

    Declaration

    Objective-C

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

    Swift

    var domainARN: String? { get set }

  • The Amazon OpenSearch Service index name.

    Declaration

    Objective-C

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

    Swift

    var indexName: String? { get set }

  • The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.

    Declaration

    Objective-C

    @property (nonatomic) AWSFirehoseAmazonopensearchserviceIndexRotationPeriod indexRotationPeriod;

    Swift

    var indexRotationPeriod: AWSFirehoseAmazonopensearchserviceIndexRotationPeriod { get set }

  • Describes a data processing configuration.

    Declaration

    Objective-C

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

    Swift

    var processingConfiguration: AWSFirehoseProcessingConfiguration? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var retryOptions: AWSFirehoseAmazonopensearchserviceRetryOptions? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var roleARN: String? { get set }

  • Describes an update for a destination in Amazon S3.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSFirehoseS3DestinationUpdate *_Nullable s3Update;

    Swift

    var s3Update: AWSFirehoseS3DestinationUpdate? { get set }

  • The Amazon OpenSearch Service 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 runtime.

    If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

    Declaration

    Objective-C

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

    Swift

    var typeName: String? { get set }