Class: AWS.Firehose

Inherits:
AWS.Service show all
Identifier:
firehose
API Version:
2015-08-04
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using Firehose

var firehose = new AWS.Firehose();
firehose.createDeliveryStream(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Firehose object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var firehose = new AWS.Firehose({apiVersion: '2015-08-04'});

You can also set the API version globally in AWS.config.apiVersions using the firehose service identifier:

AWS.config.apiVersions = {
  firehose: '2015-08-04',
  // other service API versions
};

var firehose = new AWS.Firehose();

Version:

  • 2015-08-04

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Firehose(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Firehose object

var firehose = new AWS.Firehose({apiVersion: '2015-08-04'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Firehose.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Firehose.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Firehose.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createDeliveryStream(params = {}, callback) ⇒ AWS.Request

Creates a Kinesis Data Firehose delivery stream.

By default, you can create up to 50 delivery streams per AWS Region.

This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream.

A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter.

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: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration.

When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints 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.

A few notes about Amazon Redshift as a destination:

  • An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter.

  • The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

  • 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 INSERT permissions.

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 Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.

Service Reference:

Examples:

Calling the createDeliveryStream operation

var params = {
  DeliveryStreamName: 'STRING_VALUE', /* required */
  DeliveryStreamType: DirectPut | KinesisStreamAsSource,
  ElasticsearchDestinationConfiguration: {
    DomainARN: 'STRING_VALUE', /* required */
    IndexName: 'STRING_VALUE', /* required */
    RoleARN: 'STRING_VALUE', /* required */
    S3Configuration: { /* required */
      BucketARN: 'STRING_VALUE', /* required */
      RoleARN: 'STRING_VALUE', /* required */
      BufferingHints: {
        IntervalInSeconds: 0,
        SizeInMBs: 0
      },
      CloudWatchLoggingOptions: {
        Enabled: true || false,
        LogGroupName: 'STRING_VALUE',
        LogStreamName: 'STRING_VALUE'
      },
      CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy,
      EncryptionConfiguration: {
        KMSEncryptionConfig: {
          AWSKMSKeyARN: 'STRING_VALUE' /* required */
        },
        NoEncryptionConfig: NoEncryption
      },
      Prefix: 'STRING_VALUE'
    },
    TypeName: 'STRING_VALUE', /* required */
    BufferingHints: {
      IntervalInSeconds: 0,
      SizeInMBs: 0
    },
    CloudWatchLoggingOptions: {
      Enabled: true || false,
      LogGroupName: 'STRING_VALUE',
      LogStreamName: 'STRING_VALUE'
    },
    IndexRotationPeriod: NoRotation | OneHour | OneDay | OneWeek | OneMonth,
    ProcessingConfiguration: {
      Enabled: true || false,
      Processors: [
        {
          Type: Lambda, /* required */
          Parameters: [
            {
              ParameterName: LambdaArn | NumberOfRetries | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds, /* required */
              ParameterValue: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    RetryOptions: {
      DurationInSeconds: 0
    },
    S3BackupMode: FailedDocumentsOnly | AllDocuments
  },
  ExtendedS3DestinationConfiguration: {
    BucketARN: 'STRING_VALUE', /* required */
    RoleARN: 'STRING_VALUE', /* required */
    BufferingHints: {
      IntervalInSeconds: 0,
      SizeInMBs: 0
    },
    CloudWatchLoggingOptions: {
      Enabled: true || false,
      LogGroupName: 'STRING_VALUE',
      LogStreamName: 'STRING_VALUE'
    },
    CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy,
    DataFormatConversionConfiguration: {
      Enabled: true || false,
      InputFormatConfiguration: {
        Deserializer: {
          HiveJsonSerDe: {
            TimestampFormats: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          OpenXJsonSerDe: {
            CaseInsensitive: true || false,
            ColumnToJsonKeyMappings: {
              '<NonEmptyStringWithoutWhitespace>': 'STRING_VALUE',
              /* '<NonEmptyStringWithoutWhitespace>': ... */
            },
            ConvertDotsInJsonKeysToUnderscores: true || false
          }
        }
      },
      OutputFormatConfiguration: {
        Serializer: {
          OrcSerDe: {
            BlockSizeBytes: 0,
            BloomFilterColumns: [
              'STRING_VALUE',
              /* more items */
            ],
            BloomFilterFalsePositiveProbability: 0.0,
            Compression: NONE | ZLIB | SNAPPY,
            DictionaryKeyThreshold: 0.0,
            EnablePadding: true || false,
            FormatVersion: V0_11 | V0_12,
            PaddingTolerance: 0.0,
            RowIndexStride: 0,
            StripeSizeBytes: 0
          },
          ParquetSerDe: {
            BlockSizeBytes: 0,
            Compression: UNCOMPRESSED | GZIP | SNAPPY,
            EnableDictionaryCompression: true || false,
            MaxPaddingBytes: 0,
            PageSizeBytes: 0,
            WriterVersion: V1 | V2
          }
        }
      },
      SchemaConfiguration: {
        CatalogId: 'STRING_VALUE',
        DatabaseName: 'STRING_VALUE',
        Region: 'STRING_VALUE',
        RoleARN: 'STRING_VALUE',
        TableName: 'STRING_VALUE',
        VersionId: 'STRING_VALUE'
      }
    },
    EncryptionConfiguration: {
      KMSEncryptionConfig: {
        AWSKMSKeyARN: 'STRING_VALUE' /* required */
      },
      NoEncryptionConfig: NoEncryption
    },
    Prefix: 'STRING_VALUE',
    ProcessingConfiguration: {
      Enabled: true || false,
      Processors: [
        {
          Type: Lambda, /* required */
          Parameters: [
            {
              ParameterName: LambdaArn | NumberOfRetries | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds, /* required */
              ParameterValue: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    S3BackupConfiguration: {
      BucketARN: 'STRING_VALUE', /* required */
      RoleARN: 'STRING_VALUE', /* required */
      BufferingHints: {
        IntervalInSeconds: 0,
        SizeInMBs: 0
      },
      CloudWatchLoggingOptions: {
        Enabled: true || false,
        LogGroupName: 'STRING_VALUE',
        LogStreamName: 'STRING_VALUE'
      },
      CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy,
      EncryptionConfiguration: {
        KMSEncryptionConfig: {
          AWSKMSKeyARN: 'STRING_VALUE' /* required */
        },
        NoEncryptionConfig: NoEncryption
      },
      Prefix: 'STRING_VALUE'
    },
    S3BackupMode: Disabled | Enabled
  },
  KinesisStreamSourceConfiguration: {
    KinesisStreamARN: 'STRING_VALUE', /* required */
    RoleARN: 'STRING_VALUE' /* required */
  },
  RedshiftDestinationConfiguration: {
    ClusterJDBCURL: 'STRING_VALUE', /* required */
    CopyCommand: { /* required */
      DataTableName: 'STRING_VALUE', /* required */
      CopyOptions: 'STRING_VALUE',
      DataTableColumns: 'STRING_VALUE'
    },
    Password: 'STRING_VALUE', /* required */
    RoleARN: 'STRING_VALUE', /* required */
    S3Configuration: { /* required */
      BucketARN: 'STRING_VALUE', /* required */
      RoleARN: 'STRING_VALUE', /* required */
      BufferingHints: {
        IntervalInSeconds: 0,
        SizeInMBs: 0
      },
      CloudWatchLoggingOptions: {
        Enabled: true || false,
        LogGroupName: 'STRING_VALUE',
        LogStreamName: 'STRING_VALUE'
      },
      CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy,
      EncryptionConfiguration: {
        KMSEncryptionConfig: {
          AWSKMSKeyARN: 'STRING_VALUE' /* required */
        },
        NoEncryptionConfig: NoEncryption
      },
      Prefix: 'STRING_VALUE'
    },
    Username: 'STRING_VALUE', /* required */
    CloudWatchLoggingOptions: {
      Enabled: true || false,
      LogGroupName: 'STRING_VALUE',
      LogStreamName: 'STRING_VALUE'
    },
    ProcessingConfiguration: {
      Enabled: true || false,
      Processors: [
        {
          Type: Lambda, /* required */
          Parameters: [
            {
              ParameterName: LambdaArn | NumberOfRetries | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds, /* required */
              ParameterValue: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    RetryOptions: {
      DurationInSeconds: 0
    },
    S3BackupConfiguration: {
      BucketARN: 'STRING_VALUE', /* required */
      RoleARN: 'STRING_VALUE', /* required */
      BufferingHints: {
        IntervalInSeconds: 0,
        SizeInMBs: 0
      },
      CloudWatchLoggingOptions: {
        Enabled: true || false,
        LogGroupName: 'STRING_VALUE',
        LogStreamName: 'STRING_VALUE'
      },
      CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy,
      EncryptionConfiguration: {
        KMSEncryptionConfig: {
          AWSKMSKeyARN: 'STRING_VALUE' /* required */
        },
        NoEncryptionConfig: NoEncryption
      },
      Prefix: 'STRING_VALUE'
    },
    S3BackupMode: Disabled | Enabled
  },
  S3DestinationConfiguration: {
    BucketARN: 'STRING_VALUE', /* required */
    RoleARN: 'STRING_VALUE', /* required */
    BufferingHints: {
      IntervalInSeconds: 0,
      SizeInMBs: 0
    },
    CloudWatchLoggingOptions: {
      Enabled: true || false,
      LogGroupName: 'STRING_VALUE',
      LogStreamName: 'STRING_VALUE'
    },
    CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy,
    EncryptionConfiguration: {
      KMSEncryptionConfig: {
        AWSKMSKeyARN: 'STRING_VALUE' /* required */
      },
      NoEncryptionConfig: NoEncryption
    },
    Prefix: 'STRING_VALUE'
  },
  SplunkDestinationConfiguration: {
    HECEndpoint: 'STRING_VALUE', /* required */
    HECEndpointType: Raw | Event, /* required */
    HECToken: 'STRING_VALUE', /* required */
    S3Configuration: { /* required */
      BucketARN: 'STRING_VALUE', /* required */
      RoleARN: 'STRING_VALUE', /* required */
      BufferingHints: {
        IntervalInSeconds: 0,
        SizeInMBs: 0
      },
      CloudWatchLoggingOptions: {
        Enabled: true || false,
        LogGroupName: 'STRING_VALUE',
        LogStreamName: 'STRING_VALUE'
      },
      CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy,
      EncryptionConfiguration: {
        KMSEncryptionConfig: {
          AWSKMSKeyARN: 'STRING_VALUE' /* required */
        },
        NoEncryptionConfig: NoEncryption
      },
      Prefix: 'STRING_VALUE'
    },
    CloudWatchLoggingOptions: {
      Enabled: true || false,
      LogGroupName: 'STRING_VALUE',
      LogStreamName: 'STRING_VALUE'
    },
    HECAcknowledgmentTimeoutInSeconds: 0,
    ProcessingConfiguration: {
      Enabled: true || false,
      Processors: [
        {
          Type: Lambda, /* required */
          Parameters: [
            {
              ParameterName: LambdaArn | NumberOfRetries | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds, /* required */
              ParameterValue: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    RetryOptions: {
      DurationInSeconds: 0
    },
    S3BackupMode: FailedEventsOnly | AllEvents
  }
};
firehose.createDeliveryStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeliveryStreamName — (String)

      The name of the delivery stream. This name must be unique per AWS account in the same AWS Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.

    • DeliveryStreamType — (String)

      The delivery stream type. This parameter can be one of the following values:

      • DirectPut: Provider applications access the delivery stream directly.

      • KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

      Possible values include:
      • "DirectPut"
      • "KinesisStreamAsSource"
    • KinesisStreamSourceConfiguration — (map)

      When a Kinesis data stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.

    • S3DestinationConfiguration — (map)

      [Deprecated] The destination in Amazon S3. You can specify only one destination.

      • RoleARNrequired — (String)

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

      • BucketARNrequired — (String)

        The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

      • Prefix — (String)

        The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

      • BufferingHints — (map)

        The buffering option. If no value is specified, BufferingHints object default values are used.

        • SizeInMBs — (Integer)

          Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

          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.

        • IntervalInSeconds — (Integer)

          Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

      • CompressionFormat — (String)

        The compression format. If no value is specified, the default is UNCOMPRESSED.

        The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

        Possible values include:
        • "UNCOMPRESSED"
        • "GZIP"
        • "ZIP"
        • "Snappy"
      • EncryptionConfiguration — (map)

        The encryption configuration. If no value is specified, the default is no encryption.

        • NoEncryptionConfig — (String)

          Specifically override existing encryption information to ensure that no encryption is used.

          Possible values include:
          • "NoEncryption"
        • KMSEncryptionConfig — (map)

          The encryption key.

      • CloudWatchLoggingOptions — (map)

        The CloudWatch logging options for your delivery stream.

        • Enabled — (Boolean)

          Enables or disables CloudWatch logging.

        • LogGroupName — (String)

          The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

        • LogStreamName — (String)

          The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

    • ExtendedS3DestinationConfiguration — (map)

      The destination in Amazon S3. You can specify only one destination.

      • RoleARNrequired — (String)

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

      • BucketARNrequired — (String)

        The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

      • Prefix — (String)

        The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

      • BufferingHints — (map)

        The buffering option.

        • SizeInMBs — (Integer)

          Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

          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.

        • IntervalInSeconds — (Integer)

          Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

      • CompressionFormat — (String)

        The compression format. If no value is specified, the default is UNCOMPRESSED.

        Possible values include:
        • "UNCOMPRESSED"
        • "GZIP"
        • "ZIP"
        • "Snappy"
      • EncryptionConfiguration — (map)

        The encryption configuration. If no value is specified, the default is no encryption.

        • NoEncryptionConfig — (String)

          Specifically override existing encryption information to ensure that no encryption is used.

          Possible values include:
          • "NoEncryption"
        • KMSEncryptionConfig — (map)

          The encryption key.

      • CloudWatchLoggingOptions — (map)

        The Amazon CloudWatch logging options for your delivery stream.

        • Enabled — (Boolean)

          Enables or disables CloudWatch logging.

        • LogGroupName — (String)

          The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

        • LogStreamName — (String)

          The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

      • ProcessingConfiguration — (map)

        The data processing configuration.

        • Enabled — (Boolean)

          Enables or disables data processing.

        • Processors — (Array<map>)

          The data processors.

          • Typerequired — (String)

            The type of processor.

            Possible values include:
            • "Lambda"
          • Parameters — (Array<map>)

            The processor parameters.

            • ParameterNamerequired — (String)

              The name of the parameter.

              Possible values include:
              • "LambdaArn"
              • "NumberOfRetries"
              • "RoleArn"
              • "BufferSizeInMBs"
              • "BufferIntervalInSeconds"
            • ParameterValuerequired — (String)

              The parameter value.

      • S3BackupMode — (String)

        The Amazon S3 backup mode.

        Possible values include:
        • "Disabled"
        • "Enabled"
      • S3BackupConfiguration — (map)

        The configuration for backup in Amazon S3.

        • RoleARNrequired — (String)

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

        • BucketARNrequired — (String)

          The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

        • Prefix — (String)

          The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

        • BufferingHints — (map)

          The buffering option. If no value is specified, BufferingHints object default values are used.

          • SizeInMBs — (Integer)

            Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

            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.

          • IntervalInSeconds — (Integer)

            Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

        • CompressionFormat — (String)

          The compression format. If no value is specified, the default is UNCOMPRESSED.

          The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

          Possible values include:
          • "UNCOMPRESSED"
          • "GZIP"
          • "ZIP"
          • "Snappy"
        • EncryptionConfiguration — (map)

          The encryption configuration. If no value is specified, the default is no encryption.

          • NoEncryptionConfig — (String)

            Specifically override existing encryption information to ensure that no encryption is used.

            Possible values include:
            • "NoEncryption"
          • KMSEncryptionConfig — (map)

            The encryption key.

        • CloudWatchLoggingOptions — (map)

          The CloudWatch logging options for your delivery stream.

          • Enabled — (Boolean)

            Enables or disables CloudWatch logging.

          • LogGroupName — (String)

            The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

          • LogStreamName — (String)

            The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

      • DataFormatConversionConfiguration — (map)

        The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

        • SchemaConfiguration — (map)

          Specifies the AWS Glue Data Catalog table that contains the column information.

          • RoleARN — (String)

            The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

          • CatalogId — (String)

            The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.

          • DatabaseName — (String)

            Specifies the name of the AWS Glue database that contains the schema for the output data.

          • TableName — (String)

            Specifies the AWS Glue table that contains the column information that constitutes your data schema.

          • Region — (String)

            If you don't specify an AWS Region, the default is the current Region.

          • VersionId — (String)

            Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

        • InputFormatConfiguration — (map)

          Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON.

          • Deserializer — (map)

            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.

            • OpenXJsonSerDe — (map)

              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.

              • ConvertDotsInJsonKeysToUnderscores — (Boolean)

                When set to true, 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.

                The default is false.

              • CaseInsensitive — (Boolean)

                When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.

              • ColumnToJsonKeyMappings — (map<String>)

                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, timestamp is a Hive keyword. If you have a JSON key named timestamp, set this parameter to {"ts": "timestamp"} to map this key to a column named ts.

            • HiveJsonSerDe — (map)

              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.

              • TimestampFormats — (Array<String>)

                Indicates how you want Kinesis Data Firehose to parse the date and time stamps 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 Class DateTimeFormat. You can also use the special value millis to parse time stamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.

        • OutputFormatConfiguration — (map)

          Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format.

          • Serializer — (map)

            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.

            • ParquetSerDe — (map)

              A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.

              • BlockSizeBytes — (Integer)

                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 — (Integer)

                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 — (String)

                The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ration is more important than speed.

                Possible values include:
                • "UNCOMPRESSED"
                • "GZIP"
                • "SNAPPY"
              • EnableDictionaryCompression — (Boolean)

                Indicates whether to enable dictionary compression.

              • MaxPaddingBytes — (Integer)

                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 — (String)

                Indicates the version of row format to output. The possible values are V1 and V2. The default is V1.

                Possible values include:
                • "V1"
                • "V2"
            • OrcSerDe — (map)

              A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.

              • StripeSizeBytes — (Integer)

                The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.

              • BlockSizeBytes — (Integer)

                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 — (Integer)

                The number of rows between index entries. The default is 10,000 and the minimum is 1,000.

              • EnablePadding — (Boolean)

                Set this to true 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 false.

              • PaddingTolerance — (Float)

                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.

                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.

                Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding is false.

              • Compression — (String)

                The compression code to use over data blocks. The default is SNAPPY.

                Possible values include:
                • "NONE"
                • "ZLIB"
                • "SNAPPY"
              • BloomFilterColumns — (Array<String>)

                The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.

              • BloomFilterFalsePositiveProbability — (Float)

                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 — (Float)

                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 — (String)

                The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.

                Possible values include:
                • "V0_11"
                • "V0_12"
        • Enabled — (Boolean)

          Defaults to true. Set it to false if you want to disable format conversion while preserving the configuration details.

    • RedshiftDestinationConfiguration — (map)

      The destination in Amazon Redshift. You can specify only one destination.

      • RoleARNrequired — (String)

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

      • ClusterJDBCURLrequired — (String)

        The database connection string.

      • CopyCommandrequired — (map)

        The COPY command.

        • DataTableNamerequired — (String)

          The name of the target table. The table must already exist in the database.

        • DataTableColumns — (String)

          A comma-separated list of column names.

        • CopyOptions — (String)

          Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Kinesis Data Firehose are as follows:

          delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.

          delimiter '|' - fields are delimited with "|" (this is the default delimiter).

          delimiter '|' escape - the delimiter should be escaped.

          fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

          JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

          For more examples, see Amazon Redshift COPY command examples.

      • Usernamerequired — (String)

        The name of the user.

      • Passwordrequired — (String)

        The user password.

      • RetryOptions — (map)

        The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

        • DurationInSeconds — (Integer)

          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 DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.

      • S3Configurationrequired — (map)

        The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.

        The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

        • RoleARNrequired — (String)

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

        • BucketARNrequired — (String)

          The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

        • Prefix — (String)

          The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

        • BufferingHints — (map)

          The buffering option. If no value is specified, BufferingHints object default values are used.

          • SizeInMBs — (Integer)

            Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

            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.

          • IntervalInSeconds — (Integer)

            Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

        • CompressionFormat — (String)

          The compression format. If no value is specified, the default is UNCOMPRESSED.

          The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

          Possible values include:
          • "UNCOMPRESSED"
          • "GZIP"
          • "ZIP"
          • "Snappy"
        • EncryptionConfiguration — (map)

          The encryption configuration. If no value is specified, the default is no encryption.

          • NoEncryptionConfig — (String)

            Specifically override existing encryption information to ensure that no encryption is used.

            Possible values include:
            • "NoEncryption"
          • KMSEncryptionConfig — (map)

            The encryption key.

        • CloudWatchLoggingOptions — (map)

          The CloudWatch logging options for your delivery stream.

          • Enabled — (Boolean)

            Enables or disables CloudWatch logging.

          • LogGroupName — (String)

            The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

          • LogStreamName — (String)

            The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

      • ProcessingConfiguration — (map)

        The data processing configuration.

        • Enabled — (Boolean)

          Enables or disables data processing.

        • Processors — (Array<map>)

          The data processors.

          • Typerequired — (String)

            The type of processor.

            Possible values include:
            • "Lambda"
          • Parameters — (Array<map>)

            The processor parameters.

            • ParameterNamerequired — (String)

              The name of the parameter.

              Possible values include:
              • "LambdaArn"
              • "NumberOfRetries"
              • "RoleArn"
              • "BufferSizeInMBs"
              • "BufferIntervalInSeconds"
            • ParameterValuerequired — (String)

              The parameter value.

      • S3BackupMode — (String)

        The Amazon S3 backup mode.

        Possible values include:
        • "Disabled"
        • "Enabled"
      • S3BackupConfiguration — (map)

        The configuration for backup in Amazon S3.

        • RoleARNrequired — (String)

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

        • BucketARNrequired — (String)

          The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

        • Prefix — (String)

          The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

        • BufferingHints — (map)

          The buffering option. If no value is specified, BufferingHints object default values are used.

          • SizeInMBs — (Integer)

            Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

            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.

          • IntervalInSeconds — (Integer)

            Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

        • CompressionFormat — (String)

          The compression format. If no value is specified, the default is UNCOMPRESSED.

          The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

          Possible values include:
          • "UNCOMPRESSED"
          • "GZIP"
          • "ZIP"
          • "Snappy"
        • EncryptionConfiguration — (map)

          The encryption configuration. If no value is specified, the default is no encryption.

          • NoEncryptionConfig — (String)

            Specifically override existing encryption information to ensure that no encryption is used.

            Possible values include:
            • "NoEncryption"
          • KMSEncryptionConfig — (map)

            The encryption key.

        • CloudWatchLoggingOptions — (map)

          The CloudWatch logging options for your delivery stream.

          • Enabled — (Boolean)

            Enables or disables CloudWatch logging.

          • LogGroupName — (String)

            The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

          • LogStreamName — (String)

            The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

      • CloudWatchLoggingOptions — (map)

        The CloudWatch logging options for your delivery stream.

        • Enabled — (Boolean)

          Enables or disables CloudWatch logging.

        • LogGroupName — (String)

          The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

        • LogStreamName — (String)

          The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

    • ElasticsearchDestinationConfiguration — (map)

      The destination in Amazon ES. You can specify only one destination.

      • RoleARNrequired — (String)

        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 Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.

      • DomainARNrequired — (String)

        The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

      • IndexNamerequired — (String)

        The Elasticsearch index name.

      • TypeNamerequired — (String)

        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.

      • IndexRotationPeriod — (String)

        The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.

        Possible values include:
        • "NoRotation"
        • "OneHour"
        • "OneDay"
        • "OneWeek"
        • "OneMonth"
      • BufferingHints — (map)

        The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

        • IntervalInSeconds — (Integer)

          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 — (Integer)

          Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

          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.

      • RetryOptions — (map)

        The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

        • DurationInSeconds — (Integer)

          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.

      • S3BackupMode — (String)

        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 elasticsearch-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 elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.

        Possible values include:
        • "FailedDocumentsOnly"
        • "AllDocuments"
      • S3Configurationrequired — (map)

        The configuration for the backup Amazon S3 location.

        • RoleARNrequired — (String)

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

        • BucketARNrequired — (String)

          The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

        • Prefix — (String)

          The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

        • BufferingHints — (map)

          The buffering option. If no value is specified, BufferingHints object default values are used.

          • SizeInMBs — (Integer)

            Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

            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.

          • IntervalInSeconds — (Integer)

            Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

        • CompressionFormat — (String)

          The compression format. If no value is specified, the default is UNCOMPRESSED.

          The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

          Possible values include:
          • "UNCOMPRESSED"
          • "GZIP"
          • "ZIP"
          • "Snappy"
        • EncryptionConfiguration — (map)

          The encryption configuration. If no value is specified, the default is no encryption.

          • NoEncryptionConfig — (String)

            Specifically override existing encryption information to ensure that no encryption is used.

            Possible values include:
            • "NoEncryption"
          • KMSEncryptionConfig — (map)

            The encryption key.

        • CloudWatchLoggingOptions — (map)

          The CloudWatch logging options for your delivery stream.

          • Enabled — (Boolean)

            Enables or disables CloudWatch logging.

          • LogGroupName — (String)

            The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

          • LogStreamName — (String)

            The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

      • ProcessingConfiguration — (map)

        The data processing configuration.

        • Enabled — (Boolean)

          Enables or disables data processing.

        • Processors — (Array<map>)

          The data processors.

          • Typerequired — (String)

            The type of processor.

            Possible values include:
            • "Lambda"
          • Parameters — (Array<map>)

            The processor parameters.

            • ParameterNamerequired — (String)

              The name of the parameter.

              Possible values include:
              • "LambdaArn"
              • "NumberOfRetries"
              • "RoleArn"
              • "BufferSizeInMBs"
              • "BufferIntervalInSeconds"
            • ParameterValuerequired — (String)

              The parameter value.

      • CloudWatchLoggingOptions — (map)

        The Amazon CloudWatch logging options for your delivery stream.

        • Enabled — (Boolean)

          Enables or disables CloudWatch logging.

        • LogGroupName — (String)

          The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

        • LogStreamName — (String)

          The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

    • SplunkDestinationConfiguration — (map)

      The destination in Splunk. You can specify only one destination.

      • HECEndpointrequired — (String)

        The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

      • HECEndpointTyperequired — (String)

        This type can be either "Raw" or "Event."

        Possible values include:
        • "Raw"
        • "Event"
      • HECTokenrequired — (String)

        This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

      • HECAcknowledgmentTimeoutInSeconds — (Integer)

        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 — (map)

        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.

        • DurationInSeconds — (Integer)

          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.

      • S3BackupMode — (String)

        Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

        Possible values include:
        • "FailedEventsOnly"
        • "AllEvents"
      • S3Configurationrequired — (map)

        The configuration for the backup Amazon S3 location.

        • RoleARNrequired — (String)

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

        • BucketARNrequired — (String)

          The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

        • Prefix — (String)

          The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

        • BufferingHints — (map)

          The buffering option. If no value is specified, BufferingHints object default values are used.

          • SizeInMBs — (Integer)

            Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

            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.

          • IntervalInSeconds — (Integer)

            Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

        • CompressionFormat — (String)

          The compression format. If no value is specified, the default is UNCOMPRESSED.

          The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

          Possible values include:
          • "UNCOMPRESSED"
          • "GZIP"
          • "ZIP"
          • "Snappy"
        • EncryptionConfiguration — (map)

          The encryption configuration. If no value is specified, the default is no encryption.

          • NoEncryptionConfig — (String)

            Specifically override existing encryption information to ensure that no encryption is used.

            Possible values include:
            • "NoEncryption"
          • KMSEncryptionConfig — (map)

            The encryption key.

        • CloudWatchLoggingOptions — (map)

          The CloudWatch logging options for your delivery stream.

          • Enabled — (Boolean)

            Enables or disables CloudWatch logging.

          • LogGroupName — (String)

            The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

          • LogStreamName — (String)

            The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

      • ProcessingConfiguration — (map)

        The data processing configuration.

        • Enabled — (Boolean)

          Enables or disables data processing.

        • Processors — (Array<map>)

          The data processors.

          • Typerequired — (String)

            The type of processor.

            Possible values include:
            • "Lambda"
          • Parameters — (Array<map>)

            The processor parameters.

            • ParameterNamerequired — (String)

              The name of the parameter.

              Possible values include:
              • "LambdaArn"
              • "NumberOfRetries"
              • "RoleArn"
              • "BufferSizeInMBs"
              • "BufferIntervalInSeconds"
            • ParameterValuerequired — (String)

              The parameter value.

      • CloudWatchLoggingOptions — (map)

        The Amazon CloudWatch logging options for your delivery stream.

        • Enabled — (Boolean)

          Enables or disables CloudWatch logging.

        • LogGroupName — (String)

          The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

        • LogStreamName — (String)

          The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeliveryStreamARN — (String)

        The ARN of the delivery stream.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDeliveryStream(params = {}, callback) ⇒ AWS.Request

Deletes a delivery stream and its data.

You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state.

To check the state of a delivery stream, use DescribeDeliveryStream.

While the delivery stream is DELETING state, the service might continue to accept the records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.

Service Reference:

Examples:

Calling the deleteDeliveryStream operation

var params = {
  DeliveryStreamName: 'STRING_VALUE' /* required */
};
firehose.deleteDeliveryStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeliveryStreamName — (String)

      The name of the delivery stream.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDeliveryStream(params = {}, callback) ⇒ AWS.Request

Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call DescribeDeliveryStream to see whether the delivery stream is ACTIVE and therefore ready for data to be sent to it.

Service Reference:

Examples:

Calling the describeDeliveryStream operation

var params = {
  DeliveryStreamName: 'STRING_VALUE', /* required */
  ExclusiveStartDestinationId: 'STRING_VALUE',
  Limit: 0
};
firehose.describeDeliveryStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeliveryStreamName — (String)

      The name of the delivery stream.

    • Limit — (Integer)

      The limit on the number of destinations to return. You can have one destination per delivery stream.

    • ExclusiveStartDestinationId — (String)

      The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one destination per delivery stream.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeliveryStreamDescription — (map)

        Information about the delivery stream.

        • DeliveryStreamNamerequired — (String)

          The name of the delivery stream.

        • DeliveryStreamARNrequired — (String)

          The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

        • DeliveryStreamStatusrequired — (String)

          The status of the delivery stream.

          Possible values include:
          • "CREATING"
          • "DELETING"
          • "ACTIVE"
        • DeliveryStreamTyperequired — (String)

          The delivery stream type. This can be one of the following values:

          • DirectPut: Provider applications access the delivery stream directly.

          • KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

          Possible values include:
          • "DirectPut"
          • "KinesisStreamAsSource"
        • VersionIdrequired — (String)

          Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.

        • CreateTimestamp — (Date)

          The date and time that the delivery stream was created.

        • LastUpdateTimestamp — (Date)

          The date and time that the delivery stream was last updated.

        • Source — (map)

          If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.

        • Destinationsrequired — (Array<map>)

          The destinations.

          • DestinationIdrequired — (String)

            The ID of the destination.

          • S3DestinationDescription — (map)

            [Deprecated] The destination in Amazon S3.

            • RoleARNrequired — (String)

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

            • BucketARNrequired — (String)

              The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

            • Prefix — (String)

              The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

            • BufferingHintsrequired — (map)

              The buffering option. If no value is specified, BufferingHints object default values are used.

              • SizeInMBs — (Integer)

                Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

                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.

              • IntervalInSeconds — (Integer)

                Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

            • CompressionFormatrequired — (String)

              The compression format. If no value is specified, the default is UNCOMPRESSED.

              Possible values include:
              • "UNCOMPRESSED"
              • "GZIP"
              • "ZIP"
              • "Snappy"
            • EncryptionConfigurationrequired — (map)

              The encryption configuration. If no value is specified, the default is no encryption.

              • NoEncryptionConfig — (String)

                Specifically override existing encryption information to ensure that no encryption is used.

                Possible values include:
                • "NoEncryption"
              • KMSEncryptionConfig — (map)

                The encryption key.

            • CloudWatchLoggingOptions — (map)

              The Amazon CloudWatch logging options for your delivery stream.

              • Enabled — (Boolean)

                Enables or disables CloudWatch logging.

              • LogGroupName — (String)

                The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

              • LogStreamName — (String)

                The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

          • ExtendedS3DestinationDescription — (map)

            The destination in Amazon S3.

            • RoleARNrequired — (String)

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

            • BucketARNrequired — (String)

              The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

            • Prefix — (String)

              The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

            • BufferingHintsrequired — (map)

              The buffering option.

              • SizeInMBs — (Integer)

                Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

                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.

              • IntervalInSeconds — (Integer)

                Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

            • CompressionFormatrequired — (String)

              The compression format. If no value is specified, the default is UNCOMPRESSED.

              Possible values include:
              • "UNCOMPRESSED"
              • "GZIP"
              • "ZIP"
              • "Snappy"
            • EncryptionConfigurationrequired — (map)

              The encryption configuration. If no value is specified, the default is no encryption.

              • NoEncryptionConfig — (String)

                Specifically override existing encryption information to ensure that no encryption is used.

                Possible values include:
                • "NoEncryption"
              • KMSEncryptionConfig — (map)

                The encryption key.

            • CloudWatchLoggingOptions — (map)

              The Amazon CloudWatch logging options for your delivery stream.

              • Enabled — (Boolean)

                Enables or disables CloudWatch logging.

              • LogGroupName — (String)

                The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

              • LogStreamName — (String)

                The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

            • ProcessingConfiguration — (map)

              The data processing configuration.

              • Enabled — (Boolean)

                Enables or disables data processing.

              • Processors — (Array<map>)

                The data processors.

                • Typerequired — (String)

                  The type of processor.

                  Possible values include:
                  • "Lambda"
                • Parameters — (Array<map>)

                  The processor parameters.

                  • ParameterNamerequired — (String)

                    The name of the parameter.

                    Possible values include:
                    • "LambdaArn"
                    • "NumberOfRetries"
                    • "RoleArn"
                    • "BufferSizeInMBs"
                    • "BufferIntervalInSeconds"
                  • ParameterValuerequired — (String)

                    The parameter value.

            • S3BackupMode — (String)

              The Amazon S3 backup mode.

              Possible values include:
              • "Disabled"
              • "Enabled"
            • S3BackupDescription — (map)

              The configuration for backup in Amazon S3.

              • RoleARNrequired — (String)

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

              • BucketARNrequired — (String)

                The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

              • Prefix — (String)

                The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

              • BufferingHintsrequired — (map)

                The buffering option. If no value is specified, BufferingHints object default values are used.

                • SizeInMBs — (Integer)

                  Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

                  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.

                • IntervalInSeconds — (Integer)

                  Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

              • CompressionFormatrequired — (String)

                The compression format. If no value is specified, the default is UNCOMPRESSED.

                Possible values include:
                • "UNCOMPRESSED"
                • "GZIP"
                • "ZIP"
                • "Snappy"
              • EncryptionConfigurationrequired — (map)

                The encryption configuration. If no value is specified, the default is no encryption.

                • NoEncryptionConfig — (String)

                  Specifically override existing encryption information to ensure that no encryption is used.

                  Possible values include:
                  • "NoEncryption"
                • KMSEncryptionConfig — (map)

                  The encryption key.

              • CloudWatchLoggingOptions — (map)

                The Amazon CloudWatch logging options for your delivery stream.

                • Enabled — (Boolean)

                  Enables or disables CloudWatch logging.

                • LogGroupName — (String)

                  The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

                • LogStreamName — (String)

                  The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

            • DataFormatConversionConfiguration — (map)

              The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

              • SchemaConfiguration — (map)

                Specifies the AWS Glue Data Catalog table that contains the column information.

                • RoleARN — (String)

                  The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

                • CatalogId — (String)

                  The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.

                • DatabaseName — (String)

                  Specifies the name of the AWS Glue database that contains the schema for the output data.

                • TableName — (String)

                  Specifies the AWS Glue table that contains the column information that constitutes your data schema.

                • Region — (String)

                  If you don't specify an AWS Region, the default is the current Region.

                • VersionId — (String)

                  Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

              • InputFormatConfiguration — (map)

                Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON.

                • Deserializer — (map)

                  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.

                  • OpenXJsonSerDe — (map)

                    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.

                    • ConvertDotsInJsonKeysToUnderscores — (Boolean)

                      When set to true, 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.

                      The default is false.

                    • CaseInsensitive — (Boolean)

                      When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.

                    • ColumnToJsonKeyMappings — (map<String>)

                      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, timestamp is a Hive keyword. If you have a JSON key named timestamp, set this parameter to {"ts": "timestamp"} to map this key to a column named ts.

                  • HiveJsonSerDe — (map)

                    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.

                    • TimestampFormats — (Array<String>)

                      Indicates how you want Kinesis Data Firehose to parse the date and time stamps 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 Class DateTimeFormat. You can also use the special value millis to parse time stamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.

              • OutputFormatConfiguration — (map)

                Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format.

                • Serializer — (map)

                  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.

                  • ParquetSerDe — (map)

                    A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.

                    • BlockSizeBytes — (Integer)

                      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 — (Integer)

                      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 — (String)

                      The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ration is more important than speed.

                      Possible values include:
                      • "UNCOMPRESSED"
                      • "GZIP"
                      • "SNAPPY"
                    • EnableDictionaryCompression — (Boolean)

                      Indicates whether to enable dictionary compression.

                    • MaxPaddingBytes — (Integer)

                      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 — (String)

                      Indicates the version of row format to output. The possible values are V1 and V2. The default is V1.

                      Possible values include:
                      • "V1"
                      • "V2"
                  • OrcSerDe — (map)

                    A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.

                    • StripeSizeBytes — (Integer)

                      The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.

                    • BlockSizeBytes — (Integer)

                      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 — (Integer)

                      The number of rows between index entries. The default is 10,000 and the minimum is 1,000.

                    • EnablePadding — (Boolean)

                      Set this to true 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 false.

                    • PaddingTolerance — (Float)

                      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.

                      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.

                      Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding is false.

                    • Compression — (String)

                      The compression code to use over data blocks. The default is SNAPPY.

                      Possible values include:
                      • "NONE"
                      • "ZLIB"
                      • "SNAPPY"
                    • BloomFilterColumns — (Array<String>)

                      The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.

                    • BloomFilterFalsePositiveProbability — (Float)

                      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 — (Float)

                      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 — (String)

                      The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.

                      Possible values include:
                      • "V0_11"
                      • "V0_12"
              • Enabled — (Boolean)

                Defaults to true. Set it to false if you want to disable format conversion while preserving the configuration details.

          • RedshiftDestinationDescription — (map)

            The destination in Amazon Redshift.

            • RoleARNrequired — (String)

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

            • ClusterJDBCURLrequired — (String)

              The database connection string.

            • CopyCommandrequired — (map)

              The COPY command.

              • DataTableNamerequired — (String)

                The name of the target table. The table must already exist in the database.

              • DataTableColumns — (String)

                A comma-separated list of column names.

              • CopyOptions — (String)

                Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Kinesis Data Firehose are as follows:

                delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.

                delimiter '|' - fields are delimited with "|" (this is the default delimiter).

                delimiter '|' escape - the delimiter should be escaped.

                fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

                JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

                For more examples, see Amazon Redshift COPY command examples.

            • Usernamerequired — (String)

              The name of the user.

            • RetryOptions — (map)

              The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

              • DurationInSeconds — (Integer)

                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 DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.

            • S3DestinationDescriptionrequired — (map)

              The Amazon S3 destination.

              • RoleARNrequired — (String)

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

              • BucketARNrequired — (String)

                The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

              • Prefix — (String)

                The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

              • BufferingHintsrequired — (map)

                The buffering option. If no value is specified, BufferingHints object default values are used.

                • SizeInMBs — (Integer)

                  Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

                  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.

                • IntervalInSeconds — (Integer)

                  Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

              • CompressionFormatrequired — (String)

                The compression format. If no value is specified, the default is UNCOMPRESSED.

                Possible values include:
                • "UNCOMPRESSED"
                • "GZIP"
                • "ZIP"
                • "Snappy"
              • EncryptionConfigurationrequired — (map)

                The encryption configuration. If no value is specified, the default is no encryption.

                • NoEncryptionConfig — (String)

                  Specifically override existing encryption information to ensure that no encryption is used.

                  Possible values include:
                  • "NoEncryption"
                • KMSEncryptionConfig — (map)

                  The encryption key.

              • CloudWatchLoggingOptions — (map)

                The Amazon CloudWatch logging options for your delivery stream.

                • Enabled — (Boolean)

                  Enables or disables CloudWatch logging.

                • LogGroupName — (String)

                  The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

                • LogStreamName — (String)

                  The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

            • ProcessingConfiguration — (map)

              The data processing configuration.

              • Enabled — (Boolean)

                Enables or disables data processing.

              • Processors — (Array<map>)

                The data processors.

                • Typerequired — (String)

                  The type of processor.

                  Possible values include:
                  • "Lambda"
                • Parameters — (Array<map>)

                  The processor parameters.

                  • ParameterNamerequired — (String)

                    The name of the parameter.

                    Possible values include:
                    • "LambdaArn"
                    • "NumberOfRetries"
                    • "RoleArn"
                    • "BufferSizeInMBs"
                    • "BufferIntervalInSeconds"
                  • ParameterValuerequired — (String)

                    The parameter value.

            • S3BackupMode — (String)

              The Amazon S3 backup mode.

              Possible values include:
              • "Disabled"
              • "Enabled"
            • S3BackupDescription — (map)

              The configuration for backup in Amazon S3.

              • RoleARNrequired — (String)

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

              • BucketARNrequired — (String)

                The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

              • Prefix — (String)

                The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

              • BufferingHintsrequired — (map)

                The buffering option. If no value is specified, BufferingHints object default values are used.

                • SizeInMBs — (Integer)

                  Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

                  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.

                • IntervalInSeconds — (Integer)

                  Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

              • CompressionFormatrequired — (String)

                The compression format. If no value is specified, the default is UNCOMPRESSED.

                Possible values include:
                • "UNCOMPRESSED"
                • "GZIP"
                • "ZIP"
                • "Snappy"
              • EncryptionConfigurationrequired — (map)

                The encryption configuration. If no value is specified, the default is no encryption.

                • NoEncryptionConfig — (String)

                  Specifically override existing encryption information to ensure that no encryption is used.

                  Possible values include:
                  • "NoEncryption"
                • KMSEncryptionConfig — (map)

                  The encryption key.

              • CloudWatchLoggingOptions — (map)

                The Amazon CloudWatch logging options for your delivery stream.

                • Enabled — (Boolean)

                  Enables or disables CloudWatch logging.

                • LogGroupName — (String)

                  The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

                • LogStreamName — (String)

                  The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

            • CloudWatchLoggingOptions — (map)

              The Amazon CloudWatch logging options for your delivery stream.

              • Enabled — (Boolean)

                Enables or disables CloudWatch logging.

              • LogGroupName — (String)

                The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

              • LogStreamName — (String)

                The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

          • ElasticsearchDestinationDescription — (map)

            The destination in Amazon ES.

            • RoleARN — (String)

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

            • DomainARN — (String)

              The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

            • IndexName — (String)

              The Elasticsearch index name.

            • TypeName — (String)

              The Elasticsearch type name.

            • IndexRotationPeriod — (String)

              The Elasticsearch index rotation period

              Possible values include:
              • "NoRotation"
              • "OneHour"
              • "OneDay"
              • "OneWeek"
              • "OneMonth"
            • BufferingHints — (map)

              The buffering options.

              • IntervalInSeconds — (Integer)

                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 — (Integer)

                Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

                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.

            • RetryOptions — (map)

              The Amazon ES retry options.

              • DurationInSeconds — (Integer)

                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.

            • S3BackupMode — (String)

              The Amazon S3 backup mode.

              Possible values include:
              • "FailedDocumentsOnly"
              • "AllDocuments"
            • S3DestinationDescription — (map)

              The Amazon S3 destination.

              • RoleARNrequired — (String)

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

              • BucketARNrequired — (String)

                The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

              • Prefix — (String)

                The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

              • BufferingHintsrequired — (map)

                The buffering option. If no value is specified, BufferingHints object default values are used.

                • SizeInMBs — (Integer)

                  Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

                  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.

                • IntervalInSeconds — (Integer)

                  Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

              • CompressionFormatrequired — (String)

                The compression format. If no value is specified, the default is UNCOMPRESSED.

                Possible values include:
                • "UNCOMPRESSED"
                • "GZIP"
                • "ZIP"
                • "Snappy"
              • EncryptionConfigurationrequired — (map)

                The encryption configuration. If no value is specified, the default is no encryption.

                • NoEncryptionConfig — (String)

                  Specifically override existing encryption information to ensure that no encryption is used.

                  Possible values include:
                  • "NoEncryption"
                • KMSEncryptionConfig — (map)

                  The encryption key.

              • CloudWatchLoggingOptions — (map)

                The Amazon CloudWatch logging options for your delivery stream.

                • Enabled — (Boolean)

                  Enables or disables CloudWatch logging.

                • LogGroupName — (String)

                  The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

                • LogStreamName — (String)

                  The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

            • ProcessingConfiguration — (map)

              The data processing configuration.

              • Enabled — (Boolean)

                Enables or disables data processing.

              • Processors — (Array<map>)

                The data processors.

                • Typerequired — (String)

                  The type of processor.

                  Possible values include:
                  • "Lambda"
                • Parameters — (Array<map>)

                  The processor parameters.

                  • ParameterNamerequired — (String)

                    The name of the parameter.

                    Possible values include:
                    • "LambdaArn"
                    • "NumberOfRetries"
                    • "RoleArn"
                    • "BufferSizeInMBs"
                    • "BufferIntervalInSeconds"
                  • ParameterValuerequired — (String)

                    The parameter value.

            • CloudWatchLoggingOptions — (map)

              The Amazon CloudWatch logging options.

              • Enabled — (Boolean)

                Enables or disables CloudWatch logging.

              • LogGroupName — (String)

                The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

              • LogStreamName — (String)

                The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

          • SplunkDestinationDescription — (map)

            The destination in Splunk.

            • HECEndpoint — (String)

              The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

            • HECEndpointType — (String)

              This type can be either "Raw" or "Event."

              Possible values include:
              • "Raw"
              • "Event"
            • HECToken — (String)

              A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.

            • HECAcknowledgmentTimeoutInSeconds — (Integer)

              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 — (map)

              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.

              • DurationInSeconds — (Integer)

                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.

            • S3BackupMode — (String)

              Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

              Possible values include:
              • "FailedEventsOnly"
              • "AllEvents"
            • S3DestinationDescription — (map)

              The Amazon S3 destination.>

              • RoleARNrequired — (String)

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

              • BucketARNrequired — (String)

                The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

              • Prefix — (String)

                The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

              • BufferingHintsrequired — (map)

                The buffering option. If no value is specified, BufferingHints object default values are used.

                • SizeInMBs — (Integer)

                  Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

                  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.

                • IntervalInSeconds — (Integer)

                  Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

              • CompressionFormatrequired — (String)

                The compression format. If no value is specified, the default is UNCOMPRESSED.

                Possible values include:
                • "UNCOMPRESSED"
                • "GZIP"
                • "ZIP"
                • "Snappy"
              • EncryptionConfigurationrequired — (map)

                The encryption configuration. If no value is specified, the default is no encryption.

                • NoEncryptionConfig — (String)

                  Specifically override existing encryption information to ensure that no encryption is used.

                  Possible values include:
                  • "NoEncryption"
                • KMSEncryptionConfig — (map)

                  The encryption key.

              • CloudWatchLoggingOptions — (map)

                The Amazon CloudWatch logging options for your delivery stream.

                • Enabled — (Boolean)

                  Enables or disables CloudWatch logging.

                • LogGroupName — (String)

                  The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

                • LogStreamName — (String)

                  The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

            • ProcessingConfiguration — (map)

              The data processing configuration.

              • Enabled — (Boolean)

                Enables or disables data processing.

              • Processors — (Array<map>)

                The data processors.

                • Typerequired — (String)

                  The type of processor.

                  Possible values include:
                  • "Lambda"
                • Parameters — (Array<map>)

                  The processor parameters.

                  • ParameterNamerequired — (String)

                    The name of the parameter.

                    Possible values include:
                    • "LambdaArn"
                    • "NumberOfRetries"
                    • "RoleArn"
                    • "BufferSizeInMBs"
                    • "BufferIntervalInSeconds"
                  • ParameterValuerequired — (String)

                    The parameter value.

            • CloudWatchLoggingOptions — (map)

              The Amazon CloudWatch logging options for your delivery stream.

              • Enabled — (Boolean)

                Enables or disables CloudWatch logging.

              • LogGroupName — (String)

                The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

              • LogStreamName — (String)

                The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

        • HasMoreDestinationsrequired — (Boolean)

          Indicates whether there are more destinations available to list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDeliveryStreams(params = {}, callback) ⇒ AWS.Request

Lists your delivery streams.

The number of delivery streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by specifying the name of the last delivery stream returned in the call in the ExclusiveStartDeliveryStreamName parameter of a subsequent call.

Service Reference:

Examples:

Calling the listDeliveryStreams operation

var params = {
  DeliveryStreamType: DirectPut | KinesisStreamAsSource,
  ExclusiveStartDeliveryStreamName: 'STRING_VALUE',
  Limit: 0
};
firehose.listDeliveryStreams(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Limit — (Integer)

      The maximum number of delivery streams to list. The default value is 10.

    • DeliveryStreamType — (String)

      The delivery stream type. This can be one of the following values:

      • DirectPut: Provider applications access the delivery stream directly.

      • KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

      This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.

      Possible values include:
      • "DirectPut"
      • "KinesisStreamAsSource"
    • ExclusiveStartDeliveryStreamName — (String)

      The name of the delivery stream to start the list with.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeliveryStreamNames — (Array<String>)

        The names of the delivery streams.

      • HasMoreDeliveryStreams — (Boolean)

        Indicates whether there are more delivery streams available to list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForDeliveryStream(params = {}, callback) ⇒ AWS.Request

Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account.

Service Reference:

Examples:

Calling the listTagsForDeliveryStream operation

var params = {
  DeliveryStreamName: 'STRING_VALUE', /* required */
  ExclusiveStartTagKey: 'STRING_VALUE',
  Limit: 0
};
firehose.listTagsForDeliveryStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeliveryStreamName — (String)

      The name of the delivery stream whose tags you want to list.

    • ExclusiveStartTagKey — (String)

      The key to use as the starting point for the list of tags. If you set this parameter, ListTagsForDeliveryStream gets all tags that occur after ExclusiveStartTagKey.

    • Limit — (Integer)

      The number of tags to return. If this number is less than the total number of tags associated with the delivery stream, HasMoreTags is set to true in the response. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        A list of tags associated with DeliveryStreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.

        • Keyrequired — (String)

          A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

        • Value — (String)

          An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

      • HasMoreTags — (Boolean)

        If this is true in the response, more tags are available. To list the remaining tags, set ExclusiveStartTagKey to the key of the last tag returned and call ListTagsForDeliveryStream again.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putRecord(params = {}, callback) ⇒ AWS.Request

Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers.

By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Data Firehose Limits.

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on.

Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.

The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.

If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.

Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.

Service Reference:

Examples:

Calling the putRecord operation

var params = {
  DeliveryStreamName: 'STRING_VALUE', /* required */
  Record: { /* required */
    Data: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */ /* required */
  }
};
firehose.putRecord(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeliveryStreamName — (String)

      The name of the delivery stream.

    • Record — (map)

      The record.

      • Datarequired — (Buffer, Typed Array, Blob, String)

        The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KB.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RecordId — (String)

        The ID of the record.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putRecordBatch(params = {}, callback) ⇒ AWS.Request

Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers.

By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see Amazon Kinesis Data Firehose Limits.

Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on.

Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.

The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Kinesis Data Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records.

A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailable or InternalFailure. ErrorMessage provides more detailed information about the error.

If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.

If PutRecordBatch throws ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.

Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.

Service Reference:

Examples:

Calling the putRecordBatch operation

var params = {
  DeliveryStreamName: 'STRING_VALUE', /* required */
  Records: [ /* required */
    {
      Data: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */ /* required */
    },
    /* more items */
  ]
};
firehose.putRecordBatch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeliveryStreamName — (String)

      The name of the delivery stream.

    • Records — (Array<map>)

      One or more records.

      • Datarequired — (Buffer, Typed Array, Blob, String)

        The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KB.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FailedPutCount — (Integer)

        The number of records that might have failed processing.

      • RequestResponses — (Array<map>)

        The results array. For each record, the index of the response element is the same as the index used in the request array.

        • RecordId — (String)

          The ID of the record.

        • ErrorCode — (String)

          The error code for an individual record result.

        • ErrorMessage — (String)

          The error message for an individual record result.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagDeliveryStream(params = {}, callback) ⇒ AWS.Request

Adds or updates tags for the specified delivery stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. 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 Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Each delivery stream can have up to 50 tags.

This operation has a limit of five transactions per second per account.

Service Reference:

Examples:

Calling the tagDeliveryStream operation

var params = {
  DeliveryStreamName: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
firehose.tagDeliveryStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeliveryStreamName — (String)

      The name of the delivery stream to which you want to add the tags.

    • Tags — (Array<map>)

      A set of key-value pairs to use to create the tags.

      • Keyrequired — (String)

        A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

      • Value — (String)

        An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagDeliveryStream(params = {}, callback) ⇒ AWS.Request

Removes tags from the specified delivery stream. Removed tags are deleted, and you can't recover them after this operation successfully completes.

If you specify a tag that doesn't exist, the operation ignores it.

This operation has a limit of five transactions per second per account.

Service Reference:

Examples:

Calling the untagDeliveryStream operation

var params = {
  DeliveryStreamName: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
firehose.untagDeliveryStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeliveryStreamName — (String)

      The name of the delivery stream.

    • TagKeys — (Array<String>)

      A list of tag keys. Each corresponding tag is removed from the delivery stream.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDestination(params = {}, callback) ⇒ AWS.Request

Updates the specified destination of the specified delivery stream.

Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.

Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.

If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination.

If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified.

Kinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.

Service Reference:

Examples:

Calling the updateDestination operation

var params = {
  CurrentDeliveryStreamVersionId: 'STRING_VALUE', /* required */
  DeliveryStreamName: 'STRING_VALUE', /* required */
  DestinationId: 'STRING_VALUE', /* required */
  ElasticsearchDestinationUpdate: {
    BufferingHints: {
      IntervalInSeconds: 0,
      SizeInMBs: 0
    },
    CloudWatchLoggingOptions: {
      Enabled: true || false,
      LogGroupName: 'STRING_VALUE',
      LogStreamName: 'STRING_VALUE'
    },
    DomainARN: 'STRING_VALUE',
    IndexName: 'STRING_VALUE',
    IndexRotationPeriod: NoRotation | OneHour | OneDay | OneWeek | OneMonth,
    ProcessingConfiguration: {
      Enabled: true || false,
      Processors: [
        {
          Type: Lambda, /* required */
          Parameters: [
            {
              ParameterName: LambdaArn | NumberOfRetries | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds, /* required */
              ParameterValue: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    RetryOptions: {
      DurationInSeconds: 0
    },
    RoleARN: 'STRING_VALUE',
    S3Update: {
      BucketARN: 'STRING_VALUE',
      BufferingHints: {
        IntervalInSeconds: 0,
        SizeInMBs: 0
      },
      CloudWatchLoggingOptions: {
        Enabled: true || false,
        LogGroupName: 'STRING_VALUE',
        LogStreamName: 'STRING_VALUE'
      },
      CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy,
      EncryptionConfiguration: {
        KMSEncryptionConfig: {
          AWSKMSKeyARN: 'STRING_VALUE' /* required */
        },
        NoEncryptionConfig: NoEncryption
      },
      Prefix: 'STRING_VALUE',
      RoleARN: 'STRING_VALUE'
    },
    TypeName: 'STRING_VALUE'
  },
  ExtendedS3DestinationUpdate: {
    BucketARN: 'STRING_VALUE',
    BufferingHints: {
      IntervalInSeconds: 0,
      SizeInMBs: 0
    },
    CloudWatchLoggingOptions: {
      Enabled: true || false,
      LogGroupName: 'STRING_VALUE',
      LogStreamName: 'STRING_VALUE'
    },
    CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy,
    DataFormatConversionConfiguration: {
      Enabled: true || false,
      InputFormatConfiguration: {
        Deserializer: {
          HiveJsonSerDe: {
            TimestampFormats: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          OpenXJsonSerDe: {
            CaseInsensitive: true || false,
            ColumnToJsonKeyMappings: {
              '<NonEmptyStringWithoutWhitespace>': 'STRING_VALUE',
              /* '<NonEmptyStringWithoutWhitespace>': ... */
            },
            ConvertDotsInJsonKeysToUnderscores: true || false
          }
        }
      },
      OutputFormatConfiguration: {
        Serializer: {
          OrcSerDe: {
            BlockSizeBytes: 0,
            BloomFilterColumns: [
              'STRING_VALUE',
              /* more items */
            ],
            BloomFilterFalsePositiveProbability: 0.0,
            Compression: NONE | ZLIB | SNAPPY,
            DictionaryKeyThreshold: 0.0,
            EnablePadding: true || false,
            FormatVersion: V0_11 | V0_12,
            PaddingTolerance: 0.0,
            RowIndexStride: 0,
            StripeSizeBytes: 0
          },
          ParquetSerDe: {
            BlockSizeBytes: 0,
            Compression: UNCOMPRESSED | GZIP | SNAPPY,
            EnableDictionaryCompression: true || false,
            MaxPaddingBytes: 0,
            PageSizeBytes: 0,
            WriterVersion: V1 | V2
          }
        }
      },
      SchemaConfiguration: {
        CatalogId: 'STRING_VALUE',
        DatabaseName: 'STRING_VALUE',
        Region: 'STRING_VALUE',
        RoleARN: 'STRING_VALUE',
        TableName: 'STRING_VALUE',
        VersionId: 'STRING_VALUE'
      }
    },
    EncryptionConfiguration: {
      KMSEncryptionConfig: {
        AWSKMSKeyARN: 'STRING_VALUE' /* required */
      },
      NoEncryptionConfig: NoEncryption
    },
    Prefix: 'STRING_VALUE',
    ProcessingConfiguration: {
      Enabled: true || false,
      Processors: [
        {
          Type: Lambda, /* required */
          Parameters: [
            {
              ParameterName: LambdaArn | NumberOfRetries | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds, /* required */
              ParameterValue: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    RoleARN: 'STRING_VALUE',
    S3BackupMode: Disabled | Enabled,
    S3BackupUpdate: {
      BucketARN: 'STRING_VALUE',
      BufferingHints: {
        IntervalInSeconds: 0,
        SizeInMBs: 0
      },
      CloudWatchLoggingOptions: {
        Enabled: true || false,
        LogGroupName: 'STRING_VALUE',
        LogStreamName: 'STRING_VALUE'
      },
      CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy,
      EncryptionConfiguration: {
        KMSEncryptionConfig: {
          AWSKMSKeyARN: 'STRING_VALUE' /* required */
        },
        NoEncryptionConfig: NoEncryption
      },
      Prefix: 'STRING_VALUE',
      RoleARN: 'STRING_VALUE'
    }
  },
  RedshiftDestinationUpdate: {
    CloudWatchLoggingOptions: {
      Enabled: true || false,
      LogGroupName: 'STRING_VALUE',
      LogStreamName: 'STRING_VALUE'
    },
    ClusterJDBCURL: 'STRING_VALUE',
    CopyCommand: {
      DataTableName: 'STRING_VALUE', /* required */
      CopyOptions: 'STRING_VALUE',
      DataTableColumns: 'STRING_VALUE'
    },
    Password: 'STRING_VALUE',
    ProcessingConfiguration: {
      Enabled: true || false,
      Processors: [
        {
          Type: Lambda, /* required */
          Parameters: [
            {
              ParameterName: LambdaArn | NumberOfRetries | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds, /* required */
              ParameterValue: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    RetryOptions: {
      DurationInSeconds: 0
    },
    RoleARN: 'STRING_VALUE',
    S3BackupMode: Disabled | Enabled,
    S3BackupUpdate: {
      BucketARN: 'STRING_VALUE',
      BufferingHints: {
        IntervalInSeconds: 0,
        SizeInMBs: 0
      },
      CloudWatchLoggingOptions: {
        Enabled: true || false,
        LogGroupName: 'STRING_VALUE',
        LogStreamName: 'STRING_VALUE'
      },
      CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy,
      EncryptionConfiguration: {
        KMSEncryptionConfig: {
          AWSKMSKeyARN: 'STRING_VALUE' /* required */
        },
        NoEncryptionConfig: NoEncryption
      },
      Prefix: 'STRING_VALUE',
      RoleARN: 'STRING_VALUE'
    },
    S3Update: {
      BucketARN: 'STRING_VALUE',
      BufferingHints: {
        IntervalInSeconds: 0,
        SizeInMBs: 0
      },
      CloudWatchLoggingOptions: {
        Enabled: true || false,
        LogGroupName: 'STRING_VALUE',
        LogStreamName: 'STRING_VALUE'
      },
      CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy,
      EncryptionConfiguration: {
        KMSEncryptionConfig: {
          AWSKMSKeyARN: 'STRING_VALUE' /* required */
        },
        NoEncryptionConfig: NoEncryption
      },
      Prefix: 'STRING_VALUE',
      RoleARN: 'STRING_VALUE'
    },
    Username: 'STRING_VALUE'
  },
  S3DestinationUpdate: {
    BucketARN: 'STRING_VALUE',
    BufferingHints: {
      IntervalInSeconds: 0,
      SizeInMBs: 0
    },
    CloudWatchLoggingOptions: {
      Enabled: true || false,
      LogGroupName: 'STRING_VALUE',
      LogStreamName: 'STRING_VALUE'
    },
    CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy,
    EncryptionConfiguration: {
      KMSEncryptionConfig: {
        AWSKMSKeyARN: 'STRING_VALUE' /* required */
      },
      NoEncryptionConfig: NoEncryption
    },
    Prefix: 'STRING_VALUE',
    RoleARN: 'STRING_VALUE'
  },
  SplunkDestinationUpdate: {
    CloudWatchLoggingOptions: {
      Enabled: true || false,
      LogGroupName: 'STRING_VALUE',
      LogStreamName: 'STRING_VALUE'
    },
    HECAcknowledgmentTimeoutInSeconds: 0,
    HECEndpoint: 'STRING_VALUE',
    HECEndpointType: Raw | Event,
    HECToken: 'STRING_VALUE',
    ProcessingConfiguration: {
      Enabled: true || false,
      Processors: [
        {
          Type: Lambda, /* required */
          Parameters: [
            {
              ParameterName: LambdaArn | NumberOfRetries | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds, /* required */
              ParameterValue: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    RetryOptions: {
      DurationInSeconds: 0
    },
    S3BackupMode: FailedEventsOnly | AllEvents,
    S3Update: {
      BucketARN: 'STRING_VALUE',
      BufferingHints: {
        IntervalInSeconds: 0,
        SizeInMBs: 0
      },
      CloudWatchLoggingOptions: {
        Enabled: true || false,
        LogGroupName: 'STRING_VALUE',
        LogStreamName: 'STRING_VALUE'
      },
      CompressionFormat: UNCOMPRESSED | GZIP | ZIP | Snappy,
      EncryptionConfiguration: {
        KMSEncryptionConfig: {
          AWSKMSKeyARN: 'STRING_VALUE' /* required */
        },
        NoEncryptionConfig: NoEncryption
      },
      Prefix: 'STRING_VALUE',
      RoleARN: 'STRING_VALUE'
    }
  }
};
firehose.updateDestination(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeliveryStreamName — (String)

      The name of the delivery stream.

    • CurrentDeliveryStreamVersionId — (String)

      Obtain this value from the VersionId result of DeliveryStreamDescription. This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the VersionId value is updated. The service then performs a merge of the old configuration with the new configuration.

    • DestinationId — (String)

      The ID of the destination.

    • S3DestinationUpdate — (map)

      [Deprecated] Describes an update for a destination in Amazon S3.

      • RoleARN — (String)

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

      • BucketARN — (String)

        The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

      • Prefix — (String)

        The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

      • BufferingHints — (map)

        The buffering option. If no value is specified, BufferingHints object default values are used.

        • SizeInMBs — (Integer)

          Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

          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.

        • IntervalInSeconds — (Integer)

          Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

      • CompressionFormat — (String)

        The compression format. If no value is specified, the default is UNCOMPRESSED.

        The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

        Possible values include:
        • "UNCOMPRESSED"
        • "GZIP"
        • "ZIP"
        • "Snappy"
      • EncryptionConfiguration — (map)

        The encryption configuration. If no value is specified, the default is no encryption.

        • NoEncryptionConfig — (String)

          Specifically override existing encryption information to ensure that no encryption is used.

          Possible values include:
          • "NoEncryption"
        • KMSEncryptionConfig — (map)

          The encryption key.

      • CloudWatchLoggingOptions — (map)

        The CloudWatch logging options for your delivery stream.

        • Enabled — (Boolean)

          Enables or disables CloudWatch logging.

        • LogGroupName — (String)

          The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

        • LogStreamName — (String)

          The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

    • ExtendedS3DestinationUpdate — (map)

      Describes an update for a destination in Amazon S3.

      • RoleARN — (String)

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

      • BucketARN — (String)

        The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

      • Prefix — (String)

        The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

      • BufferingHints — (map)

        The buffering option.

        • SizeInMBs — (Integer)

          Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

          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.

        • IntervalInSeconds — (Integer)

          Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

      • CompressionFormat — (String)

        The compression format. If no value is specified, the default is UNCOMPRESSED.

        Possible values include:
        • "UNCOMPRESSED"
        • "GZIP"
        • "ZIP"
        • "Snappy"
      • EncryptionConfiguration — (map)

        The encryption configuration. If no value is specified, the default is no encryption.

        • NoEncryptionConfig — (String)

          Specifically override existing encryption information to ensure that no encryption is used.

          Possible values include:
          • "NoEncryption"
        • KMSEncryptionConfig — (map)

          The encryption key.

      • CloudWatchLoggingOptions — (map)

        The Amazon CloudWatch logging options for your delivery stream.

        • Enabled — (Boolean)

          Enables or disables CloudWatch logging.

        • LogGroupName — (String)

          The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

        • LogStreamName — (String)

          The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

      • ProcessingConfiguration — (map)

        The data processing configuration.

        • Enabled — (Boolean)

          Enables or disables data processing.

        • Processors — (Array<map>)

          The data processors.

          • Typerequired — (String)

            The type of processor.

            Possible values include:
            • "Lambda"
          • Parameters — (Array<map>)

            The processor parameters.

            • ParameterNamerequired — (String)

              The name of the parameter.

              Possible values include:
              • "LambdaArn"
              • "NumberOfRetries"
              • "RoleArn"
              • "BufferSizeInMBs"
              • "BufferIntervalInSeconds"
            • ParameterValuerequired — (String)

              The parameter value.

      • S3BackupMode — (String)

        Enables or disables Amazon S3 backup mode.

        Possible values include:
        • "Disabled"
        • "Enabled"
      • S3BackupUpdate — (map)

        The Amazon S3 destination for backup.

        • RoleARN — (String)

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

        • BucketARN — (String)

          The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

        • Prefix — (String)

          The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

        • BufferingHints — (map)

          The buffering option. If no value is specified, BufferingHints object default values are used.

          • SizeInMBs — (Integer)

            Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

            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.

          • IntervalInSeconds — (Integer)

            Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

        • CompressionFormat — (String)

          The compression format. If no value is specified, the default is UNCOMPRESSED.

          The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

          Possible values include:
          • "UNCOMPRESSED"
          • "GZIP"
          • "ZIP"
          • "Snappy"
        • EncryptionConfiguration — (map)

          The encryption configuration. If no value is specified, the default is no encryption.

          • NoEncryptionConfig — (String)

            Specifically override existing encryption information to ensure that no encryption is used.

            Possible values include:
            • "NoEncryption"
          • KMSEncryptionConfig — (map)

            The encryption key.

        • CloudWatchLoggingOptions — (map)

          The CloudWatch logging options for your delivery stream.

          • Enabled — (Boolean)

            Enables or disables CloudWatch logging.

          • LogGroupName — (String)

            The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

          • LogStreamName — (String)

            The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

      • DataFormatConversionConfiguration — (map)

        The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

        • SchemaConfiguration — (map)

          Specifies the AWS Glue Data Catalog table that contains the column information.

          • RoleARN — (String)

            The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

          • CatalogId — (String)

            The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.

          • DatabaseName — (String)

            Specifies the name of the AWS Glue database that contains the schema for the output data.

          • TableName — (String)

            Specifies the AWS Glue table that contains the column information that constitutes your data schema.

          • Region — (String)

            If you don't specify an AWS Region, the default is the current Region.

          • VersionId — (String)

            Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

        • InputFormatConfiguration — (map)

          Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON.

          • Deserializer — (map)

            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.

            • OpenXJsonSerDe — (map)

              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.

              • ConvertDotsInJsonKeysToUnderscores — (Boolean)

                When set to true, 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.

                The default is false.

              • CaseInsensitive — (Boolean)

                When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.

              • ColumnToJsonKeyMappings — (map<String>)

                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, timestamp is a Hive keyword. If you have a JSON key named timestamp, set this parameter to {"ts": "timestamp"} to map this key to a column named ts.

            • HiveJsonSerDe — (map)

              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.

              • TimestampFormats — (Array<String>)

                Indicates how you want Kinesis Data Firehose to parse the date and time stamps 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 Class DateTimeFormat. You can also use the special value millis to parse time stamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.

        • OutputFormatConfiguration — (map)

          Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format.

          • Serializer — (map)

            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.

            • ParquetSerDe — (map)

              A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.

              • BlockSizeBytes — (Integer)

                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 — (Integer)

                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 — (String)

                The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ration is more important than speed.

                Possible values include:
                • "UNCOMPRESSED"
                • "GZIP"
                • "SNAPPY"
              • EnableDictionaryCompression — (Boolean)

                Indicates whether to enable dictionary compression.

              • MaxPaddingBytes — (Integer)

                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 — (String)

                Indicates the version of row format to output. The possible values are V1 and V2. The default is V1.

                Possible values include:
                • "V1"
                • "V2"
            • OrcSerDe — (map)

              A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.

              • StripeSizeBytes — (Integer)

                The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.

              • BlockSizeBytes — (Integer)

                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 — (Integer)

                The number of rows between index entries. The default is 10,000 and the minimum is 1,000.

              • EnablePadding — (Boolean)

                Set this to true 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 false.

              • PaddingTolerance — (Float)

                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.

                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.

                Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding is false.

              • Compression — (String)

                The compression code to use over data blocks. The default is SNAPPY.

                Possible values include:
                • "NONE"
                • "ZLIB"
                • "SNAPPY"
              • BloomFilterColumns — (Array<String>)

                The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.

              • BloomFilterFalsePositiveProbability — (Float)

                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 — (Float)

                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 — (String)

                The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.

                Possible values include:
                • "V0_11"
                • "V0_12"
        • Enabled — (Boolean)

          Defaults to true. Set it to false if you want to disable format conversion while preserving the configuration details.

    • RedshiftDestinationUpdate — (map)

      Describes an update for a destination in Amazon Redshift.

      • RoleARN — (String)

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

      • ClusterJDBCURL — (String)

        The database connection string.

      • CopyCommand — (map)

        The COPY command.

        • DataTableNamerequired — (String)

          The name of the target table. The table must already exist in the database.

        • DataTableColumns — (String)

          A comma-separated list of column names.

        • CopyOptions — (String)

          Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Kinesis Data Firehose are as follows:

          delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.

          delimiter '|' - fields are delimited with "|" (this is the default delimiter).

          delimiter '|' escape - the delimiter should be escaped.

          fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

          JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

          For more examples, see Amazon Redshift COPY command examples.

      • Username — (String)

        The name of the user.

      • Password — (String)

        The user password.

      • RetryOptions — (map)

        The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

        • DurationInSeconds — (Integer)

          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 DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.

      • S3Update — (map)

        The Amazon S3 destination.

        The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

        • RoleARN — (String)

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

        • BucketARN — (String)

          The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

        • Prefix — (String)

          The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

        • BufferingHints — (map)

          The buffering option. If no value is specified, BufferingHints object default values are used.

          • SizeInMBs — (Integer)

            Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

            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.

          • IntervalInSeconds — (Integer)

            Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

        • CompressionFormat — (String)

          The compression format. If no value is specified, the default is UNCOMPRESSED.

          The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

          Possible values include:
          • "UNCOMPRESSED"
          • "GZIP"
          • "ZIP"
          • "Snappy"
        • EncryptionConfiguration — (map)

          The encryption configuration. If no value is specified, the default is no encryption.

          • NoEncryptionConfig — (String)

            Specifically override existing encryption information to ensure that no encryption is used.

            Possible values include:
            • "NoEncryption"
          • KMSEncryptionConfig — (map)

            The encryption key.

        • CloudWatchLoggingOptions — (map)

          The CloudWatch logging options for your delivery stream.

          • Enabled — (Boolean)

            Enables or disables CloudWatch logging.

          • LogGroupName — (String)

            The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

          • LogStreamName — (String)

            The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

      • ProcessingConfiguration — (map)

        The data processing configuration.

        • Enabled — (Boolean)

          Enables or disables data processing.

        • Processors — (Array<map>)

          The data processors.

          • Typerequired — (String)

            The type of processor.

            Possible values include:
            • "Lambda"
          • Parameters — (Array<map>)

            The processor parameters.

            • ParameterNamerequired — (String)

              The name of the parameter.

              Possible values include:
              • "LambdaArn"
              • "NumberOfRetries"
              • "RoleArn"
              • "BufferSizeInMBs"
              • "BufferIntervalInSeconds"
            • ParameterValuerequired — (String)

              The parameter value.

      • S3BackupMode — (String)

        The Amazon S3 backup mode.

        Possible values include:
        • "Disabled"
        • "Enabled"
      • S3BackupUpdate — (map)

        The Amazon S3 destination for backup.

        • RoleARN — (String)

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

        • BucketARN — (String)

          The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

        • Prefix — (String)

          The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

        • BufferingHints — (map)

          The buffering option. If no value is specified, BufferingHints object default values are used.

          • SizeInMBs — (Integer)

            Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

            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.

          • IntervalInSeconds — (Integer)

            Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

        • CompressionFormat — (String)

          The compression format. If no value is specified, the default is UNCOMPRESSED.

          The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

          Possible values include:
          • "UNCOMPRESSED"
          • "GZIP"
          • "ZIP"
          • "Snappy"
        • EncryptionConfiguration — (map)

          The encryption configuration. If no value is specified, the default is no encryption.

          • NoEncryptionConfig — (String)

            Specifically override existing encryption information to ensure that no encryption is used.

            Possible values include:
            • "NoEncryption"
          • KMSEncryptionConfig — (map)

            The encryption key.

        • CloudWatchLoggingOptions — (map)

          The CloudWatch logging options for your delivery stream.

          • Enabled — (Boolean)

            Enables or disables CloudWatch logging.

          • LogGroupName — (String)

            The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

          • LogStreamName — (String)

            The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

      • CloudWatchLoggingOptions — (map)

        The Amazon CloudWatch logging options for your delivery stream.

        • Enabled — (Boolean)

          Enables or disables CloudWatch logging.

        • LogGroupName — (String)

          The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

        • LogStreamName — (String)

          The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

    • ElasticsearchDestinationUpdate — (map)

      Describes an update for a destination in Amazon ES.

      • RoleARN — (String)

        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 Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.

      • DomainARN — (String)

        The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

      • IndexName — (String)

        The Elasticsearch index name.

      • TypeName — (String)

        The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.

      • IndexRotationPeriod — (String)

        The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.

        Possible values include:
        • "NoRotation"
        • "OneHour"
        • "OneDay"
        • "OneWeek"
        • "OneMonth"
      • BufferingHints — (map)

        The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.

        • IntervalInSeconds — (Integer)

          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 — (Integer)

          Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

          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.

      • RetryOptions — (map)

        The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

        • DurationInSeconds — (Integer)

          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.

      • S3Update — (map)

        The Amazon S3 destination.

        • RoleARN — (String)

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

        • BucketARN — (String)

          The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

        • Prefix — (String)

          The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

        • BufferingHints — (map)

          The buffering option. If no value is specified, BufferingHints object default values are used.

          • SizeInMBs — (Integer)

            Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

            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.

          • IntervalInSeconds — (Integer)

            Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

        • CompressionFormat — (String)

          The compression format. If no value is specified, the default is UNCOMPRESSED.

          The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

          Possible values include:
          • "UNCOMPRESSED"
          • "GZIP"
          • "ZIP"
          • "Snappy"
        • EncryptionConfiguration — (map)

          The encryption configuration. If no value is specified, the default is no encryption.

          • NoEncryptionConfig — (String)

            Specifically override existing encryption information to ensure that no encryption is used.

            Possible values include:
            • "NoEncryption"
          • KMSEncryptionConfig — (map)

            The encryption key.

        • CloudWatchLoggingOptions — (map)

          The CloudWatch logging options for your delivery stream.

          • Enabled — (Boolean)

            Enables or disables CloudWatch logging.

          • LogGroupName — (String)

            The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

          • LogStreamName — (String)

            The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

      • ProcessingConfiguration — (map)

        The data processing configuration.

        • Enabled — (Boolean)

          Enables or disables data processing.

        • Processors — (Array<map>)

          The data processors.

          • Typerequired — (String)

            The type of processor.

            Possible values include:
            • "Lambda"
          • Parameters — (Array<map>)

            The processor parameters.

            • ParameterNamerequired — (String)

              The name of the parameter.

              Possible values include:
              • "LambdaArn"
              • "NumberOfRetries"
              • "RoleArn"
              • "BufferSizeInMBs"
              • "BufferIntervalInSeconds"
            • ParameterValuerequired — (String)

              The parameter value.

      • CloudWatchLoggingOptions — (map)

        The CloudWatch logging options for your delivery stream.

        • Enabled — (Boolean)

          Enables or disables CloudWatch logging.

        • LogGroupName — (String)

          The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

        • LogStreamName — (String)

          The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

    • SplunkDestinationUpdate — (map)

      Describes an update for a destination in Splunk.

      • HECEndpoint — (String)

        The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

      • HECEndpointType — (String)

        This type can be either "Raw" or "Event."

        Possible values include:
        • "Raw"
        • "Event"
      • HECToken — (String)

        A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

      • HECAcknowledgmentTimeoutInSeconds — (Integer)

        The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends 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 — (map)

        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.

        • DurationInSeconds — (Integer)

          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.

      • S3BackupMode — (String)

        Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

        Possible values include:
        • "FailedEventsOnly"
        • "AllEvents"
      • S3Update — (map)

        Your update to the configuration of the backup Amazon S3 location.

        • RoleARN — (String)

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

        • BucketARN — (String)

          The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

        • Prefix — (String)

          The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

        • BufferingHints — (map)

          The buffering option. If no value is specified, BufferingHints object default values are used.

          • SizeInMBs — (Integer)

            Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

            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.

          • IntervalInSeconds — (Integer)

            Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

        • CompressionFormat — (String)

          The compression format. If no value is specified, the default is UNCOMPRESSED.

          The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

          Possible values include:
          • "UNCOMPRESSED"
          • "GZIP"
          • "ZIP"
          • "Snappy"
        • EncryptionConfiguration — (map)

          The encryption configuration. If no value is specified, the default is no encryption.

          • NoEncryptionConfig — (String)

            Specifically override existing encryption information to ensure that no encryption is used.

            Possible values include:
            • "NoEncryption"
          • KMSEncryptionConfig — (map)

            The encryption key.

        • CloudWatchLoggingOptions — (map)

          The CloudWatch logging options for your delivery stream.

          • Enabled — (Boolean)

            Enables or disables CloudWatch logging.

          • LogGroupName — (String)

            The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

          • LogStreamName — (String)

            The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

      • ProcessingConfiguration — (map)

        The data processing configuration.

        • Enabled — (Boolean)

          Enables or disables data processing.

        • Processors — (Array<map>)

          The data processors.

          • Typerequired — (String)

            The type of processor.

            Possible values include:
            • "Lambda"
          • Parameters — (Array<map>)

            The processor parameters.

            • ParameterNamerequired — (String)

              The name of the parameter.

              Possible values include:
              • "LambdaArn"
              • "NumberOfRetries"
              • "RoleArn"
              • "BufferSizeInMBs"
              • "BufferIntervalInSeconds"
            • ParameterValuerequired — (String)

              The parameter value.

      • CloudWatchLoggingOptions — (map)

        The Amazon CloudWatch logging options for your delivery stream.

        • Enabled — (Boolean)

          Enables or disables CloudWatch logging.

        • LogGroupName — (String)

          The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

        • LogStreamName — (String)

          The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.