ElasticsearchDestinationUpdate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ElasticsearchDestinationUpdate",
  "title": "ElasticsearchDestinationUpdate",
  "type": "object",
  "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 Amazon ES Configuration API and for indexing documents. For more information, see <a href=\"https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Grant Kinesis Data Firehose Access to an Amazon S3 Destination</a> and <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>."
        }
      ]
    },
    "DomainARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ElasticsearchDomainARN"
        },
        {
          "description": "<p>The ARN of the Amazon ES domain. The IAM role must have permissions for\u00a0<code>DescribeDomain</code>, <code>DescribeDomains</code>, and <code>DescribeDomainConfig</code>\u00a0after assuming the IAM role specified in <code>RoleARN</code>. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p> <p>Specify either <code>ClusterEndpoint</code> or <code>DomainARN</code>.</p>"
        }
      ]
    },
    "ClusterEndpoint": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ElasticsearchClusterEndpoint"
        },
        {
          "description": "The endpoint to use when communicating with the cluster. Specify either this <code>ClusterEndpoint</code> or the <code>DomainARN</code> field."
        }
      ]
    },
    "IndexName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ElasticsearchIndexName"
        },
        {
          "description": "The Elasticsearch index name."
        }
      ]
    },
    "TypeName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ElasticsearchTypeName"
        },
        {
          "description": "<p>The Elasticsearch 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, Kinesis Data Firehose returns an error during runtime.</p> <p>If you upgrade Elasticsearch from 6.x to 7.x and don\u2019t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for <code>TypeName</code>. </p>"
        }
      ]
    },
    "IndexRotationPeriod": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ElasticsearchIndexRotationPeriod"
        },
        {
          "description": "The Elasticsearch index rotation period. Index rotation appends a timestamp to <code>IndexName</code> to facilitate the expiration of old data. For more information, see <a href=\"https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation\">Index Rotation for the Amazon ES Destination</a>. Default value is\u00a0<code>OneDay</code>."
        }
      ]
    },
    "BufferingHints": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ElasticsearchBufferingHints"
        },
        {
          "description": "The buffering options. If no value is specified, <code>ElasticsearchBufferingHints</code> object default values are used. "
        }
      ]
    },
    "RetryOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ElasticsearchRetryOptions"
        },
        {
          "description": "The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes)."
        }
      ]
    },
    "S3Update": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3DestinationUpdate"
        },
        {
          "description": "The Amazon S3 destination."
        }
      ]
    },
    "ProcessingConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProcessingConfiguration"
        },
        {
          "description": "The data processing configuration."
        }
      ]
    },
    "CloudWatchLoggingOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CloudWatchLoggingOptions"
        },
        {
          "description": "The CloudWatch logging options for your delivery stream."
        }
      ]
    }
  },
  "description": "Describes an update for a destination in Amazon ES."
}