AmazonOpenSearchServerlessDestinationConfiguration

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AmazonOpenSearchServerlessDestinationConfiguration",
  "title": "AmazonOpenSearchServerlessDestinationConfiguration",
  "type": "object",
  "required": [
    "RoleARN",
    "IndexName",
    "S3Configuration"
  ],
  "properties": {
    "RoleARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents."
        }
      ]
    },
    "CollectionEndpoint": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AmazonOpenSearchServerlessCollectionEndpoint"
        },
        {
          "description": "The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service."
        }
      ]
    },
    "IndexName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AmazonOpenSearchServerlessIndexName"
        },
        {
          "description": "The Serverless offering for Amazon OpenSearch Service index name."
        }
      ]
    },
    "BufferingHints": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AmazonOpenSearchServerlessBufferingHints"
        },
        {
          "description": "The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used."
        }
      ]
    },
    "RetryOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AmazonOpenSearchServerlessRetryOptions"
        },
        {
          "description": "The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes)."
        }
      ]
    },
    "S3BackupMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AmazonOpenSearchServerlessS3BackupMode"
        },
        {
          "description": "Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data 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, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix."
        }
      ]
    },
    "S3Configuration": {
      "$ref": "#/components/schemas/S3DestinationConfiguration"
    },
    "ProcessingConfiguration": {
      "$ref": "#/components/schemas/ProcessingConfiguration"
    },
    "CloudWatchLoggingOptions": {
      "$ref": "#/components/schemas/CloudWatchLoggingOptions"
    },
    "VpcConfiguration": {
      "$ref": "#/components/schemas/VpcConfiguration"
    }
  },
  "description": "Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service."
}