AWSFirehoseElasticsearchDestinationUpdate

@interface AWSFirehoseElasticsearchDestinationUpdate

Describes an update for a destination in Amazon ES.

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

    Declaration

    Objective-C

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

    Swift

    var bufferingHints: AWSFirehoseElasticsearchBufferingHints? { get set }
  • The CloudWatch logging options for your delivery stream.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        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 (readwrite, strong, nonatomic) NSString *_Nullable clusterEndpoint;

    Swift

    var clusterEndpoint: String? { get set }
  • 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.

    Specify either ClusterEndpoint or DomainARN.

    Declaration

    Objective-C

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

    Swift

    var domainARN: String? { get set }
  • The Elasticsearch index name.

    Declaration

    Objective-C

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

    Swift

    var indexName: String? { get set }
  • 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.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
        AWSFirehoseElasticsearchIndexRotationPeriod indexRotationPeriod;

    Swift

    var indexRotationPeriod: AWSFirehoseElasticsearchIndexRotationPeriod { get set }
  • The data processing configuration.

    Declaration

    Objective-C

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

    Swift

    var processingConfiguration: AWSFirehoseProcessingConfiguration? { get set }
  • The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

    Declaration

    Objective-C

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

    Swift

    var retryOptions: AWSFirehoseElasticsearchRetryOptions? { get set }
  • 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.

    Declaration

    Objective-C

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

    Swift

    var roleARN: String? { get set }
  • The Amazon S3 destination.

    Declaration

    Objective-C

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

    Swift

    var s3Update: AWSFirehoseS3DestinationUpdate? { get set }
  • 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.

    If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data 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 (readwrite, strong, nonatomic) NSString *_Nullable typeName;

    Swift

    var typeName: String? { get set }