openapi: 3.0.0
info:
  version: 2015-08-04
  x-release: v4
  title: 'Amazon Kinesis Firehose CreateSignalingChannel #X Amz Target=Firehose 20150804.CreateDeliveryStream API'
  description: <fullname>Amazon Kinesis Data Firehose API Reference</fullname> <p>Amazon Kinesis Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch Service, Amazon Redshift, Splunk, and various other supportd destinations.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: firehose
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/firehose-2015-08-04.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://firehose.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Firehose multi-region endpoint
- url: https://firehose.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Firehose multi-region endpoint
- url: http://firehose.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Firehose endpoint for China (Beijing) and China (Ningxia)
- url: https://firehose.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Firehose endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=Firehose 20150804.CreateDeliveryStream'
paths:
  /#X-Amz-Target=Firehose_20150804.CreateDeliveryStream:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: CreateDeliveryStream
      description: '<p>Creates a Kinesis Data Firehose delivery stream.</p> <p>By default, you can create up to 50 delivery streams per Amazon Web Services Region.</p> <p>This is an asynchronous operation that immediately returns. The initial status of the delivery stream is <code>CREATING</code>. After the delivery stream is created, its status is <code>ACTIVE</code> and it now accepts data. If the delivery stream creation fails, the status transitions to <code>CREATING_FAILED</code>. Attempts to send data to a delivery stream that is not in the <code>ACTIVE</code> state cause an exception. To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>.</p> <p>If the status of a delivery stream is <code>CREATING_FAILED</code>, this status doesn''t change, and you can''t invoke <code>CreateDeliveryStream</code> again on it. However, you can invoke the <a>DeleteDeliveryStream</a> operation to delete it.</p> <p>A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using <a>PutRecord</a> or <a>PutRecordBatch</a>, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the <code>DeliveryStreamType</code> parameter to <code>KinesisStreamAsSource</code>, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the <code>KinesisStreamSourceConfiguration</code> parameter.</p> <p>To create a delivery stream with server-side encryption (SSE) enabled, include <a>DeliveryStreamEncryptionConfigurationInput</a> in your request. This is optional. You can also invoke <a>StartDeliveryStreamEncryption</a> to turn on SSE for an existing delivery stream that doesn''t have SSE enabled.</p> <p>A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: <code>ExtendedS3DestinationConfiguration</code>, <code>S3DestinationConfiguration</code>, <code>ElasticsearchDestinationConfiguration</code>, <code>RedshiftDestinationConfiguration</code>, or <code>SplunkDestinationConfiguration</code>.</p> <p>When you specify <code>S3DestinationConfiguration</code>, you can also provide the following optional values: BufferingHints, <code>EncryptionConfiguration</code>, and <code>CompressionFormat</code>. By default, if no <code>BufferingHints</code> value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. <code>BufferingHints</code> is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.</p> <p>A few notes about Amazon Redshift as a destination:</p> <ul> <li> <p>An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses <code>COPY</code> syntax to load data into an Amazon Redshift table. This is specified in the <code>RedshiftDestinationConfiguration.S3Configuration</code> parameter.</p> </li> <li> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <code>RedshiftDestinationConfiguration.S3Configuration</code> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn''t support these compression formats.</p> </li> <li> <p>We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift <code>INSERT</code> permissions.</p> </li> </ul> <p>Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. 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> in the <i>Amazon Kinesis Data Firehose Developer Guide</i>.</p>'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDeliveryStreamOutput'
        '480':
          description: InvalidArgumentException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArgumentException'
        '481':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '482':
          description: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '483':
          description: InvalidKMSResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidKMSResourceException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeliveryStreamInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Firehose_20150804.CreateDeliveryStream
      tags:
      - '#X Amz Target=Firehose 20150804.CreateDeliveryStream'
