Module Values.AmazonopensearchserviceDestinationUpdateSource

Describes an update for a destination in Amazon OpenSearch Service.

Sourcetype nonrec t = {
  1. roleARN : RoleARN.t option;
    (*

    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.

    *)
  2. domainARN : AmazonopensearchserviceDomainARN.t option;
    (*

    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.

    *)
  3. clusterEndpoint : AmazonopensearchserviceClusterEndpoint.t option;
    (*

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

    *)
  4. indexName : AmazonopensearchserviceIndexName.t option;
    (*

    The Amazon OpenSearch Service index name.

    *)
  5. typeName : AmazonopensearchserviceTypeName.t option;
    (*

    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 Firehose stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your Firehose stream with a new index name, provide an empty string for TypeName.

    *)
  6. indexRotationPeriod : AmazonopensearchserviceIndexRotationPeriod.t option;
    (*

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

    *)
  7. bufferingHints : AmazonopensearchserviceBufferingHints.t option;
    (*

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

    *)
  8. retryOptions : AmazonopensearchserviceRetryOptions.t option;
    (*

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

    *)
  9. s3Update : S3DestinationUpdate.t option;
  10. processingConfiguration : ProcessingConfiguration.t option;
  11. cloudWatchLoggingOptions : CloudWatchLoggingOptions.t option;
  12. documentIdOptions : DocumentIdOptions.t option;
    (*

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

    *)
}
Sourceval make : ?roleARN:??? -> ?domainARN:??? -> ?clusterEndpoint:??? -> ?indexName:??? -> ?typeName:??? -> ?indexRotationPeriod:??? -> ?bufferingHints:??? -> ?retryOptions:??? -> ?s3Update:??? -> ?processingConfiguration:??? -> ?cloudWatchLoggingOptions:??? -> ?documentIdOptions:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of RoleARN.t | `Structure of (string * [> `Boolean of BooleanObject.t | `Enum of string | `Integer of AmazonopensearchserviceBufferingIntervalInSeconds.t | `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `String of ProcessorParameterValue.t ]) list ] list ]) list ] list | `String of RoleARN.t | `Structure of (string * [> `Boolean of BooleanObject.t | `Enum of string | `Integer of SizeInMBs.t | `String of LogGroupName.t | `Structure of (string * [> `String of AWSKMSKeyARN.t ]) list ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t