Module Values.AmazonopensearchserviceDestinationDescriptionSource

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.

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

    The ARN of the Amazon OpenSearch Service domain.

    *)
  3. clusterEndpoint : AmazonopensearchserviceClusterEndpoint.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 : AmazonopensearchserviceIndexName.t option;
    (*

    The Amazon OpenSearch Service index name.

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

    The Amazon OpenSearch Service 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 : AmazonopensearchserviceIndexRotationPeriod.t option;
    (*

    The Amazon OpenSearch Service index rotation period

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

    The buffering options.

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

    The Amazon OpenSearch Service retry options.

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

    The Amazon S3 backup mode.

    *)
  10. s3DestinationDescription : S3DestinationDescription.t option;
  11. processingConfiguration : ProcessingConfiguration.t option;
  12. cloudWatchLoggingOptions : CloudWatchLoggingOptions.t option;
  13. vpcConfigurationDescription : VpcConfigurationDescription.t option;
  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:RoleARN.t -> ?domainARN:AmazonopensearchserviceDomainARN.t -> ?clusterEndpoint:AmazonopensearchserviceClusterEndpoint.t -> ?indexName:AmazonopensearchserviceIndexName.t -> ?typeName:AmazonopensearchserviceTypeName.t -> ?indexRotationPeriod:AmazonopensearchserviceIndexRotationPeriod.t -> ?bufferingHints:AmazonopensearchserviceBufferingHints.t -> ?retryOptions:AmazonopensearchserviceRetryOptions.t -> ?s3BackupMode:AmazonopensearchserviceS3BackupMode.t -> ?s3DestinationDescription:S3DestinationDescription.t -> ?processingConfiguration:ProcessingConfiguration.t -> ?cloudWatchLoggingOptions:CloudWatchLoggingOptions.t -> ?vpcConfigurationDescription:VpcConfigurationDescription.t -> ?documentIdOptions:DocumentIdOptions.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 AmazonopensearchserviceBufferingIntervalInSeconds.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