components:
  schemas:
    HttpEndpointBufferingHints:
      type: object
      properties:
        SizeInMBs:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointBufferingSizeInMBs'
          - description: <p>Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. </p> <p>We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher. </p>
        IntervalInSeconds:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointBufferingIntervalInSeconds'
          - description: 'Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes). '
      description: 'Describes the buffering options that can be applied before data is delivered to the HTTP endpoint destination. Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. The <code>SizeInMBs</code> and <code>IntervalInSeconds</code> parameters are optional. However, if specify a value for one of them, you must also provide a value for the other. '
    DeliveryStreamType:
      type: string
      enum:
      - DirectPut
      - KinesisStreamAsSource
    HttpEndpointCommonAttribute:
      type: object
      required:
      - AttributeName
      - AttributeValue
      properties:
        AttributeName:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointAttributeName'
          - description: The name of the HTTP endpoint common attribute.
        AttributeValue:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointAttributeValue'
          - description: The value of the HTTP endpoint common attribute.
      description: Describes the metadata that's delivered to the specified HTTP endpoint destination.
    ElasticsearchS3BackupMode:
      type: string
      enum:
      - FailedDocumentsOnly
      - AllDocuments
    HECEndpoint:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 2048
    ProcessorParameterList:
      type: array
      items:
        $ref: '#/components/schemas/ProcessorParameter'
    TagDeliveryStreamInputTagList:
      type: array
      items:
        $ref: '#/components/schemas/Tag'
      minItems: 1
      maxItems: 50
    DynamicPartitioningConfiguration:
      type: object
      properties:
        RetryOptions:
          allOf:
          - $ref: '#/components/schemas/RetryOptions'
          - description: The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.
        Enabled:
          allOf:
          - $ref: '#/components/schemas/BooleanObject'
          - description: Specifies that the dynamic partitioning is enabled for this Kinesis Data Firehose delivery stream.
      description: 'The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations. '
    CloudWatchLoggingOptions:
      type: object
      properties:
        Enabled:
          allOf:
          - $ref: '#/components/schemas/BooleanObject'
          - description: Enables or disables CloudWatch logging.
        LogGroupName:
          allOf:
          - $ref: '#/components/schemas/LogGroupName'
          - description: The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
        LogStreamName:
          allOf:
          - $ref: '#/components/schemas/LogStreamName'
          - description: The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
      description: Describes the Amazon CloudWatch logging options for your delivery stream.
    S3BackupMode:
      type: string
      enum:
      - Disabled
      - Enabled
    AmazonopensearchserviceTypeName:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 100
    OutputFormatConfiguration:
      type: object
      properties:
        Serializer:
          allOf:
          - $ref: '#/components/schemas/Serializer'
          - description: Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.
      description: Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3. This parameter is required if <code>Enabled</code> is set to true.
    HttpEndpointCommonAttributesList:
      type: array
      items:
        $ref: '#/components/schemas/HttpEndpointCommonAttribute'
      minItems: 0
      maxItems: 50
    LogGroupName:
      type: string
      pattern: '[\.\-_/#A-Za-z0-9]*'
      minLength: 0
      maxLength: 512
    HttpEndpointAccessKey:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 4096
      format: password
    AmazonopensearchserviceBufferingHints:
      type: object
      properties:
        IntervalInSeconds:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceBufferingIntervalInSeconds'
          - description: 'Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes). '
        SizeInMBs:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceBufferingSizeInMBs'
          - description: <p>Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.</p> <p>We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher. </p>
      description: 'Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination. '
    AmazonOpenSearchServerlessBufferingHints:
      type: object
      properties:
        IntervalInSeconds:
          allOf:
          - $ref: '#/components/schemas/AmazonOpenSearchServerlessBufferingIntervalInSeconds'
          - description: Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
        SizeInMBs:
          allOf:
          - $ref: '#/components/schemas/AmazonOpenSearchServerlessBufferingSizeInMBs'
          - description: <p>Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. </p> <p>We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.</p>
      description: Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.
    HttpEndpointRetryDurationInSeconds:
      type: integer
      minimum: 0
      maximum: 7200
    Processor:
      type: object
      required:
      - Type
      properties:
        Type:
          allOf:
          - $ref: '#/components/schemas/ProcessorType'
          - description: The type of processor.
        Parameters:
          allOf:
          - $ref: '#/components/schemas/ProcessorParameterList'
          - description: The processor parameters.
      description: Describes a data processor.
    NonEmptyString:
      type: string
      pattern: ^(?!\s*$).+
      minLength: 1
      maxLength: 1024
    CopyOptions:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 204800
    ProcessorType:
      type: string
      enum:
      - RecordDeAggregation
      - Lambda
      - MetadataExtraction
      - AppendDelimiterToRecord
    AmazonopensearchserviceBufferingSizeInMBs:
      type: integer
      minimum: 1
      maximum: 100
    RedshiftS3BackupMode:
      type: string
      enum:
      - Disabled
      - Enabled
    OrcCompression:
      type: string
      enum:
      - NONE
      - ZLIB
      - SNAPPY
    CreateDeliveryStreamInput:
      type: object
      required:
      - DeliveryStreamName
      title: CreateDeliveryStreamInput
      properties:
        DeliveryStreamName:
          allOf:
          - $ref: '#/components/schemas/DeliveryStreamName'
          - description: The name of the delivery stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.
        DeliveryStreamType:
          allOf:
          - $ref: '#/components/schemas/DeliveryStreamType'
          - description: '<p>The delivery stream type. This parameter can be one of the following values:</p> <ul> <li> <p> <code>DirectPut</code>: Provider applications access the delivery stream directly.</p> </li> <li> <p> <code>KinesisStreamAsSource</code>: The delivery stream uses a Kinesis data stream as a source.</p> </li> </ul>'
        KinesisStreamSourceConfiguration:
          allOf:
          - $ref: '#/components/schemas/KinesisStreamSourceConfiguration'
          - description: When a Kinesis data stream is used as the source for the delivery stream, a <a>KinesisStreamSourceConfiguration</a> containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.
        DeliveryStreamEncryptionConfigurationInput:
          allOf:
          - $ref: '#/components/schemas/DeliveryStreamEncryptionConfigurationInput'
          - description: Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
        S3DestinationConfiguration:
          allOf:
          - $ref: '#/components/schemas/S3DestinationConfiguration'
          - deprecated: true
            description: '[Deprecated] The destination in Amazon S3. You can specify only one destination.'
        ExtendedS3DestinationConfiguration:
          allOf:
          - $ref: '#/components/schemas/ExtendedS3DestinationConfiguration'
          - description: The destination in Amazon S3. You can specify only one destination.
        RedshiftDestinationConfiguration:
          allOf:
          - $ref: '#/components/schemas/RedshiftDestinationConfiguration'
          - description: The destination in Amazon Redshift. You can specify only one destination.
        ElasticsearchDestinationConfiguration:
          allOf:
          - $ref: '#/components/schemas/ElasticsearchDestinationConfiguration'
          - description: The destination in Amazon ES. You can specify only one destination.
        AmazonopensearchserviceDestinationConfiguration:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceDestinationConfiguration'
          - description: The destination in Amazon OpenSearch Service. You can specify only one destination.
        SplunkDestinationConfiguration:
          allOf:
          - $ref: '#/components/schemas/SplunkDestinationConfiguration'
          - description: The destination in Splunk. You can specify only one destination.
        HttpEndpointDestinationConfiguration:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointDestinationConfiguration'
          - description: Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagDeliveryStreamInputTagList'
          - description: <p>A set of tags to assign to the delivery stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation Tags</a> in the Amazon Web Services Billing and Cost Management User Guide.</p> <p>You can specify up to 50 tags when creating a delivery stream.</p>
        AmazonOpenSearchServerlessDestinationConfiguration:
          allOf:
          - $ref: '#/components/schemas/AmazonOpenSearchServerlessDestinationConfiguration'
          - description: The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.
    OrcStripeSizeBytes:
      type: integer
      minimum: 8388608
    ProcessorParameter:
      type: object
      required:
      - ParameterName
      - ParameterValue
      properties:
        ParameterName:
          allOf:
          - $ref: '#/components/schemas/ProcessorParameterName'
          - description: 'The name of the parameter. Currently the following default values are supported: 3 for <code>NumberOfRetries</code> and 60 for the <code>BufferIntervalInSeconds</code>. The <code>BufferSizeInMBs</code> ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB. '
        ParameterValue:
          allOf:
          - $ref: '#/components/schemas/ProcessorParameterValue'
          - description: The parameter value.
      description: 'Describes the processor parameter. '
    InputFormatConfiguration:
      type: object
      properties:
        Deserializer:
          allOf:
          - $ref: '#/components/schemas/Deserializer'
          - description: Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.
      description: Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if <code>Enabled</code> is set to true.
    KeyType:
      type: string
      enum:
      - AWS_OWNED_CMK
      - CUSTOMER_MANAGED_CMK
    RedshiftDestinationConfiguration:
      type: object
      required:
      - RoleARN
      - ClusterJDBCURL
      - CopyCommand
      - Username
      - Password
      - S3Configuration
      properties:
        RoleARN:
          allOf:
          - $ref: '#/components/schemas/RoleARN'
          - description: The Amazon Resource Name (ARN) of the Amazon Web Services credentials. 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>.
        ClusterJDBCURL:
          allOf:
          - $ref: '#/components/schemas/ClusterJDBCURL'
          - description: The database connection string.
        CopyCommand:
          allOf:
          - $ref: '#/components/schemas/CopyCommand'
          - description: The <code>COPY</code> command.
        Username:
          allOf:
          - $ref: '#/components/schemas/Username'
          - description: The name of the user.
        Password:
          allOf:
          - $ref: '#/components/schemas/Password'
          - description: The user password.
        RetryOptions:
          allOf:
          - $ref: '#/components/schemas/RedshiftRetryOptions'
          - description: The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
        S3Configuration:
          allOf:
          - $ref: '#/components/schemas/S3DestinationConfiguration'
          - description: <p>The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for <a>CreateDeliveryStream</a>.</p> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <code>RedshiftDestinationConfiguration.S3Configuration</code> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't support these compression formats.</p>
        ProcessingConfiguration:
          allOf:
          - $ref: '#/components/schemas/ProcessingConfiguration'
          - description: The data processing configuration.
        S3BackupMode:
          allOf:
          - $ref: '#/components/schemas/RedshiftS3BackupMode'
          - description: 'The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can''t update the delivery stream to disable it. '
        S3BackupConfiguration:
          allOf:
          - $ref: '#/components/schemas/S3DestinationConfiguration'
          - description: The configuration for backup in Amazon S3.
        CloudWatchLoggingOptions:
          allOf:
          - $ref: '#/components/schemas/CloudWatchLoggingOptions'
          - description: The CloudWatch logging options for your delivery stream.
      description: Describes the configuration of a destination in Amazon Redshift.
    HttpEndpointUrl:
      type: string
      pattern: https://.*
      minLength: 1
      maxLength: 1000
      format: password
    HiveJsonSerDe:
      type: object
      properties:
        TimestampFormats:
          allOf:
          - $ref: '#/components/schemas/ListOfNonEmptyStrings'
          - description: Indicates how you want Kinesis Data Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see <a href="https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html">Class DateTimeFormat</a>. You can also use the special value <code>millis</code> to parse timestamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses <code>java.sql.Timestamp::valueOf</code> by default.
      description: The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
    DataTableName:
      type: string
      pattern: .*
      minLength: 1
      maxLength: 512
    VpcConfiguration:
      type: object
      required:
      - SubnetIds
      - RoleARN
      - SecurityGroupIds
      properties:
        SubnetIds:
          allOf:
          - $ref: '#/components/schemas/SubnetIdList'
          - description: <p>The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.</p> <p>The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis">Network Interfaces </a> in the Amazon VPC Quotas topic.</p>
        RoleARN:
          allOf:
          - $ref: '#/components/schemas/RoleARN'
          - description: <p>The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:</p> <ul> <li> <p> <code>ec2:DescribeVpcs</code> </p> </li> <li> <p> <code>ec2:DescribeVpcAttribute</code> </p> </li> <li> <p> <code>ec2:DescribeSubnets</code> </p> </li> <li> <p> <code>ec2:DescribeSecurityGroups</code> </p> </li> <li> <p> <code>ec2:DescribeNetworkInterfaces</code> </p> </li> <li> <p> <code>ec2:CreateNetworkInterface</code> </p> </li> <li> <p> <code>ec2:CreateNetworkInterfacePermission</code> </p> </li> <li> <p> <code>ec2:DeleteNetworkInterface</code> </p> </li> </ul> <p>If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.</p>
        SecurityGroupIds:
          allOf:
          - $ref: '#/components/schemas/SecurityGroupIdList'
          - description: The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules">Security group rules</a> in the Amazon VPC documentation.
      description: The details of the VPC of the Amazon ES destination.
    ElasticsearchRetryOptions:
      type: object
      properties:
        DurationInSeconds:
          allOf:
          - $ref: '#/components/schemas/ElasticsearchRetryDurationInSeconds'
          - description: After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
      description: Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.
    ElasticsearchIndexRotationPeriod:
      type: string
      enum:
      - NoRotation
      - OneHour
      - OneDay
      - OneWeek
      - OneMonth
    OrcRowIndexStride:
      type: integer
      minimum: 1000
    ElasticsearchDomainARN:
      type: string
      pattern: arn:.*
      minLength: 1
      maxLength: 512
    HECToken:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 2048
    SubnetIdList:
      type: array
      items:
        $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
      minItems: 1
      maxItems: 16
    CopyCommand:
      type: object
      required:
      - DataTableName
      properties:
        DataTableName:
          allOf:
          - $ref: '#/components/schemas/DataTableName'
          - description: The name of the target table. The table must already exist in the database.
        DataTableColumns:
          allOf:
          - $ref: '#/components/schemas/DataTableColumns'
          - description: A comma-separated list of column names.
        CopyOptions:
          allOf:
          - $ref: '#/components/schemas/CopyOptions'
          - description: <p>Optional parameters to use with the Amazon Redshift <code>COPY</code> command. For more information, see the "Optional Parameters" section of <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html">Amazon Redshift COPY command</a>. Some possible examples that would apply to Kinesis Data Firehose are as follows:</p> <p> <code>delimiter '\t' lzop;</code> - fields are delimited with "\t" (TAB character) and compressed using lzop.</p> <p> <code>delimiter '|'</code> - fields are delimited with "|" (this is the default delimiter).</p> <p> <code>delimiter '|' escape</code> - the delimiter should be escaped.</p> <p> <code>fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'</code> - fields are fixed width in the source, with each width specified after every column in the table.</p> <p> <code>JSON 's3://mybucket/jsonpaths.txt'</code> - data is in JSON format, and the path specified is the format of the data.</p> <p>For more examples, see <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html">Amazon Redshift COPY command examples</a>.</p>
      description: Describes a <code>COPY</code> command for Amazon Redshift.
    AmazonopensearchserviceRetryOptions:
      type: object
      properties:
        DurationInSeconds:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceRetryDurationInSeconds'
          - description: 'After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries. '
      description: 'Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. '
    HECEndpointType:
      type: string
      enum:
      - Raw
      - Event
    SplunkRetryOptions:
      type: object
      properties:
        DurationInSeconds:
          allOf:
          - $ref: '#/components/schemas/SplunkRetryDurationInSeconds'
          - description: The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt.
      description: Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.
    ProcessorParameterName:
      type: string
      enum:
      - LambdaArn
      - NumberOfRetries
      - MetadataExtractionQuery
      - JsonParsingEngine
      - RoleArn
      - BufferSizeInMBs
      - BufferIntervalInSeconds
      - SubRecordType
      - Delimiter
    DeliveryStreamARN:
      type: string
      pattern: arn:.*
      minLength: 1
      maxLength: 512
    HttpEndpointS3BackupMode:
      type: string
      enum:
      - FailedDataOnly
      - AllData
    KMSEncryptionConfig:
      type: object
      required:
      - AWSKMSKeyARN
      properties:
        AWSKMSKeyARN:
          allOf:
          - $ref: '#/components/schemas/AWSKMSKeyARN'
          - description: The Amazon Resource Name (ARN) of the encryption key. Must belong to the same Amazon Web Services Region as the destination Amazon S3 bucket. 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>.
      description: Describes an encryption key for a destination in Amazon S3.
    RetryDurationInSeconds:
      type: integer
      minimum: 0
      maximum: 7200
    HttpEndpointAttributeName:
      type: string
      pattern: ^(?!\s*$).+
      minLength: 1
      maxLength: 256
      format: password
    AmazonopensearchserviceS3BackupMode:
      type: string
      enum:
      - FailedDocumentsOnly
      - AllDocuments
    Password:
      type: string
      pattern: .*
      minLength: 6
      maxLength: 512
      format: password
    LogStreamName:
      type: string
      pattern: '[^:*]*'
      minLength: 0
      maxLength: 512
    ParquetPageSizeBytes:
      type: integer
      minimum: 65536
    HECAcknowledgmentTimeoutInSeconds:
      type: integer
      minimum: 180
      maximum: 600
    RedshiftRetryOptions:
      type: object
      properties:
        DurationInSeconds:
          allOf:
          - $ref: '#/components/schemas/RedshiftRetryDurationInSeconds'
          - description: The length of time during which Kinesis Data Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Kinesis Data Firehose does not retry if the value of <code>DurationInSeconds</code> is 0 (zero) or if the first delivery attempt takes longer than the current value.
      description: Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.
    ElasticsearchClusterEndpoint:
      type: string
      pattern: https:.*
      minLength: 1
      maxLength: 512
    HttpEndpointConfiguration:
      type: object
      required:
      - Url
      properties:
        Url:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointUrl'
          - description: <p>The URL of the HTTP endpoint selected as the destination.</p> <important> <p>If you choose an HTTP endpoint as your destination, review and follow the instructions in the <a href="https://docs.aws.amazon.com/firehose/latest/dev/httpdeliveryrequestresponse.html">Appendix - HTTP Endpoint Delivery Request and Response Specifications</a>.</p> </important>
        Name:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointName'
          - description: The name of the HTTP endpoint selected as the destination.
        AccessKey:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointAccessKey'
          - description: The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.
      description: Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.
    AmazonOpenSearchServerlessBufferingSizeInMBs:
      type: integer
      minimum: 1
      maximum: 100
    ProcessingConfiguration:
      type: object
      properties:
        Enabled:
          allOf:
          - $ref: '#/components/schemas/BooleanObject'
          - description: Enables or disables data processing.
        Processors:
          allOf:
          - $ref: '#/components/schemas/ProcessorList'
          - description: The data processors.
      description: Describes a data processing configuration.
    Prefix:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 1024
    AWSKMSKeyARN:
      type: string
      pattern: arn:.*
      minLength: 1
      maxLength: 512
    CreateDeliveryStreamOutput:
      type: object
      properties:
        DeliveryStreamARN:
          allOf:
          - $ref: '#/components/schemas/DeliveryStreamARN'
          - description: The ARN of the delivery stream.
    OpenXJsonSerDe:
      type: object
      properties:
        ConvertDotsInJsonKeysToUnderscores:
          allOf:
          - $ref: '#/components/schemas/BooleanObject'
          - description: <p>When set to <code>true</code>, specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option.</p> <p>The default is <code>false</code>.</p>
        CaseInsensitive:
          allOf:
          - $ref: '#/components/schemas/BooleanObject'
          - description: When set to <code>true</code>, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
        ColumnToJsonKeyMappings:
          allOf:
          - $ref: '#/components/schemas/ColumnToJsonKeyMappings'
          - description: 'Maps column names to JSON keys that aren''t identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, <code>timestamp</code> is a Hive keyword. If you have a JSON key named <code>timestamp</code>, set this parameter to <code>{"ts": "timestamp"}</code> to map this key to a column named <code>ts</code>.'
      description: The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.
    ElasticsearchBufferingIntervalInSeconds:
      type: integer
      minimum: 60
      maximum: 900
    RedshiftRetryDurationInSeconds:
      type: integer
      minimum: 0
      maximum: 7200
    ListOfNonEmptyStringsWithoutWhitespace:
      type: array
      items:
        $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
    EncryptionConfiguration:
      type: object
      properties:
        NoEncryptionConfig:
          allOf:
          - $ref: '#/components/schemas/NoEncryptionConfig'
          - description: Specifically override existing encryption information to ensure that no encryption is used.
        KMSEncryptionConfig:
          allOf:
          - $ref: '#/components/schemas/KMSEncryptionConfig'
          - description: The encryption key.
      description: Describes the encryption for a destination in Amazon S3.
    HttpEndpointRequestConfiguration:
      type: object
      properties:
        ContentEncoding:
          allOf:
          - $ref: '#/components/schemas/ContentEncoding'
          - description: Kinesis Data Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding">Content-Encoding</a> in MDN Web Docs, the official Mozilla documentation.
        CommonAttributes:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointCommonAttributesList'
          - description: Describes the metadata sent to the HTTP endpoint destination.
      description: The configuration of the HTTP endpoint request.
    SizeInMBs:
      type: integer
      minimum: 1
      maximum: 128
    TagValue:
      type: string
      pattern: ^[\p{L}\p{Z}\p{N}_.:\/=+\-@%]*$
      minLength: 0
      maxLength: 256
    HttpEndpointBufferingSizeInMBs:
      type: integer
      minimum: 1
      maximum: 64
    ClusterJDBCURL:
      type: string
      pattern: jdbc:(redshift|postgresql)://((?!-)[A-Za-z0-9-]{1,63}(?<!-)\.)+redshift\.([a-zA-Z0-9\.]+):\d{1,5}/[a-zA-Z0-9_$-]+
      minLength: 1
      maxLength: 512
    TagKey:
      type: string
      pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:\/=+\-@%]*$
      minLength: 1
      maxLength: 128
    ElasticsearchDestinationConfiguration:
      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 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 <code>DescribeDomain</code>, <code>DescribeDomains</code>, and <code>DescribeDomainConfig</code> after assuming the role specified in <b>RoleARN</b>. 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 run time.</p> <p>For Elasticsearch 7.x, don't specify a <code>TypeName</code>.</p>
        IndexRotationPeriod:
          allOf:
          - $ref: '#/components/schemas/ElasticsearchIndexRotationPeriod'
          - description: The Elasticsearch index rotation period. Index rotation appends a timestamp to the <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>. The default value is <code>OneDay</code>.
        BufferingHints:
          allOf:
          - $ref: '#/components/schemas/ElasticsearchBufferingHints'
          - description: The buffering options. If no value is specified, the default values for <code>ElasticsearchBufferingHints</code> 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).
        S3BackupMode:
          allOf:
          - $ref: '#/components/schemas/ElasticsearchS3BackupMode'
          - description: <p>Defines how documents should be delivered to Amazon S3. When it is set to <code>FailedDocumentsOnly</code>, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with <code>AmazonOpenSearchService-failed/</code> appended to the key prefix. When set to <code>AllDocuments</code>, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with <code>AmazonOpenSearchService-failed/</code> appended to the prefix. For more information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup">Amazon S3 Backup for the Amazon ES Destination</a>. Default value is <code>FailedDocumentsOnly</code>.</p> <p>You can't change this backup mode after you create the delivery stream. </p>
        S3Configuration:
          allOf:
          - $ref: '#/components/schemas/S3DestinationConfiguration'
          - description: The configuration for the backup Amazon S3 location.
        ProcessingConfiguration:
          allOf:
          - $ref: '#/components/schemas/ProcessingConfiguration'
          - description: The data processing configuration.
        CloudWatchLoggingOptions:
          allOf:
          - $ref: '#/components/schemas/CloudWatchLoggingOptions'
          - description: The Amazon CloudWatch logging options for your delivery stream.
        VpcConfiguration:
          allOf:
          - $ref: '#/components/schemas/VpcConfiguration'
          - description: The details of the VPC of the Amazon ES destination.
      description: Describes the configuration of a destination in Amazon ES.
    NonEmptyStringWithoutWhitespace:
      type: string
      pattern: ^\S+$
      minLength: 1
      maxLength: 1024
    ElasticsearchBufferingHints:
      type: object
      properties:
        IntervalInSeconds:
          allOf:
          - $ref: '#/components/schemas/ElasticsearchBufferingIntervalInSeconds'
          - description: Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
        SizeInMBs:
          allOf:
          - $ref: '#/components/schemas/ElasticsearchBufferingSizeInMBs'
          - description: <p>Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.</p> <p>We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.</p>
      description: Describes the buffering to perform before delivering data to the Amazon ES destination.
    Tag:
      type: object
      required:
      - Key
      properties:
        Key:
          allOf:
          - $ref: '#/components/schemas/TagKey'
          - description: 'A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @'
        Value:
          allOf:
          - $ref: '#/components/schemas/TagValue'
          - description: 'An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @'
      description: Metadata that you can assign to a delivery stream, consisting of a key-value pair.
    Serializer:
      type: object
      properties:
        ParquetSerDe:
          allOf:
          - $ref: '#/components/schemas/ParquetSerDe'
          - description: A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see <a href="https://parquet.apache.org/documentation/latest/">Apache Parquet</a>.
        OrcSerDe:
          allOf:
          - $ref: '#/components/schemas/OrcSerDe'
          - description: A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see <a href="https://orc.apache.org/docs/">Apache ORC</a>.
      description: 'The serializer that you want Kinesis Data Firehose to use to convert data to the target format before writing it to Amazon S3. Kinesis Data Firehose supports two types of serializers: the <a href="https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.html">ORC SerDe</a> and the <a href="https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/parquet/serde/ParquetHiveSerDe.html">Parquet SerDe</a>.'
    ErrorOutputPrefix:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 1024
    DeliveryStreamEncryptionConfigurationInput:
      type: object
      required:
      - KeyType
      properties:
        KeyARN:
          allOf:
          - $ref: '#/components/schemas/AWSKMSKeyARN'
          - description: If you set <code>KeyType</code> to <code>CUSTOMER_MANAGED_CMK</code>, you must specify the Amazon Resource Name (ARN) of the CMK. If you set <code>KeyType</code> to <code>Amazon Web Services_OWNED_CMK</code>, Kinesis Data Firehose uses a service-account CMK.
        KeyType:
          allOf:
          - $ref: '#/components/schemas/KeyType'
          - description: <p>Indicates the type of customer master key (CMK) to use for encryption. The default setting is <code>Amazon Web Services_OWNED_CMK</code>. For more information about CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">Customer Master Keys (CMKs)</a>. When you invoke <a>CreateDeliveryStream</a> or <a>StartDeliveryStreamEncryption</a> with <code>KeyType</code> set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html">CreateGrant</a> to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant. </p> <p>When you invoke <a>StartDeliveryStreamEncryption</a> to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.</p> <p>You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a <a>CreateDeliveryStream</a> or <a>StartDeliveryStreamEncryption</a> operation exceeds this limit, Kinesis Data Firehose throws a <code>LimitExceededException</code>. </p> <important> <p>To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html">About Symmetric and Asymmetric CMKs</a> in the Amazon Web Services Key Management Service developer guide.</p> </important>
      description: 'Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE). '
    ColumnToJsonKeyMappings:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/NonEmptyString'
    KinesisStreamARN:
      type: string
      pattern: arn:.*
      minLength: 1
      maxLength: 512
    DataFormatConversionConfiguration:
      type: object
      properties:
        SchemaConfiguration:
          allOf:
          - $ref: '#/components/schemas/SchemaConfiguration'
          - description: Specifies the Amazon Web Services Glue Data Catalog table that contains the column information. This parameter is required if <code>Enabled</code> is set to true.
        InputFormatConfiguration:
          allOf:
          - $ref: '#/components/schemas/InputFormatConfiguration'
          - description: Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON. This parameter is required if <code>Enabled</code> is set to true.
        OutputFormatConfiguration:
          allOf:
          - $ref: '#/components/schemas/OutputFormatConfiguration'
          - description: Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if <code>Enabled</code> is set to true.
        Enabled:
          allOf:
          - $ref: '#/components/schemas/BooleanObject'
          - description: Defaults to <code>true</code>. Set it to <code>false</code> if you want to disable format conversion while preserving the configuration details.
      description: Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the Amazon Web Services Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html">Kinesis Data Firehose Record Format Conversion</a>.
    ProcessorList:
      type: array
      items:
        $ref: '#/components/schemas/Processor'
    SchemaConfiguration:
      type: object
      properties:
        RoleARN:
          allOf:
          - $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
          - description: <p>The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.</p> <important> <p>If the <code>SchemaConfiguration</code> request parameter is used as part of invoking the <code>CreateDeliveryStream</code> API, then the <code>RoleARN</code> property is required and its value must be specified.</p> </important>
        CatalogId:
          allOf:
          - $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
          - description: The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.
        DatabaseName:
          allOf:
          - $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
          - description: <p>Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.</p> <important> <p>If the <code>SchemaConfiguration</code> request parameter is used as part of invoking the <code>CreateDeliveryStream</code> API, then the <code>DatabaseName</code> property is required and its value must be specified.</p> </important>
        TableName:
          allOf:
          - $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
          - description: <p>Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.</p> <important> <p>If the <code>SchemaConfiguration</code> request parameter is used as part of invoking the <code>CreateDeliveryStream</code> API, then the <code>TableName</code> property is required and its value must be specified.</p> </important>
        Region:
          allOf:
          - $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
          - description: If you don't specify an Amazon Web Services Region, the default is the current Region.
        VersionId:
          allOf:
          - $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
          - description: Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to <code>LATEST</code>, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.
      description: Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. This parameter is required if <code>Enabled</code> is set to true.
    IntervalInSeconds:
      type: integer
      minimum: 60
      maximum: 900
    Username:
      type: string
      pattern: .*
      minLength: 1
      maxLength: 512
      format: password
    DataTableColumns:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 204800
    HttpEndpointAttributeValue:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 1024
      format: password
    RoleARN:
      type: string
      pattern: arn:.*
      minLength: 1
      maxLength: 512
    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.
    SecurityGroupIdList:
      type: array
      items:
        $ref: '#/components/schemas/NonEmptyStringWithoutWhitespace'
      minItems: 1
      maxItems: 5
    HttpEndpointRetryOptions:
      type: object
      properties:
        DurationInSeconds:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointRetryDurationInSeconds'
          - description: 'The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to the custom destination via HTTPS endpoint fails. It doesn''t include the periods during which Kinesis Data Firehose waits for acknowledgment from the specified destination after each attempt. '
      description: Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
    ResourceInUseException: {}
    AmazonOpenSearchServerlessRetryOptions:
      type: object
      properties:
        DurationInSeconds:
          allOf:
          - $ref: '#/components/schemas/AmazonOpenSearchServerlessRetryDurationInSeconds'
          - description: After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
      description: Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
    AmazonOpenSearchServerlessRetryDurationInSeconds:
      type: integer
      minimum: 0
      maximum: 7200
    AmazonopensearchserviceDestinationConfiguration:
      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 Amazon OpenSearch Service Configuration API and for indexing documents.
        DomainARN:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceDomainARN'
          - description: 'The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN. '
        ClusterEndpoint:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceClusterEndpoint'
          - description: 'The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field. '
        IndexName:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceIndexName'
          - description: The ElasticsearAmazon OpenSearch Service index name.
        TypeName:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceTypeName'
          - description: 'The Amazon OpenSearch Service 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 run time. '
        IndexRotationPeriod:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceIndexRotationPeriod'
          - description: The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
        BufferingHints:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceBufferingHints'
          - description: 'The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used. '
        RetryOptions:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceRetryOptions'
          - description: 'The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes). '
        S3BackupMode:
          allOf:
          - $ref: '#/components/schemas/AmazonopensearchserviceS3BackupMode'
          - 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 Amazon OpenSearch Service
    ExtendedS3DestinationConfiguration:
      type: object
      required:
      - RoleARN
      - BucketARN
      properties:
        RoleARN:
          allOf:
          - $ref: '#/components/schemas/RoleARN'
          - description: The Amazon Resource Name (ARN) of the Amazon Web Services credentials. 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>.
        BucketARN:
          allOf:
          - $ref: '#/components/schemas/BucketARN'
          - description: The ARN of the S3 bucket. 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>.
        Prefix:
          allOf:
          - $ref: '#/components/schemas/Prefix'
          - description: The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3 Objects</a>.
        ErrorOutputPrefix:
          allOf:
          - $ref: '#/components/schemas/ErrorOutputPrefix'
          - description: A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3 Objects</a>.
        BufferingHints:
          allOf:
          - $ref: '#/components/schemas/BufferingHints'
          - description: The buffering option.
        CompressionFormat:
          allOf:
          - $ref: '#/components/schemas/CompressionFormat'
          - description: The compression format. If no value is specified, the default is UNCOMPRESSED.
        EncryptionConfiguration:
          allOf:
          - $ref: '#/components/schemas/EncryptionConfiguration'
          - description: The encryption configuration. If no value is specified, the default is no encryption.
        CloudWatchLoggingOptions:
          allOf:
          - $ref: '#/components/schemas/CloudWatchLoggingOptions'
          - description: The Amazon CloudWatch logging options for your delivery stream.
        ProcessingConfiguration:
          allOf:
          - $ref: '#/components/schemas/ProcessingConfiguration'
          - description: The data processing configuration.
        S3BackupMode:
          allOf:
          - $ref: '#/components/schemas/S3BackupMode'
          - description: 'The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can''t update the delivery stream to disable it. '
        S3BackupConfiguration:
          allOf:
          - $ref: '#/components/schemas/S3DestinationConfiguration'
          - description: The configuration for backup in Amazon S3.
        DataFormatConversionConfiguration:
          allOf:
          - $ref: '#/components/schemas/DataFormatConversionConfiguration'
          - description: The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
        DynamicPartitioningConfiguration:
          allOf:
          - $ref: '#/components/schemas/DynamicPartitioningConfiguration'
          - description: 'The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations. '
      description: Describes the configuration of a destination in Amazon S3.
    RetryOptions:
      type: object
      properties:
        DurationInSeconds:
          allOf:
          - $ref: '#/components/schemas/RetryDurationInSeconds'
          - description: The period of time during which Kinesis Data Firehose retries to deliver data to the specified Amazon S3 prefix.
      description: ' The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.'
    ListOfNonEmptyStrings:
      type: array
      items:
        $ref: '#/components/schemas/NonEmptyString'
    AmazonopensearchserviceIndexName:
      type: string
      pattern: .*
      minLength: 1
      maxLength: 80
    KinesisStreamSourceConfiguration:
      type: object
      required:
      - KinesisStreamARN
      - RoleARN
      properties:
        KinesisStreamARN:
          allOf:
          - $ref: '#/components/schemas/KinesisStreamARN'
          - description: The ARN of the source Kinesis data stream. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon Kinesis Data Streams ARN Format</a>.
        RoleARN:
          allOf:
          - $ref: '#/components/schemas/RoleARN'
          - description: The ARN of the role that provides access to the source Kinesis data stream. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">Amazon Web Services Identity and Access Management (IAM) ARN Format</a>.
      description: The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a delivery stream.
    Proportion:
      type: number
      format: double
      minimum: 0
      maximum: 1
    DeliveryStreamName:
      type: string
      pattern: '[a-zA-Z0-9_.-]+'
      minLength: 1
      maxLength: 64
    ElasticsearchRetryDurationInSeconds:
      type: integer
      minimum: 0
      maximum: 7200
    ParquetSerDe:
      type: object
      properties:
        BlockSizeBytes:
          allOf:
          - $ref: '#/components/schemas/BlockSizeBytes'
          - description: The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.
        PageSizeBytes:
          allOf:
          - $ref: '#/components/schemas/ParquetPageSizeBytes'
          - description: The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.
        Compression:
          allOf:
          - $ref: '#/components/schemas/ParquetCompression'
          - description: The compression code to use over data blocks. The possible values are <code>UNCOMPRESSED</code>, <code>SNAPPY</code>, and <code>GZIP</code>, with the default being <code>SNAPPY</code>. Use <code>SNAPPY</code> for higher decompression speed. Use <code>GZIP</code> if the compression ratio is more important than speed.
        EnableDictionaryCompression:
          allOf:
          - $ref: '#/components/schemas/BooleanObject'
          - description: Indicates whether to enable dictionary compression.
        MaxPaddingBytes:
          allOf:
          - $ref: '#/components/schemas/NonNegativeIntegerObject'
          - description: The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.
        WriterVersion:
          allOf:
          - $ref: '#/components/schemas/ParquetWriterVersion'
          - description: Indicates the version of row format to output. The possible values are <code>V1</code> and <code>V2</code>. The default is <code>V1</code>.
      description: A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see <a href="https://parquet.apache.org/documentation/latest/">Apache Parquet</a>.
    SplunkDestinationConfiguration:
      type: object
      required:
      - HECEndpoint
      - HECEndpointType
      - HECToken
      - S3Configuration
      properties:
        HECEndpoint:
          allOf:
          - $ref: '#/components/schemas/HECEndpoint'
          - description: The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
        HECEndpointType:
          allOf:
          - $ref: '#/components/schemas/HECEndpointType'
          - description: This type can be either "Raw" or "Event."
        HECToken:
          allOf:
          - $ref: '#/components/schemas/HECToken'
          - description: This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
        HECAcknowledgmentTimeoutInSeconds:
          allOf:
          - $ref: '#/components/schemas/HECAcknowledgmentTimeoutInSeconds'
          - description: The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.
        RetryOptions:
          allOf:
          - $ref: '#/components/schemas/SplunkRetryOptions'
          - description: The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.
        S3BackupMode:
          allOf:
          - $ref: '#/components/schemas/SplunkS3BackupMode'
          - description: <p>Defines how documents should be delivered to Amazon S3. When set to <code>FailedEventsOnly</code>, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to <code>AllEvents</code>, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is <code>FailedEventsOnly</code>.</p> <p>You can update this backup mode from <code>FailedEventsOnly</code> to <code>AllEvents</code>. You can't update it from <code>AllEvents</code> to <code>FailedEventsOnly</code>.</p>
        S3Configuration:
          allOf:
          - $ref: '#/components/schemas/S3DestinationConfiguration'
          - description: The configuration for the backup Amazon S3 location.
        ProcessingConfiguration:
          allOf:
          - $ref: '#/components/schemas/ProcessingConfiguration'
          - description: The data processing configuration.
        CloudWatchLoggingOptions:
          allOf:
          - $ref: '#/components/schemas/CloudWatchLoggingOptions'
          - description: The Amazon CloudWatch logging options for your delivery stream.
      description: Describes the configuration of a destination in Splunk.
    OrcSerDe:
      type: object
      properties:
        StripeSizeBytes:
          allOf:
          - $ref: '#/components/schemas/OrcStripeSizeBytes'
          - description: The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
        BlockSizeBytes:
          allOf:
          - $ref: '#/components/schemas/BlockSizeBytes'
          - description: The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.
        RowIndexStride:
          allOf:
          - $ref: '#/components/schemas/OrcRowIndexStride'
          - description: The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
        EnablePadding:
          allOf:
          - $ref: '#/components/schemas/BooleanObject'
          - description: Set this to <code>true</code> to indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is <code>false</code>.
        PaddingTolerance:
          allOf:
          - $ref: '#/components/schemas/Proportion'
          - description: <p>A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size.</p> <p>For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.</p> <p>Kinesis Data Firehose ignores this parameter when <a>OrcSerDe$EnablePadding</a> is <code>false</code>.</p>
        Compression:
          allOf:
          - $ref: '#/components/schemas/OrcCompression'
          - description: The compression code to use over data blocks. The default is <code>SNAPPY</code>.
        BloomFilterColumns:
          allOf:
          - $ref: '#/components/schemas/ListOfNonEmptyStringsWithoutWhitespace'
          - description: The column names for which you want Kinesis Data Firehose to create bloom filters. The default is <code>null</code>.
        BloomFilterFalsePositiveProbability:
          allOf:
          - $ref: '#/components/schemas/Proportion'
          - description: The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.
        DictionaryKeyThreshold:
          allOf:
          - $ref: '#/components/schemas/Proportion'
          - description: Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.
        FormatVersion:
          allOf:
          - $ref: '#/components/schemas/OrcFormatVersion'
          - description: The version of the file to write. The possible values are <code>V0_11</code> and <code>V0_12</code>. The default is <code>V0_12</code>.
      description: A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see <a href="https://orc.apache.org/docs/">Apache ORC</a>.
    ElasticsearchBufferingSizeInMBs:
      type: integer
      minimum: 1
      maximum: 100
    SplunkS3BackupMode:
      type: string
      enum:
      - FailedEventsOnly
      - AllEvents
    OrcFormatVersion:
      type: string
      enum:
      - V0_11
      - V0_12
    InvalidKMSResourceException: {}
    AmazonOpenSearchServerlessCollectionEndpoint:
      type: string
      pattern: https:.*
      minLength: 1
      maxLength: 512
    AmazonopensearchserviceDomainARN:
      type: string
      pattern: arn:.*
      minLength: 1
      maxLength: 512
    CompressionFormat:
      type: string
      enum:
      - UNCOMPRESSED
      - GZIP
      - ZIP
      - Snappy
      - HADOOP_SNAPPY
    AmazonopensearchserviceBufferingIntervalInSeconds:
      type: integer
      minimum: 60
      maximum: 900
    BucketARN:
      type: string
      pattern: arn:.*
      minLength: 1
      maxLength: 2048
    Deserializer:
      type: object
      properties:
        OpenXJsonSerDe:
          allOf:
          - $ref: '#/components/schemas/OpenXJsonSerDe'
          - description: The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.
        HiveJsonSerDe:
          allOf:
          - $ref: '#/components/schemas/HiveJsonSerDe'
          - description: The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
      description: 'The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON. Kinesis Data Firehose then serializes the data to its final format using the <a>Serializer</a>. Kinesis Data Firehose supports two types of deserializers: the <a href="https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-JSON">Apache Hive JSON SerDe</a> and the <a href="https://github.com/rcongiu/Hive-JSON-Serde">OpenX JSON SerDe</a>.'
    ElasticsearchIndexName:
      type: string
      pattern: .*
      minLength: 1
      maxLength: 80
    InvalidArgumentException: {}
    NonNegativeIntegerObject:
      type: integer
      minimum: 0
    NoEncryptionConfig:
      type: string
      enum:
      - NoEncryption
    HttpEndpointBufferingIntervalInSeconds:
      type: integer
      minimum: 60
      maximum: 900
    HttpEndpointName:
      type: string
      pattern: ^(?!\s*$).+
      minLength: 1
      maxLength: 256
    BooleanObject:
      type: boolean
    ProcessorParameterValue:
      type: string
      pattern: ^(?!\s*$).+
      minLength: 1
      maxLength: 5120
    ContentEncoding:
      type: string
      enum:
      - NONE
      - GZIP
    LimitExceededException: {}
    AmazonOpenSearchServerlessBufferingIntervalInSeconds:
      type: integer
      minimum: 60
      maximum: 900
    BufferingHints:
      type: object
      properties:
        SizeInMBs:
          allOf:
          - $ref: '#/components/schemas/SizeInMBs'
          - description: <p>Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for <code>IntervalInSeconds</code>, and vice versa.</p> <p>We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.</p>
        IntervalInSeconds:
          allOf:
          - $ref: '#/components/schemas/IntervalInSeconds'
          - description: Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for <code>SizeInMBs</code>, and vice versa.
      description: Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data Firehose might choose to use different values when it is optimal. The <code>SizeInMBs</code> and <code>IntervalInSeconds</code> parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.
    AmazonopensearchserviceClusterEndpoint:
      type: string
      pattern: https:.*
      minLength: 1
      maxLength: 512
    AmazonopensearchserviceIndexRotationPeriod:
      type: string
      enum:
      - NoRotation
      - OneHour
      - OneDay
      - OneWeek
      - OneMonth
    S3DestinationConfiguration:
      type: object
      required:
      - RoleARN
      - BucketARN
      properties:
        RoleARN:
          allOf:
          - $ref: '#/components/schemas/RoleARN'
          - description: The Amazon Resource Name (ARN) of the Amazon Web Services credentials. 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>.
        BucketARN:
          allOf:
          - $ref: '#/components/schemas/BucketARN'
          - description: The ARN of the S3 bucket. 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>.
        Prefix:
          allOf:
          - $ref: '#/components/schemas/Prefix'
          - description: The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3 Objects</a>.
        ErrorOutputPrefix:
          allOf:
          - $ref: '#/components/schemas/ErrorOutputPrefix'
          - description: A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3 Objects</a>.
        BufferingHints:
          allOf:
          - $ref: '#/components/schemas/BufferingHints'
          - description: The buffering option. If no value is specified, <code>BufferingHints</code> object default values are used.
        CompressionFormat:
          allOf:
          - $ref: '#/components/schemas/CompressionFormat'
          - description: <p>The compression format. If no value is specified, the default is <code>UNCOMPRESSED</code>.</p> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket.</p>
        EncryptionConfiguration:
          allOf:
          - $ref: '#/components/schemas/EncryptionConfiguration'
          - description: The encryption configuration. If no value is specified, the default is no encryption.
        CloudWatchLoggingOptions:
          allOf:
          - $ref: '#/components/schemas/CloudWatchLoggingOptions'
          - description: The CloudWatch logging options for your delivery stream.
      description: Describes the configuration of a destination in Amazon S3.
    AmazonopensearchserviceRetryDurationInSeconds:
      type: integer
      minimum: 0
      maximum: 7200
    AmazonOpenSearchServerlessS3BackupMode:
      type: string
      enum:
      - FailedDocumentsOnly
      - AllDocuments
    ElasticsearchTypeName:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 100
    BlockSizeBytes:
      type: integer
      minimum: 67108864
    ParquetCompression:
      type: string
      enum:
      - UNCOMPRESSED
      - GZIP
      - SNAPPY
    AmazonOpenSearchServerlessIndexName:
      type: string
      pattern: .*
      minLength: 1
      maxLength: 80
    SplunkRetryDurationInSeconds:
      type: integer
      minimum: 0
      maximum: 7200
    HttpEndpointDestinationConfiguration:
      type: object
      required:
      - EndpointConfiguration
      - S3Configuration
      properties:
        EndpointConfiguration:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointConfiguration'
          - description: The configuration of the HTTP endpoint selected as the destination.
        BufferingHints:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointBufferingHints'
          - description: 'The buffering options that can be used before data is delivered to the specified destination. Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. The <code>SizeInMBs</code> and <code>IntervalInSeconds</code> parameters are optional. However, if you specify a value for one of them, you must also provide a value for the other. '
        CloudWatchLoggingOptions:
          $ref: '#/components/schemas/CloudWatchLoggingOptions'
        RequestConfiguration:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointRequestConfiguration'
          - description: The configuration of the requeste sent to the HTTP endpoint specified as the destination.
        ProcessingConfiguration:
          $ref: '#/components/schemas/ProcessingConfiguration'
        RoleARN:
          allOf:
          - $ref: '#/components/schemas/RoleARN'
          - description: Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
        RetryOptions:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointRetryOptions'
          - description: Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
        S3BackupMode:
          allOf:
          - $ref: '#/components/schemas/HttpEndpointS3BackupMode'
          - description: Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination. You can back up all documents (<code>AllData</code>) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (<code>FailedDataOnly</code>).
        S3Configuration:
          $ref: '#/components/schemas/S3DestinationConfiguration'
      description: Describes the configuration of the HTTP endpoint destination.
    ParquetWriterVersion:
      type: string
      enum:
      - V1
      - V2
  parameters:
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/firehose/
x-hasEquivalentPaths: true