Module Values.AmazonOpenSearchServerlessDestinationConfigurationSource

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

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

    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.

    *)
  2. collectionEndpoint : AmazonOpenSearchServerlessCollectionEndpoint.t option;
    (*

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

    *)
  3. indexName : AmazonOpenSearchServerlessIndexName.t;
    (*

    The Serverless offering for Amazon OpenSearch Service index name.

    *)
  4. bufferingHints : AmazonOpenSearchServerlessBufferingHints.t option;
    (*

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

    *)
  5. retryOptions : AmazonOpenSearchServerlessRetryOptions.t option;
    (*

    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).

    *)
  6. s3BackupMode : AmazonOpenSearchServerlessS3BackupMode.t option;
    (*

    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.

    *)
  7. s3Configuration : S3DestinationConfiguration.t;
  8. processingConfiguration : ProcessingConfiguration.t option;
  9. cloudWatchLoggingOptions : CloudWatchLoggingOptions.t option;
  10. vpcConfiguration : VpcConfiguration.t option;
}
Sourceval context_ : string
Sourceval make : ?collectionEndpoint:??? -> ?bufferingHints:??? -> ?retryOptions:??? -> ?s3BackupMode:??? -> ?processingConfiguration:??? -> ?cloudWatchLoggingOptions:??? -> ?vpcConfiguration:??? -> roleARN:RoleARN.t -> indexName:AmazonOpenSearchServerlessIndexName.t -> s3Configuration:S3DestinationConfiguration.t -> 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 AmazonOpenSearchServerlessBufferingIntervalInSeconds.t | `List of [> `String of NonEmptyStringWithoutWhitespace.t | `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