Module Values.ElasticsearchDestinationDescriptionSource

The destination description in Amazon OpenSearch Service.

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

    The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

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

    The ARN of the Amazon OpenSearch Service domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces. Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon OpenSearch Service.

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

    The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.

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

    The Elasticsearch index name.

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

    The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

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

    The Elasticsearch index rotation period

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

    The buffering options.

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

    The Amazon OpenSearch Service retry options.

    *)
  9. s3BackupMode : ElasticsearchS3BackupMode.t option;
    (*

    The Amazon S3 backup mode.

    *)
  10. s3DestinationDescription : S3DestinationDescription.t option;
    (*

    The Amazon S3 destination.

    *)
  11. processingConfiguration : ProcessingConfiguration.t option;
    (*

    The data processing configuration.

    *)
  12. cloudWatchLoggingOptions : CloudWatchLoggingOptions.t option;
    (*

    The Amazon CloudWatch logging options.

    *)
  13. vpcConfigurationDescription : VpcConfigurationDescription.t option;
    (*

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

    *)
  14. 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:??? -> ?s3BackupMode:??? -> ?s3DestinationDescription:??? -> ?processingConfiguration:??? -> ?cloudWatchLoggingOptions:??? -> ?vpcConfigurationDescription:??? -> ?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 ElasticsearchBufferingIntervalInSeconds.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