This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# Amazon Data Firehose
<a name="AWS_KinesisFirehose"></a>

**Resource types**
+ [AWS::KinesisFirehose::DeliveryStream](aws-resource-kinesisfirehose-deliverystream.md)

# AWS::KinesisFirehose::DeliveryStream
<a name="aws-resource-kinesisfirehose-deliverystream"></a>

The `AWS::KinesisFirehose::DeliveryStream` resource specifies an Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivery stream that delivers real-time streaming data to an Amazon Simple Storage Service (Amazon S3), Amazon Redshift, or Amazon Elasticsearch Service (Amazon ES) destination. For more information, see [Creating an Amazon Kinesis Data Firehose Delivery Stream](https://docs.aws.amazon.com/firehose/latest/dev/basic-create.html) in the *Amazon Kinesis Data Firehose Developer Guide*.

## Syntax
<a name="aws-resource-kinesisfirehose-deliverystream-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-kinesisfirehose-deliverystream-syntax.json"></a>

```
{
  "Type" : "AWS::KinesisFirehose::DeliveryStream",
  "Properties" : {
      "[AmazonOpenSearchServerlessDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration)" : AmazonOpenSearchServerlessDestinationConfiguration,
      "[AmazonopensearchserviceDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration)" : AmazonopensearchserviceDestinationConfiguration,
      "[DatabaseSourceConfiguration](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration)" : DatabaseSourceConfiguration,
      "[DeliveryStreamEncryptionConfigurationInput](#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput)" : DeliveryStreamEncryptionConfigurationInput,
      "[DeliveryStreamName](#cfn-kinesisfirehose-deliverystream-deliverystreamname)" : String,
      "[DeliveryStreamType](#cfn-kinesisfirehose-deliverystream-deliverystreamtype)" : String,
      "[DirectPutSourceConfiguration](#cfn-kinesisfirehose-deliverystream-directputsourceconfiguration)" : DirectPutSourceConfiguration,
      "[ElasticsearchDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration)" : ElasticsearchDestinationConfiguration,
      "[ExtendedS3DestinationConfiguration](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration)" : ExtendedS3DestinationConfiguration,
      "[HttpEndpointDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration)" : HttpEndpointDestinationConfiguration,
      "[IcebergDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration)" : IcebergDestinationConfiguration,
      "[KinesisStreamSourceConfiguration](#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration)" : KinesisStreamSourceConfiguration,
      "[MSKSourceConfiguration](#cfn-kinesisfirehose-deliverystream-msksourceconfiguration)" : MSKSourceConfiguration,
      "[RedshiftDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration)" : RedshiftDestinationConfiguration,
      "[S3DestinationConfiguration](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration)" : S3DestinationConfiguration,
      "[SnowflakeDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration)" : SnowflakeDestinationConfiguration,
      "[SplunkDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration)" : SplunkDestinationConfiguration,
      "[Tags](#cfn-kinesisfirehose-deliverystream-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-kinesisfirehose-deliverystream-syntax.yaml"></a>

```
Type: AWS::KinesisFirehose::DeliveryStream
Properties:
  [AmazonOpenSearchServerlessDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration): 
    AmazonOpenSearchServerlessDestinationConfiguration
  [AmazonopensearchserviceDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration): 
    AmazonopensearchserviceDestinationConfiguration
  [DatabaseSourceConfiguration](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration): 
    DatabaseSourceConfiguration
  [DeliveryStreamEncryptionConfigurationInput](#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput): 
    DeliveryStreamEncryptionConfigurationInput
  [DeliveryStreamName](#cfn-kinesisfirehose-deliverystream-deliverystreamname): String
  [DeliveryStreamType](#cfn-kinesisfirehose-deliverystream-deliverystreamtype): String
  [DirectPutSourceConfiguration](#cfn-kinesisfirehose-deliverystream-directputsourceconfiguration): 
    DirectPutSourceConfiguration
  [ElasticsearchDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration): 
    ElasticsearchDestinationConfiguration
  [ExtendedS3DestinationConfiguration](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration): 
    ExtendedS3DestinationConfiguration
  [HttpEndpointDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration): 
    HttpEndpointDestinationConfiguration
  [IcebergDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration): 
    IcebergDestinationConfiguration
  [KinesisStreamSourceConfiguration](#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration): 
    KinesisStreamSourceConfiguration
  [MSKSourceConfiguration](#cfn-kinesisfirehose-deliverystream-msksourceconfiguration): 
    MSKSourceConfiguration
  [RedshiftDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration): 
    RedshiftDestinationConfiguration
  [S3DestinationConfiguration](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration): 
    S3DestinationConfiguration
  [SnowflakeDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration): 
    SnowflakeDestinationConfiguration
  [SplunkDestinationConfiguration](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration): 
    SplunkDestinationConfiguration
  [Tags](#cfn-kinesisfirehose-deliverystream-tags): 
    - Tag
```

## Properties
<a name="aws-resource-kinesisfirehose-deliverystream-properties"></a>

`AmazonOpenSearchServerlessDestinationConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration"></a>
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.  
*Required*: No  
*Type*: [AmazonOpenSearchServerlessDestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AmazonopensearchserviceDestinationConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration"></a>
The destination in Amazon OpenSearch Service. You can specify only one destination.  
*Required*: Conditional  
*Type*: [AmazonopensearchserviceDestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatabaseSourceConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-databasesourceconfiguration"></a>
 The top level object for configuring streams with database as a source.   
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: No  
*Type*: [DatabaseSourceConfiguration](aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DeliveryStreamEncryptionConfigurationInput`  <a name="cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput"></a>
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).  
*Required*: No  
*Type*: [DeliveryStreamEncryptionConfigurationInput](aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DeliveryStreamName`  <a name="cfn-kinesisfirehose-deliverystream-deliverystreamname"></a>
The name of the Firehose stream.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z0-9._-]+`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DeliveryStreamType`  <a name="cfn-kinesisfirehose-deliverystream-deliverystreamtype"></a>
The Firehose stream type. This can be one of the following values:  
+ `DirectPut`: Provider applications access the Firehose stream directly.
+ `KinesisStreamAsSource`: The Firehose stream uses a Kinesis data stream as a source.
*Required*: No  
*Type*: String  
*Allowed values*: `DatabaseAsSource | DirectPut | KinesisStreamAsSource | MSKAsSource`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DirectPutSourceConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-directputsourceconfiguration"></a>
The structure that configures parameters such as `ThroughputHintInMBs` for a stream configured with Direct PUT as a source.   
*Required*: No  
*Type*: [DirectPutSourceConfiguration](aws-properties-kinesisfirehose-deliverystream-directputsourceconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ElasticsearchDestinationConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration"></a>
An Amazon ES destination for the delivery stream.  
Conditional. You must specify only one destination configuration.  
If you change the delivery stream destination from an Amazon ES destination to an Amazon S3 or Amazon Redshift destination, update requires [some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt).  
*Required*: Conditional  
*Type*: [ElasticsearchDestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExtendedS3DestinationConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration"></a>
An Amazon S3 destination for the delivery stream.  
Conditional. You must specify only one destination configuration.  
If you change the delivery stream destination from an Amazon Extended S3 destination to an Amazon ES destination, update requires [some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt).  
*Required*: Conditional  
*Type*: [ExtendedS3DestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HttpEndpointDestinationConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration"></a>
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.  
*Required*: No  
*Type*: [HttpEndpointDestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IcebergDestinationConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration"></a>
 Specifies the destination configure settings for Apache Iceberg Table.   
*Required*: No  
*Type*: [IcebergDestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KinesisStreamSourceConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration"></a>
When a Kinesis stream is used as the source for the delivery stream, a [KinesisStreamSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html) containing the Kinesis stream ARN and the role ARN for the source stream.  
*Required*: No  
*Type*: [KinesisStreamSourceConfiguration](aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MSKSourceConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-msksourceconfiguration"></a>
The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.  
*Required*: No  
*Type*: [MSKSourceConfiguration](aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RedshiftDestinationConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration"></a>
An Amazon Redshift destination for the delivery stream.  
Conditional. You must specify only one destination configuration.  
If you change the delivery stream destination from an Amazon Redshift destination to an Amazon ES destination, update requires [some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt).   
*Required*: Conditional  
*Type*: [RedshiftDestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3DestinationConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-s3destinationconfiguration"></a>
The `S3DestinationConfiguration` property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.  
Conditional. You must specify only one destination configuration.  
If you change the delivery stream destination from an Amazon S3 destination to an Amazon ES destination, update requires [some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt).  
*Required*: Conditional  
*Type*: [S3DestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnowflakeDestinationConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration"></a>
Configure Snowflake destination  
*Required*: No  
*Type*: [SnowflakeDestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SplunkDestinationConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration"></a>
The configuration of a destination in Splunk for the delivery stream.  
*Required*: No  
*Type*: [SplunkDestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-kinesisfirehose-deliverystream-tags"></a>
A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to AWS resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the AWS Billing and Cost Management User Guide.  
You can specify up to 50 tags when creating a Firehose stream.  
If you specify tags in the `CreateDeliveryStream` action, Amazon Data Firehose performs an additional authorization on the `firehose:TagDeliveryStream` action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an `AccessDeniedException` such as following.  
 **AccessDeniedException**   
User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.  
For an example IAM policy, see [Tag example.](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples)  
*Required*: No  
*Type*: Array of [Tag](aws-properties-kinesisfirehose-deliverystream-tag.md)  
*Minimum*: `1`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-kinesisfirehose-deliverystream-return-values"></a>

### Ref
<a name="aws-resource-kinesisfirehose-deliverystream-return-values-ref"></a>

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the delivery stream name, such as `mystack-deliverystream-1ABCD2EF3GHIJ`. 

For more information about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-kinesisfirehose-deliverystream-return-values-fn--getatt"></a>

Fn::GetAtt returns a value for a specified attribute of this type. The following are the available attributes and sample return values. 

For more information about using Fn::GetAtt, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-kinesisfirehose-deliverystream-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the delivery stream, such as `arn:aws:firehose:us-east-2:123456789012:deliverystream/delivery-stream-name`. 

## Examples
<a name="aws-resource-kinesisfirehose-deliverystream--examples"></a>

**Topics**
+ [Create a Kinesis Data Firehose Delivery Stream](#aws-resource-kinesisfirehose-deliverystream--examples--Create_a_Kinesis_Data_Firehose_Delivery_Stream)
+ [Convert Record Format](#aws-resource-kinesisfirehose-deliverystream--examples--Convert_Record_Format)
+ [Specify an Amazon S3 Destination for the Delivery Stream](#aws-resource-kinesisfirehose-deliverystream--examples--Specify_an_Amazon_S3_Destination_for_the_Delivery_Stream)
+ [Specify a Kinesis Stream as the Source for the Delivery Stream](#aws-resource-kinesisfirehose-deliverystream--examples--Specify_a_Kinesis_Stream_as_the_Source_for_the_Delivery_Stream)

### Create a Kinesis Data Firehose Delivery Stream
<a name="aws-resource-kinesisfirehose-deliverystream--examples--Create_a_Kinesis_Data_Firehose_Delivery_Stream"></a>

The following example creates a Kinesis Data Firehose delivery stream that delivers data to an Amazon ES destination. Kinesis Data Firehose backs up all data sent to the destination in an Amazon S3 bucket.

#### JSON
<a name="aws-resource-kinesisfirehose-deliverystream--examples--Create_a_Kinesis_Data_Firehose_Delivery_Stream--json"></a>

```
"ElasticSearchDeliveryStream": {
   "Type": "AWS::KinesisFirehose::DeliveryStream",
   "Properties": {
      "ElasticsearchDestinationConfiguration": {
         "BufferingHints": {
            "IntervalInSeconds": 60,
            "SizeInMBs": 50
      },
      "CloudWatchLoggingOptions": {
         "Enabled": true,
         "LogGroupName": "deliverystream",
         "LogStreamName": "elasticsearchDelivery"
      },
      "DomainARN": { "Ref" : "MyDomainARN" },
      "IndexName": { "Ref" : "MyIndexName" },
      "IndexRotationPeriod": "NoRotation",
      "TypeName" : "fromFirehose",
      "RetryOptions": {
         "DurationInSeconds": "60"
      },
      "RoleARN": { "Fn::GetAtt" : ["ESdeliveryRole", "Arn"] },
      "S3BackupMode": "AllDocuments",
      "S3Configuration": { 
         "BucketARN": { "Ref" : "MyBackupBucketARN" },
         "BufferingHints": {
            "IntervalInSeconds": "60",
            "SizeInMBs": "50"
         },
         "CompressionFormat": "UNCOMPRESSED",
         "Prefix": "firehose/",
         "RoleARN": { "Fn::GetAtt" : ["S3deliveryRole", "Arn"] },
         "CloudWatchLoggingOptions" : {
            "Enabled" : true,
            "LogGroupName" : "deliverystream",
            "LogStreamName" : "s3Backup"
         }
      }
    }              
  }
}
```

#### YAML
<a name="aws-resource-kinesisfirehose-deliverystream--examples--Create_a_Kinesis_Data_Firehose_Delivery_Stream--yaml"></a>

```
ElasticSearchDeliveryStream: 
   Type: AWS::KinesisFirehose::DeliveryStream
   Properties: 
      ElasticsearchDestinationConfiguration: 
         BufferingHints: 
            IntervalInSeconds: 60
            SizeInMBs: 50
         CloudWatchLoggingOptions: 
            Enabled: true
            LogGroupName: "deliverystream"
            LogStreamName: "elasticsearchDelivery"
         DomainARN: 
            Ref: "MyDomainARN"
         IndexName: 
            Ref: "MyIndexName"
         IndexRotationPeriod: "NoRotation"
         TypeName: "fromFirehose"
         RetryOptions: 
            DurationInSeconds: "60"
         RoleARN: 
            Fn::GetAtt: 
               - "ESdeliveryRole"
               - "Arn"
         S3BackupMode: "AllDocuments"
         S3Configuration: 
            BucketARN: 
               Ref: "MyBackupBucketARN"
            BufferingHints: 
               IntervalInSeconds: "60"
               SizeInMBs: "50"
            CompressionFormat: "UNCOMPRESSED"
            Prefix: "firehose/"
            RoleARN: 
               Fn::GetAtt: 
                  - "S3deliveryRole"
                  - "Arn"
            CloudWatchLoggingOptions: 
               Enabled: true
               LogGroupName: "deliverystream"
               LogStreamName: "s3Backup"
```

### Convert Record Format
<a name="aws-resource-kinesisfirehose-deliverystream--examples--Convert_Record_Format"></a>

The following example shows record format conversion.

#### YAML
<a name="aws-resource-kinesisfirehose-deliverystream--examples--Convert_Record_Format--yaml"></a>

```
AWSTemplateFormatVersion: 2010-09-09
Description: Stack for Firehose DeliveryStream S3 Destination.
Resources:

  GlueDatabase:
    Type: AWS::Glue::Database
    Properties: 
      CatalogId: !Ref AWS::AccountId
      DatabaseInput: {}

  GlueTable:
    Type: AWS::Glue::Table
    Properties:
      CatalogId: !Ref AWS::AccountId
      DatabaseName: !Ref GlueDatabase
      TableInput:
        Owner: owner
        Retention: 0
        StorageDescriptor:
          Columns:
          - Name: pickup_latitude
            Type: double
          - Name: pickup_longitude
            Type: double
          - Name: dropoff_latitude
            Type: double
          - Name: dropoff_longitude
            Type: double
          - Name: trip_id
            Type: int
          - Name: trip_distance
            Type: double
          - Name: passenger_count
            Type: int
          - Name: pickup_datetime
            Type: timestamp
          - Name: dropoff_datetime
            Type: timestamp
          - Name: total_amount
            Type: double
          InputFormat: org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat
          OutputFormat: org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat
          Compressed: false
          NumberOfBuckets: -1
          SerdeInfo:
            SerializationLibrary: org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe
            Parameters:
              serialization.format: '1'
          BucketColumns: []
          SortColumns: []
          StoredAsSubDirectories: false
        PartitionKeys:
        - Name: year
          Type: string
        - Name: month
          Type: string
        - Name: day
          Type: string
        - Name: hour
          Type: string
        TableType: EXTERNAL_TABLE

  deliverystream:
    Type: AWS::KinesisFirehose::DeliveryStream
    Properties: 
      DeliveryStreamType: DirectPut
      ExtendedS3DestinationConfiguration:
        RoleARN: !GetAtt deliveryRole.Arn
        BucketARN: !Join 
          - ''
          - - 'arn:aws:s3:::'
            - !Ref s3bucket
        Prefix: !Join 
          - ''
          - - !Ref GlueTable
            -  '/year=!{timestamp:YYYY}/month=!{timestamp:MM}/day=!{timestamp:dd}/hour=!{timestamp:HH}/'
        ErrorOutputPrefix: !Join 
          - ''
          - - !Ref GlueTable
            -  'error/!{firehose:error-output-type}/year=!{timestamp:YYYY}/month=!{timestamp:MM}/day=!{timestamp:dd}/hour=!{timestamp:HH}/'
        BufferingHints:
          SizeInMBs: 128
          IntervalInSeconds: 300
        CompressionFormat: UNCOMPRESSED
        EncryptionConfiguration:
          NoEncryptionConfig: NoEncryption
        CloudWatchLoggingOptions:
          Enabled: true
          LogGroupName: !Join
            - ''
            - - 'KDF-'
              - !Ref GlueTable
          LogStreamName: S3Delivery
        S3BackupMode: Disabled
        DataFormatConversionConfiguration:
          SchemaConfiguration:
            CatalogId: !Ref AWS::AccountId
            RoleARN: !GetAtt deliveryRole.Arn
            DatabaseName: !Ref GlueDatabase
            TableName: !Ref GlueTable
            Region: !Ref AWS::Region
            VersionId: LATEST
          InputFormatConfiguration:
            Deserializer:
              OpenXJsonSerDe: {}
          OutputFormatConfiguration:
            Serializer:
              ParquetSerDe: {}
          Enabled: True

  s3bucket:
    Type: AWS::S3::Bucket
    Properties:
      VersioningConfiguration:
        Status: Enabled

  deliveryRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: 2012-10-17
        Statement:
          - Sid: ''
            Effect: Allow
            Principal:
              Service: firehose.amazonaws.com
            Action: 'sts:AssumeRole'
            Condition:
              StringEquals:
                'sts:ExternalId': !Ref 'AWS::AccountId'
      Path: "/"
      Policies:
        - PolicyName: firehose_delivery_policy
          PolicyDocument:
            Version: 2012-10-17
            Statement:
              - Effect: Allow
                Action:
                  - 's3:AbortMultipartUpload'
                  - 's3:GetBucketLocation'
                  - 's3:GetObject'
                  - 's3:ListBucket'
                  - 's3:ListBucketMultipartUploads'
                  - 's3:PutObject'
                Resource:
                  - !Join 
                    - ''
                    - - 'arn:aws:s3:::'
                      - !Ref s3bucket
                  - !Join 
                    - ''
                    - - 'arn:aws:s3:::'
                      - !Ref s3bucket
                      - '/*'
              - Effect: Allow
                Action: 'glue:GetTableVersions'
                Resource: '*'
              - Effect: Allow
                Action: 'logs:PutLogEvents'
                Resource: 
                - !Join 
                    - ''
                    - - 'arn:aws:logs:'
                      - !Ref 'AWS::Region'
                      - ':'
                      - !Ref 'AWS::AccountId'
                      - 'log-group:/aws/kinesisfirehose/KDF-'
                      - !Ref GlueTable
                      - ':log-stream:*'
Outputs:
  deliverysreamARN:
    Description: The ARN of the firehose delivery stream
    Value: !GetAtt deliverystream.Arn
```

### Specify an Amazon S3 Destination for the Delivery Stream
<a name="aws-resource-kinesisfirehose-deliverystream--examples--Specify_an_Amazon_S3_Destination_for_the_Delivery_Stream"></a>

The following example uses the `ExtendedS3DestinationConfiguration` property to specify an Amazon S3 destination for the delivery stream.

#### JSON
<a name="aws-resource-kinesisfirehose-deliverystream--examples--Specify_an_Amazon_S3_Destination_for_the_Delivery_Stream--json"></a>

```
{
  "Resources":{ 
    "Firehose":{
      "Type" : "AWS::KinesisFirehose::DeliveryStream",
      "Properties" : {
          "DeliveryStreamName" : "tester-partitioning-delimiter",
          "DeliveryStreamType" : "DirectPut",
          "ExtendedS3DestinationConfiguration": 
            {
              "BucketARN": "arn:aws:s3:::dp-firehose-test",
              "BufferingHints": {
                "SizeInMBs": 128,
                "IntervalInSeconds": 900
              },
              "CompressionFormat": "UNCOMPRESSED",
              "ErrorOutputPrefix": "table/error/!{firehose:error-output-type}/dt=!{timestamp:yyyy'-'MM'-'dd}/h=!{timestamp:HH}/",
              "Prefix": "YYYY=!{partitionKeyFromQuery:YYYY}/MM=!{partitionKeyFromQuery:MM}//DD=!{partitionKeyFromQuery:DD}/HH=!{partitionKeyFromQuery:HH}/REGION=!{partitionKeyFromQuery:REGION}/SITEID=!{partitionKeyFromQuery:SITEID}/",
              "RoleARN": "arn:aws:iam::012345678912:role/service-role/KinesisFirehoseServiceRole-dp-kinesis-f-us-east-1-012345678912", 
              "DynamicPartitioningConfiguration": 
              {
                "Enabled": true,
                "RetryOptions": {
                  "DurationInSeconds": 300
                  }
                },
                "ProcessingConfiguration": {
                  "Enabled": true,
                  "Processors": [
                  {
                    "Type": "MetadataExtraction",
                    "Parameters": [
                      {
                      "ParameterName": "MetadataExtractionQuery",
                      "ParameterValue": "{YYYY : (.ts/1000) | strftime(\"%Y\"), MM : (.ts/1000) | strftime(\"%m\"), DD : (.ts/1000) | strftime(\"%d\"), HH: (.ts/1000) | strftime(\"%H\")}"
                      },
                      {
                        "ParameterName": "JsonParsingEngine",
                        "ParameterValue": "JQ-1.6"
                      }
                    ]
                  },
				    {
                    "Type": "AppendDelimiterToRecord",
                    "Parameters": [
                        {
                        "ParameterName": "Delimiter",
                        "ParameterValue": "\\n"
                      }
                    ]
                  }
                ] 
                }
              }
            }
          }
        }
      }
```

#### YAML
<a name="aws-resource-kinesisfirehose-deliverystream--examples--Specify_an_Amazon_S3_Destination_for_the_Delivery_Stream--yaml"></a>

```
---
Resources:
  Firehose:
    Type: AWS::KinesisFirehose::DeliveryStream
    Properties:
      DeliveryStreamName: tester-partitioning-delimiter
      DeliveryStreamType: DirectPut
      ExtendedS3DestinationConfiguration:
        BucketARN: arn:aws:s3:::dp-firehose-test
        BufferingHints:
          SizeInMBs: 128
          IntervalInSeconds: 900
        CompressionFormat: UNCOMPRESSED
        ErrorOutputPrefix: table/error/!{firehose:error-output-type}/dt=!{timestamp:yyyy'-'MM'-'dd}/h=!{timestamp:HH}/
        Prefix: YYYY=!{partitionKeyFromQuery:YYYY}/MM=!{partitionKeyFromQuery:MM}//DD=!{partitionKeyFromQuery:DD}/HH=!{partitionKeyFromQuery:HH}/REGION=!{partitionKeyFromQuery:REGION}/SITEID=!{partitionKeyFromQuery:SITEID}/
        RoleARN: arn:aws:iam::012345678912:role/service-role/KinesisFirehoseServiceRole-dp-kinesis-f-us-east-1-012345678912
        DynamicPartitioningConfiguration:
          Enabled: true
          RetryOptions:
            DurationInSeconds: 300
        ProcessingConfiguration:
          Enabled: true
          Processors:
          - Type: MetadataExtraction
            Parameters:
            - ParameterName: MetadataExtractionQuery
              ParameterValue: '{YYYY : (.ts/1000) | strftime("%Y"), MM : (.ts/1000)
                | strftime("%m"), DD : (.ts/1000) | strftime("%d"), HH: (.ts/1000)
                | strftime("%H")}'
            - ParameterName: JsonParsingEngine
              ParameterValue: JQ-1.6
          - Type: AppendDelimiterToRecord
            Parameters:
            - ParameterName: Delimiter
              ParameterValue: "\\n"
```

### Specify a Kinesis Stream as the Source for the Delivery Stream
<a name="aws-resource-kinesisfirehose-deliverystream--examples--Specify_a_Kinesis_Stream_as_the_Source_for_the_Delivery_Stream"></a>

The following example uses the `KinesisStreamSourceConfiguration` property to specify a Kinesis stream as the source for the delivery stream.

#### JSON
<a name="aws-resource-kinesisfirehose-deliverystream--examples--Specify_a_Kinesis_Stream_as_the_Source_for_the_Delivery_Stream--json"></a>

```
{
    "Parameters": {
        "deliveryRoleArn": {
            "Type": "String"
        },
        "deliveryStreamName": {
            "Type": "String"
        },
        "kinesisStreamARN": {
            "Type": "String"
        },
        "kinesisStreamRoleArn": {
            "Type": "String"
        },
        "s3bucketArn": {
            "Type": "String"
        }
    },
    "Resources": {
        "Deliverystream": {
            "Type": "AWS::KinesisFirehose::DeliveryStream",
            "Properties": {
                "DeliveryStreamName": {
                    "Ref": "deliveryStreamName"
                },
                "DeliveryStreamType": "KinesisStreamAsSource",
                "KinesisStreamSourceConfiguration": {
                    "KinesisStreamARN": {
                        "Ref": "kinesisStreamARN"
                    },
                    "RoleARN": {
                        "Ref": "kinesisStreamRoleArn"
                    }
                },
                "ExtendedS3DestinationConfiguration": {
                    "BucketARN": {
                        "Ref": "s3bucketArn"
                    },
                    "BufferingHints": {
                        "IntervalInSeconds": 60,
                        "SizeInMBs": 50
                    },
                    "CompressionFormat": "UNCOMPRESSED",
                    "Prefix": "firehose/",
                    "RoleARN": {
                        "Ref": "deliveryRoleArn"
                    }
                }
            }
        }
    }
}
```

#### YAML
<a name="aws-resource-kinesisfirehose-deliverystream--examples--Specify_a_Kinesis_Stream_as_the_Source_for_the_Delivery_Stream--yaml"></a>

```
Parameters:
    deliveryRoleArn:
        Type: String
    deliveryStreamName:
        Type: String
    kinesisStreamARN :
        Type : String
    kinesisStreamRoleArn:
        Type : String
    s3bucketArn:
        Type: String
Resources :
    Deliverystream: 
        Type: AWS::KinesisFirehose::DeliveryStream
        Properties: 
            DeliveryStreamName: !Ref deliveryStreamName
            DeliveryStreamType: KinesisStreamAsSource
            KinesisStreamSourceConfiguration: 
                KinesisStreamARN: !Ref kinesisStreamARN
                RoleARN: !Ref kinesisStreamRoleArn
            ExtendedS3DestinationConfiguration: 
                BucketARN: !Ref s3bucketArn
                BufferingHints: 
                    IntervalInSeconds: 60
                    SizeInMBs: 50
                CompressionFormat: UNCOMPRESSED
                Prefix: firehose/
                RoleARN: !Ref deliveryRoleArn
```

## See also
<a name="aws-resource-kinesisfirehose-deliverystream--seealso"></a>
+ [CreateDeliveryStream](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html) in the *Amazon Kinesis Data Firehose API Reference*.

# AWS::KinesisFirehose::DeliveryStream AmazonOpenSearchServerlessBufferingHints
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints"></a>

Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-syntax.json"></a>

```
{
  "[IntervalInSeconds](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-intervalinseconds)" : Integer,
  "[SizeInMBs](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-sizeinmbs)" : Integer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-syntax.yaml"></a>

```
  [IntervalInSeconds](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-intervalinseconds): Integer
  [SizeInMBs](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-sizeinmbs): Integer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-properties"></a>

`IntervalInSeconds`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-intervalinseconds"></a>
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `900`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SizeInMBs`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-sizeinmbs"></a>
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 Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream AmazonOpenSearchServerlessDestinationConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration"></a>

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-syntax.json"></a>

```
{
  "[BufferingHints](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-bufferinghints)" : AmazonOpenSearchServerlessBufferingHints,
  "[CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-cloudwatchloggingoptions)" : CloudWatchLoggingOptions,
  "[CollectionEndpoint](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-collectionendpoint)" : String,
  "[IndexName](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-indexname)" : String,
  "[ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-processingconfiguration)" : ProcessingConfiguration,
  "[RetryOptions](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-retryoptions)" : AmazonOpenSearchServerlessRetryOptions,
  "[RoleARN](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-rolearn)" : String,
  "[S3BackupMode](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-s3backupmode)" : String,
  "[S3Configuration](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-s3configuration)" : S3DestinationConfiguration,
  "[VpcConfiguration](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-vpcconfiguration)" : VpcConfiguration
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-syntax.yaml"></a>

```
  [BufferingHints](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-bufferinghints): 
    AmazonOpenSearchServerlessBufferingHints
  [CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-cloudwatchloggingoptions): 
    CloudWatchLoggingOptions
  [CollectionEndpoint](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-collectionendpoint): String
  [IndexName](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-indexname): String
  [ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-processingconfiguration): 
    ProcessingConfiguration
  [RetryOptions](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-retryoptions): 
    AmazonOpenSearchServerlessRetryOptions
  [RoleARN](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-rolearn): String
  [S3BackupMode](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-s3backupmode): String
  [S3Configuration](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-s3configuration): 
    S3DestinationConfiguration
  [VpcConfiguration](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-vpcconfiguration): 
    VpcConfiguration
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-properties"></a>

`BufferingHints`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-bufferinghints"></a>
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.  
*Required*: No  
*Type*: [AmazonOpenSearchServerlessBufferingHints](aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CloudWatchLoggingOptions`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-cloudwatchloggingoptions"></a>
Property description not available.  
*Required*: No  
*Type*: [CloudWatchLoggingOptions](aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CollectionEndpoint`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-collectionendpoint"></a>
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.  
*Required*: No  
*Type*: String  
*Pattern*: `https:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IndexName`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-indexname"></a>
The Serverless offering for Amazon OpenSearch Service index name.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `80`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProcessingConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-processingconfiguration"></a>
Property description not available.  
*Required*: No  
*Type*: [ProcessingConfiguration](aws-properties-kinesisfirehose-deliverystream-processingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RetryOptions`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-retryoptions"></a>
The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).  
*Required*: No  
*Type*: [AmazonOpenSearchServerlessRetryOptions](aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleARN`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-rolearn"></a>
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3BackupMode`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-s3backupmode"></a>
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.  
*Required*: No  
*Type*: String  
*Allowed values*: `FailedDocumentsOnly | AllDocuments`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Configuration`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-s3configuration"></a>
Property description not available.  
*Required*: Yes  
*Type*: [S3DestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-vpcconfiguration"></a>
Property description not available.  
*Required*: No  
*Type*: [VpcConfiguration](aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream AmazonOpenSearchServerlessRetryOptions
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions"></a>

Configures retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions-syntax.json"></a>

```
{
  "[DurationInSeconds](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions-durationinseconds)" : Integer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions-syntax.yaml"></a>

```
  [DurationInSeconds](#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions-durationinseconds): Integer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions-properties"></a>

`DurationInSeconds`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions-durationinseconds"></a>
After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which 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.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `7200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream AmazonopensearchserviceBufferingHints
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints"></a>

Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints-syntax.json"></a>

```
{
  "[IntervalInSeconds](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints-intervalinseconds)" : Integer,
  "[SizeInMBs](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints-sizeinmbs)" : Integer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints-syntax.yaml"></a>

```
  [IntervalInSeconds](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints-intervalinseconds): Integer
  [SizeInMBs](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints-sizeinmbs): Integer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints-properties"></a>

`IntervalInSeconds`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints-intervalinseconds"></a>
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `900`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SizeInMBs`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints-sizeinmbs"></a>
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.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream AmazonopensearchserviceDestinationConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration"></a>

Describes the configuration of a destination in Amazon OpenSearch Service.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-syntax.json"></a>

```
{
  "[BufferingHints](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-bufferinghints)" : AmazonopensearchserviceBufferingHints,
  "[CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-cloudwatchloggingoptions)" : CloudWatchLoggingOptions,
  "[ClusterEndpoint](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-clusterendpoint)" : String,
  "[DocumentIdOptions](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-documentidoptions)" : DocumentIdOptions,
  "[DomainARN](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-domainarn)" : String,
  "[IndexName](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-indexname)" : String,
  "[IndexRotationPeriod](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-indexrotationperiod)" : String,
  "[ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-processingconfiguration)" : ProcessingConfiguration,
  "[RetryOptions](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-retryoptions)" : AmazonopensearchserviceRetryOptions,
  "[RoleARN](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-rolearn)" : String,
  "[S3BackupMode](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-s3backupmode)" : String,
  "[S3Configuration](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-s3configuration)" : S3DestinationConfiguration,
  "[TypeName](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-typename)" : String,
  "[VpcConfiguration](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-vpcconfiguration)" : VpcConfiguration
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-syntax.yaml"></a>

```
  [BufferingHints](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-bufferinghints): 
    AmazonopensearchserviceBufferingHints
  [CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-cloudwatchloggingoptions): 
    CloudWatchLoggingOptions
  [ClusterEndpoint](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-clusterendpoint): String
  [DocumentIdOptions](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-documentidoptions): 
    DocumentIdOptions
  [DomainARN](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-domainarn): String
  [IndexName](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-indexname): String
  [IndexRotationPeriod](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-indexrotationperiod): String
  [ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-processingconfiguration): 
    ProcessingConfiguration
  [RetryOptions](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-retryoptions): 
    AmazonopensearchserviceRetryOptions
  [RoleARN](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-rolearn): String
  [S3BackupMode](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-s3backupmode): String
  [S3Configuration](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-s3configuration): 
    S3DestinationConfiguration
  [TypeName](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-typename): String
  [VpcConfiguration](#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-vpcconfiguration): 
    VpcConfiguration
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-properties"></a>

`BufferingHints`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-bufferinghints"></a>
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.  
*Required*: No  
*Type*: [AmazonopensearchserviceBufferingHints](aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicebufferinghints.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CloudWatchLoggingOptions`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-cloudwatchloggingoptions"></a>
Describes the Amazon CloudWatch logging options for your delivery stream.  
*Required*: No  
*Type*: [CloudWatchLoggingOptions](aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClusterEndpoint`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-clusterendpoint"></a>
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.  
*Required*: No  
*Type*: String  
*Pattern*: `https:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DocumentIdOptions`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-documentidoptions"></a>
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.  
*Required*: No  
*Type*: [DocumentIdOptions](aws-properties-kinesisfirehose-deliverystream-documentidoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DomainARN`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-domainarn"></a>
The ARN of the Amazon OpenSearch Service domain.   
*Required*: No  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IndexName`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-indexname"></a>
The Amazon OpenSearch Service index name.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `80`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IndexRotationPeriod`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-indexrotationperiod"></a>
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.  
*Required*: No  
*Type*: String  
*Allowed values*: `NoRotation | OneHour | OneDay | OneWeek | OneMonth`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProcessingConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-processingconfiguration"></a>
Describes a data processing configuration.  
*Required*: No  
*Type*: [ProcessingConfiguration](aws-properties-kinesisfirehose-deliverystream-processingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RetryOptions`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-retryoptions"></a>
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).  
*Required*: No  
*Type*: [AmazonopensearchserviceRetryOptions](aws-properties-kinesisfirehose-deliverystream-amazonopensearchserviceretryoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleARN`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-rolearn"></a>
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3BackupMode`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-s3backupmode"></a>
Defines how documents should be delivered to Amazon S3.   
*Required*: No  
*Type*: String  
*Allowed values*: `FailedDocumentsOnly | AllDocuments`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Configuration`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-s3configuration"></a>
Describes the configuration of a destination in Amazon S3.  
*Required*: Yes  
*Type*: [S3DestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TypeName`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-typename"></a>
The Amazon OpenSearch Service type name.   
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-vpcconfiguration"></a>
The details of the VPC of the Amazon OpenSearch Service destination.  
*Required*: No  
*Type*: [VpcConfiguration](aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream AmazonopensearchserviceRetryOptions
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserviceretryoptions"></a>

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserviceretryoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserviceretryoptions-syntax.json"></a>

```
{
  "[DurationInSeconds](#cfn-kinesisfirehose-deliverystream-amazonopensearchserviceretryoptions-durationinseconds)" : Integer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserviceretryoptions-syntax.yaml"></a>

```
  [DurationInSeconds](#cfn-kinesisfirehose-deliverystream-amazonopensearchserviceretryoptions-durationinseconds): Integer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-amazonopensearchserviceretryoptions-properties"></a>

`DurationInSeconds`  <a name="cfn-kinesisfirehose-deliverystream-amazonopensearchserviceretryoptions-durationinseconds"></a>
After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `7200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream AuthenticationConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-authenticationconfiguration"></a>

The authentication configuration of the Amazon MSK cluster.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-authenticationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-authenticationconfiguration-syntax.json"></a>

```
{
  "[Connectivity](#cfn-kinesisfirehose-deliverystream-authenticationconfiguration-connectivity)" : String,
  "[RoleARN](#cfn-kinesisfirehose-deliverystream-authenticationconfiguration-rolearn)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-authenticationconfiguration-syntax.yaml"></a>

```
  [Connectivity](#cfn-kinesisfirehose-deliverystream-authenticationconfiguration-connectivity): String
  [RoleARN](#cfn-kinesisfirehose-deliverystream-authenticationconfiguration-rolearn): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-authenticationconfiguration-properties"></a>

`Connectivity`  <a name="cfn-kinesisfirehose-deliverystream-authenticationconfiguration-connectivity"></a>
The type of connectivity used to access the Amazon MSK cluster.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `PUBLIC | PRIVATE`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RoleARN`  <a name="cfn-kinesisfirehose-deliverystream-authenticationconfiguration-rolearn"></a>
The ARN of the role used to access the Amazon MSK cluster.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream BufferingHints
<a name="aws-properties-kinesisfirehose-deliverystream-bufferinghints"></a>

The `BufferingHints` property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose) buffers incoming data before delivering it to the destination. The first buffer condition that is satisfied triggers Kinesis Data Firehose to deliver the data. 

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-bufferinghints-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-bufferinghints-syntax.json"></a>

```
{
  "[IntervalInSeconds](#cfn-kinesisfirehose-deliverystream-bufferinghints-intervalinseconds)" : Integer,
  "[SizeInMBs](#cfn-kinesisfirehose-deliverystream-bufferinghints-sizeinmbs)" : Integer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-bufferinghints-syntax.yaml"></a>

```
  [IntervalInSeconds](#cfn-kinesisfirehose-deliverystream-bufferinghints-intervalinseconds): Integer
  [SizeInMBs](#cfn-kinesisfirehose-deliverystream-bufferinghints-sizeinmbs): Integer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-bufferinghints-properties"></a>

`IntervalInSeconds`  <a name="cfn-kinesisfirehose-deliverystream-bufferinghints-intervalinseconds"></a>
The length of time, in seconds, that Kinesis Data Firehose buffers incoming data before delivering it to the destination. For valid values, see the `IntervalInSeconds` content for the [BufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html) data type in the *Amazon Kinesis Data Firehose API Reference*.   
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `900`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SizeInMBs`  <a name="cfn-kinesisfirehose-deliverystream-bufferinghints-sizeinmbs"></a>
The size of the buffer, in MBs, that Kinesis Data Firehose uses for incoming data before delivering it to the destination. For valid values, see the `SizeInMBs` content for the [BufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html) data type in the *Amazon Kinesis Data Firehose API Reference*.   
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream CatalogConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-catalogconfiguration"></a>

 Describes the containers where the destination Apache Iceberg Tables are persisted. 

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-catalogconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-catalogconfiguration-syntax.json"></a>

```
{
  "[CatalogArn](#cfn-kinesisfirehose-deliverystream-catalogconfiguration-catalogarn)" : String,
  "[WarehouseLocation](#cfn-kinesisfirehose-deliverystream-catalogconfiguration-warehouselocation)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-catalogconfiguration-syntax.yaml"></a>

```
  [CatalogArn](#cfn-kinesisfirehose-deliverystream-catalogconfiguration-catalogarn): String
  [WarehouseLocation](#cfn-kinesisfirehose-deliverystream-catalogconfiguration-warehouselocation): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-catalogconfiguration-properties"></a>

`CatalogArn`  <a name="cfn-kinesisfirehose-deliverystream-catalogconfiguration-catalogarn"></a>
 Specifies the Glue catalog ARN identifier of the destination Apache Iceberg Tables. You must specify the ARN in the format `arn:aws:glue:region:account-id:catalog`.   
*Required*: No  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`WarehouseLocation`  <a name="cfn-kinesisfirehose-deliverystream-catalogconfiguration-warehouselocation"></a>
The warehouse location for Apache Iceberg tables. You must configure this when schema evolution and table creation is enabled.  
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: No  
*Type*: String  
*Pattern*: `s3:\/\/.*`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream CloudWatchLoggingOptions
<a name="aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions"></a>

The `CloudWatchLoggingOptions` property type specifies Amazon CloudWatch Logs (CloudWatch Logs) logging options that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses for the delivery stream.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions-syntax.json"></a>

```
{
  "[Enabled](#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-enabled)" : Boolean,
  "[LogGroupName](#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-loggroupname)" : String,
  "[LogStreamName](#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-logstreamname)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions-syntax.yaml"></a>

```
  [Enabled](#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-enabled): Boolean
  [LogGroupName](#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-loggroupname): String
  [LogStreamName](#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-logstreamname): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions-properties"></a>

`Enabled`  <a name="cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-enabled"></a>
Indicates whether CloudWatch Logs logging is enabled.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LogGroupName`  <a name="cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-loggroupname"></a>
The name of the CloudWatch Logs log group that contains the log stream that Kinesis Data Firehose will use.  
Conditional. If you enable logging, you must specify this property.  
*Required*: Conditional  
*Type*: String  
*Pattern*: `[\.\-_/#A-Za-z0-9]*`  
*Minimum*: `0`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LogStreamName`  <a name="cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-logstreamname"></a>
The name of the CloudWatch Logs log stream that Kinesis Data Firehose uses to send logs about data delivery.  
Conditional. If you enable logging, you must specify this property.  
*Required*: Conditional  
*Type*: String  
*Pattern*: `[^:*]*`  
*Minimum*: `0`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream CopyCommand
<a name="aws-properties-kinesisfirehose-deliverystream-copycommand"></a>

The `CopyCommand` property type configures the Amazon Redshift `COPY` command that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses to load data into an Amazon Redshift cluster from an Amazon S3 bucket.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-copycommand-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-copycommand-syntax.json"></a>

```
{
  "[CopyOptions](#cfn-kinesisfirehose-deliverystream-copycommand-copyoptions)" : String,
  "[DataTableColumns](#cfn-kinesisfirehose-deliverystream-copycommand-datatablecolumns)" : String,
  "[DataTableName](#cfn-kinesisfirehose-deliverystream-copycommand-datatablename)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-copycommand-syntax.yaml"></a>

```
  [CopyOptions](#cfn-kinesisfirehose-deliverystream-copycommand-copyoptions): String
  [DataTableColumns](#cfn-kinesisfirehose-deliverystream-copycommand-datatablecolumns): String
  [DataTableName](#cfn-kinesisfirehose-deliverystream-copycommand-datatablename): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-copycommand-properties"></a>

`CopyOptions`  <a name="cfn-kinesisfirehose-deliverystream-copycommand-copyoptions"></a>
Parameters to use with the Amazon Redshift `COPY` command. For examples, see the `CopyOptions` content for the [CopyCommand](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CopyCommand.html) data type in the *Amazon Kinesis Data Firehose API Reference*.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `204800`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DataTableColumns`  <a name="cfn-kinesisfirehose-deliverystream-copycommand-datatablecolumns"></a>
A comma-separated list of column names.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `204800`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DataTableName`  <a name="cfn-kinesisfirehose-deliverystream-copycommand-datatablename"></a>
The name of the target table. The table must already exist in the database.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream DatabaseColumns
<a name="aws-properties-kinesisfirehose-deliverystream-databasecolumns"></a>

<a name="aws-properties-kinesisfirehose-deliverystream-databasecolumns-description"></a>The `DatabaseColumns` property type specifies Property description not available. for an [AWS::KinesisFirehose::DeliveryStream](aws-resource-kinesisfirehose-deliverystream.md).

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-databasecolumns-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-databasecolumns-syntax.json"></a>

```
{
  "[Exclude](#cfn-kinesisfirehose-deliverystream-databasecolumns-exclude)" : [ String, ... ],
  "[Include](#cfn-kinesisfirehose-deliverystream-databasecolumns-include)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-databasecolumns-syntax.yaml"></a>

```
  [Exclude](#cfn-kinesisfirehose-deliverystream-databasecolumns-exclude): 
    - String
  [Include](#cfn-kinesisfirehose-deliverystream-databasecolumns-include): 
    - String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-databasecolumns-properties"></a>

`Exclude`  <a name="cfn-kinesisfirehose-deliverystream-databasecolumns-exclude"></a>
Property description not available.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Include`  <a name="cfn-kinesisfirehose-deliverystream-databasecolumns-include"></a>
Property description not available.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream Databases
<a name="aws-properties-kinesisfirehose-deliverystream-databases"></a>

<a name="aws-properties-kinesisfirehose-deliverystream-databases-description"></a>The `Databases` property type specifies Property description not available. for an [AWS::KinesisFirehose::DeliveryStream](aws-resource-kinesisfirehose-deliverystream.md).

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-databases-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-databases-syntax.json"></a>

```
{
  "[Exclude](#cfn-kinesisfirehose-deliverystream-databases-exclude)" : [ String, ... ],
  "[Include](#cfn-kinesisfirehose-deliverystream-databases-include)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-databases-syntax.yaml"></a>

```
  [Exclude](#cfn-kinesisfirehose-deliverystream-databases-exclude): 
    - String
  [Include](#cfn-kinesisfirehose-deliverystream-databases-include): 
    - String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-databases-properties"></a>

`Exclude`  <a name="cfn-kinesisfirehose-deliverystream-databases-exclude"></a>
Property description not available.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Include`  <a name="cfn-kinesisfirehose-deliverystream-databases-include"></a>
Property description not available.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream DatabaseSourceAuthenticationConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-databasesourceauthenticationconfiguration"></a>

 The structure to configure the authentication methods for Firehose to connect to source database endpoint. 

Amazon Data Firehose is in preview release and is subject to change.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-databasesourceauthenticationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-databasesourceauthenticationconfiguration-syntax.json"></a>

```
{
  "[SecretsManagerConfiguration](#cfn-kinesisfirehose-deliverystream-databasesourceauthenticationconfiguration-secretsmanagerconfiguration)" : SecretsManagerConfiguration
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-databasesourceauthenticationconfiguration-syntax.yaml"></a>

```
  [SecretsManagerConfiguration](#cfn-kinesisfirehose-deliverystream-databasesourceauthenticationconfiguration-secretsmanagerconfiguration): 
    SecretsManagerConfiguration
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-databasesourceauthenticationconfiguration-properties"></a>

`SecretsManagerConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-databasesourceauthenticationconfiguration-secretsmanagerconfiguration"></a>
Property description not available.  
*Required*: Yes  
*Type*: [SecretsManagerConfiguration](aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream DatabaseSourceConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration"></a>

 The top level object for configuring streams with database as a source. 

Amazon Data Firehose is in preview release and is subject to change.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration-syntax.json"></a>

```
{
  "[Columns](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-columns)" : DatabaseColumns,
  "[Databases](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-databases)" : Databases,
  "[DatabaseSourceAuthenticationConfiguration](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-databasesourceauthenticationconfiguration)" : DatabaseSourceAuthenticationConfiguration,
  "[DatabaseSourceVPCConfiguration](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-databasesourcevpcconfiguration)" : DatabaseSourceVPCConfiguration,
  "[Digest](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-digest)" : String,
  "[Endpoint](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-endpoint)" : String,
  "[Port](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-port)" : Integer,
  "[PublicCertificate](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-publiccertificate)" : String,
  "[SnapshotWatermarkTable](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-snapshotwatermarktable)" : String,
  "[SSLMode](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-sslmode)" : String,
  "[SurrogateKeys](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-surrogatekeys)" : [ String, ... ],
  "[Tables](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-tables)" : DatabaseTables,
  "[Type](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-type)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration-syntax.yaml"></a>

```
  [Columns](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-columns): 
    DatabaseColumns
  [Databases](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-databases): 
    Databases
  [DatabaseSourceAuthenticationConfiguration](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-databasesourceauthenticationconfiguration): 
    DatabaseSourceAuthenticationConfiguration
  [DatabaseSourceVPCConfiguration](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-databasesourcevpcconfiguration): 
    DatabaseSourceVPCConfiguration
  [Digest](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-digest): String
  [Endpoint](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-endpoint): String
  [Port](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-port): Integer
  [PublicCertificate](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-publiccertificate): String
  [SnapshotWatermarkTable](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-snapshotwatermarktable): String
  [SSLMode](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-sslmode): String
  [SurrogateKeys](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-surrogatekeys): 
    - String
  [Tables](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-tables): 
    DatabaseTables
  [Type](#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-type): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration-properties"></a>

`Columns`  <a name="cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-columns"></a>
 The list of column patterns in source database endpoint for Firehose to read from.   
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: No  
*Type*: [DatabaseColumns](aws-properties-kinesisfirehose-deliverystream-databasecolumns.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Databases`  <a name="cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-databases"></a>
 The list of database patterns in source database endpoint for Firehose to read from.   
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: Yes  
*Type*: [Databases](aws-properties-kinesisfirehose-deliverystream-databases.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DatabaseSourceAuthenticationConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-databasesourceauthenticationconfiguration"></a>
 The structure to configure the authentication methods for Firehose to connect to source database endpoint.   
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: Yes  
*Type*: [DatabaseSourceAuthenticationConfiguration](aws-properties-kinesisfirehose-deliverystream-databasesourceauthenticationconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DatabaseSourceVPCConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-databasesourcevpcconfiguration"></a>
 The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.   
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: Yes  
*Type*: [DatabaseSourceVPCConfiguration](aws-properties-kinesisfirehose-deliverystream-databasesourcevpcconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Digest`  <a name="cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-digest"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Endpoint`  <a name="cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-endpoint"></a>
 The endpoint of the database server.   
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!\s*$).+`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Port`  <a name="cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-port"></a>
The port of the database. This can be one of the following values.  
+ 3306 for MySQL database type
+ 5432 for PostgreSQL database type
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `65535`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PublicCertificate`  <a name="cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-publiccertificate"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `.*`  
*Minimum*: `1`  
*Maximum*: `4096`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SnapshotWatermarkTable`  <a name="cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-snapshotwatermarktable"></a>
 The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.   
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[\u0001-\uFFFF]*`  
*Minimum*: `1`  
*Maximum*: `129`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SSLMode`  <a name="cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-sslmode"></a>
 The mode to enable or disable SSL when Firehose connects to the database endpoint.   
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: No  
*Type*: String  
*Allowed values*: `Disabled | Enabled`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SurrogateKeys`  <a name="cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-surrogatekeys"></a>
 The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured.   
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tables`  <a name="cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-tables"></a>
 The list of table patterns in source database endpoint for Firehose to read from.   
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: Yes  
*Type*: [DatabaseTables](aws-properties-kinesisfirehose-deliverystream-databasetables.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Type`  <a name="cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-type"></a>
The type of database engine. This can be one of the following values.   
+ MySQL
+ PostgreSQL
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `MySQL | PostgreSQL`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream DatabaseSourceVPCConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-databasesourcevpcconfiguration"></a>

 The structure for details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database. 

Amazon Data Firehose is in preview release and is subject to change.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-databasesourcevpcconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-databasesourcevpcconfiguration-syntax.json"></a>

```
{
  "[VpcEndpointServiceName](#cfn-kinesisfirehose-deliverystream-databasesourcevpcconfiguration-vpcendpointservicename)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-databasesourcevpcconfiguration-syntax.yaml"></a>

```
  [VpcEndpointServiceName](#cfn-kinesisfirehose-deliverystream-databasesourcevpcconfiguration-vpcendpointservicename): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-databasesourcevpcconfiguration-properties"></a>

`VpcEndpointServiceName`  <a name="cfn-kinesisfirehose-deliverystream-databasesourcevpcconfiguration-vpcendpointservicename"></a>
 The VPC endpoint service name which Firehose uses to create a PrivateLink to the database. The endpoint service must have the Firehose service principle `firehose.amazonaws.com` as an allowed principal on the VPC endpoint service. The VPC endpoint service name is a string that looks like `com.amazonaws.vpce.<region>.<vpc-endpoint-service-id>`.   
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: Yes  
*Type*: String  
*Pattern*: `([a-zA-Z0-9\-\_]+\.){2,3}vpce\.[a-zA-Z0-9\-]*\.vpce-svc\-[a-zA-Z0-9\-]{17}$`  
*Minimum*: `47`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream DatabaseTables
<a name="aws-properties-kinesisfirehose-deliverystream-databasetables"></a>

<a name="aws-properties-kinesisfirehose-deliverystream-databasetables-description"></a>The `DatabaseTables` property type specifies Property description not available. for an [AWS::KinesisFirehose::DeliveryStream](aws-resource-kinesisfirehose-deliverystream.md).

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-databasetables-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-databasetables-syntax.json"></a>

```
{
  "[Exclude](#cfn-kinesisfirehose-deliverystream-databasetables-exclude)" : [ String, ... ],
  "[Include](#cfn-kinesisfirehose-deliverystream-databasetables-include)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-databasetables-syntax.yaml"></a>

```
  [Exclude](#cfn-kinesisfirehose-deliverystream-databasetables-exclude): 
    - String
  [Include](#cfn-kinesisfirehose-deliverystream-databasetables-include): 
    - String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-databasetables-properties"></a>

`Exclude`  <a name="cfn-kinesisfirehose-deliverystream-databasetables-exclude"></a>
Property description not available.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Include`  <a name="cfn-kinesisfirehose-deliverystream-databasetables-include"></a>
Property description not available.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream DataFormatConversionConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration"></a>

Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see [Kinesis Data Firehose Record Format Conversion](https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html).

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration-syntax.json"></a>

```
{
  "[Enabled](#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-enabled)" : Boolean,
  "[InputFormatConfiguration](#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-inputformatconfiguration)" : InputFormatConfiguration,
  "[OutputFormatConfiguration](#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-outputformatconfiguration)" : OutputFormatConfiguration,
  "[SchemaConfiguration](#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-schemaconfiguration)" : SchemaConfiguration
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration-syntax.yaml"></a>

```
  [Enabled](#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-enabled): Boolean
  [InputFormatConfiguration](#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-inputformatconfiguration): 
    InputFormatConfiguration
  [OutputFormatConfiguration](#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-outputformatconfiguration): 
    OutputFormatConfiguration
  [SchemaConfiguration](#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-schemaconfiguration): 
    SchemaConfiguration
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration-properties"></a>

`Enabled`  <a name="cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-enabled"></a>
Defaults to `true`. Set it to `false` if you want to disable format conversion while preserving the configuration details.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InputFormatConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-inputformatconfiguration"></a>
Specifies the deserializer that you want Firehose to use to convert the format of your data from JSON. This parameter is required if `Enabled` is set to true.  
*Required*: No  
*Type*: [InputFormatConfiguration](aws-properties-kinesisfirehose-deliverystream-inputformatconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OutputFormatConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-outputformatconfiguration"></a>
Specifies the serializer that you want Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if `Enabled` is set to true.  
*Required*: No  
*Type*: [OutputFormatConfiguration](aws-properties-kinesisfirehose-deliverystream-outputformatconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SchemaConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-schemaconfiguration"></a>
Specifies the AWS Glue Data Catalog table that contains the column information. This parameter is required if `Enabled` is set to true.  
*Required*: No  
*Type*: [SchemaConfiguration](aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream DeliveryStreamEncryptionConfigurationInput
<a name="aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput"></a>

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE). 

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-syntax.json"></a>

```
{
  "[KeyARN](#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-keyarn)" : String,
  "[KeyType](#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-keytype)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-syntax.yaml"></a>

```
  [KeyARN](#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-keyarn): String
  [KeyType](#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-keytype): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-properties"></a>

`KeyARN`  <a name="cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-keyarn"></a>
If you set `KeyType` to `CUSTOMER_MANAGED_CMK`, you must specify the Amazon Resource Name (ARN) of the CMK. If you set `KeyType` to `AWS_OWNED_CMK`, Firehose uses a service-account CMK.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KeyType`  <a name="cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-keytype"></a>
Indicates the type of customer master key (CMK) to use for encryption. The default setting is `AWS_OWNED_CMK`. For more information about CMKs, see [Customer Master Keys (CMKs)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys).   
You can use a CMK of type CUSTOMER\$1MANAGED\$1CMK to encrypt up to 500 delivery streams.  
To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see [About Symmetric and Asymmetric CMKs](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html) in the AWS Key Management Service developer guide.
*Required*: Yes  
*Type*: String  
*Allowed values*: `AWS_OWNED_CMK | CUSTOMER_MANAGED_CMK`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream Deserializer
<a name="aws-properties-kinesisfirehose-deliverystream-deserializer"></a>

The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON. Kinesis Data Firehose then serializes the data to its final format using the `Serializer`. Kinesis Data Firehose supports two types of deserializers: the [Apache Hive JSON SerDe](https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-JSON) and the [OpenX JSON SerDe](https://github.com/rcongiu/Hive-JSON-Serde).

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-deserializer-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-deserializer-syntax.json"></a>

```
{
  "[HiveJsonSerDe](#cfn-kinesisfirehose-deliverystream-deserializer-hivejsonserde)" : HiveJsonSerDe,
  "[OpenXJsonSerDe](#cfn-kinesisfirehose-deliverystream-deserializer-openxjsonserde)" : OpenXJsonSerDe
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-deserializer-syntax.yaml"></a>

```
  [HiveJsonSerDe](#cfn-kinesisfirehose-deliverystream-deserializer-hivejsonserde): 
    HiveJsonSerDe
  [OpenXJsonSerDe](#cfn-kinesisfirehose-deliverystream-deserializer-openxjsonserde): 
    OpenXJsonSerDe
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-deserializer-properties"></a>

`HiveJsonSerDe`  <a name="cfn-kinesisfirehose-deliverystream-deserializer-hivejsonserde"></a>
The native Hive / HCatalog JsonSerDe. Used by 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.  
*Required*: No  
*Type*: [HiveJsonSerDe](aws-properties-kinesisfirehose-deliverystream-hivejsonserde.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OpenXJsonSerDe`  <a name="cfn-kinesisfirehose-deliverystream-deserializer-openxjsonserde"></a>
The OpenX SerDe. Used by 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.  
*Required*: No  
*Type*: [OpenXJsonSerDe](aws-properties-kinesisfirehose-deliverystream-openxjsonserde.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream DestinationTableConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-destinationtableconfiguration"></a>

 Describes the configuration of a destination in Apache Iceberg Tables. This section is only needed for tables where you want to update or delete data. 

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-destinationtableconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-destinationtableconfiguration-syntax.json"></a>

```
{
  "[DestinationDatabaseName](#cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-destinationdatabasename)" : String,
  "[DestinationTableName](#cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-destinationtablename)" : String,
  "[PartitionSpec](#cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-partitionspec)" : PartitionSpec,
  "[S3ErrorOutputPrefix](#cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-s3erroroutputprefix)" : String,
  "[UniqueKeys](#cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-uniquekeys)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-destinationtableconfiguration-syntax.yaml"></a>

```
  [DestinationDatabaseName](#cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-destinationdatabasename): String
  [DestinationTableName](#cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-destinationtablename): String
  [PartitionSpec](#cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-partitionspec): 
    PartitionSpec
  [S3ErrorOutputPrefix](#cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-s3erroroutputprefix): String
  [UniqueKeys](#cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-uniquekeys): 
    - String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-destinationtableconfiguration-properties"></a>

`DestinationDatabaseName`  <a name="cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-destinationdatabasename"></a>
 The name of the Apache Iceberg database.   
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DestinationTableName`  <a name="cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-destinationtablename"></a>
 Specifies the name of the Apache Iceberg Table.   
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PartitionSpec`  <a name="cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-partitionspec"></a>
The partition spec configuration for a table that is used by automatic table creation.  
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: No  
*Type*: [PartitionSpec](aws-properties-kinesisfirehose-deliverystream-partitionspec.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3ErrorOutputPrefix`  <a name="cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-s3erroroutputprefix"></a>
 The table specific S3 error output prefix. All the errors that occurred while delivering to this table will be prefixed with this value in S3 destination.   
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UniqueKeys`  <a name="cfn-kinesisfirehose-deliverystream-destinationtableconfiguration-uniquekeys"></a>
 A list of unique keys for a given Apache Iceberg table. Firehose will use these for running Create, Update, or Delete operations on the given Iceberg table.   
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream DirectPutSourceConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-directputsourceconfiguration"></a>

The structure that configures parameters such as `ThroughputHintInMBs` for a stream configured with Direct PUT as a source. 

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-directputsourceconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-directputsourceconfiguration-syntax.json"></a>

```
{
  "[ThroughputHintInMBs](#cfn-kinesisfirehose-deliverystream-directputsourceconfiguration-throughputhintinmbs)" : Integer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-directputsourceconfiguration-syntax.yaml"></a>

```
  [ThroughputHintInMBs](#cfn-kinesisfirehose-deliverystream-directputsourceconfiguration-throughputhintinmbs): Integer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-directputsourceconfiguration-properties"></a>

`ThroughputHintInMBs`  <a name="cfn-kinesisfirehose-deliverystream-directputsourceconfiguration-throughputhintinmbs"></a>
 The value that you configure for this parameter is for information purpose only and does not affect Firehose delivery throughput limit. You can use the [Firehose Limits form](https://support.console.aws.amazon.com/support/home#/case/create%3FissueType=service-limit-increase%26limitType=kinesis-firehose-limits) to request a throughput limit increase.   
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream DocumentIdOptions
<a name="aws-properties-kinesisfirehose-deliverystream-documentidoptions"></a>

Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.



## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-documentidoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-documentidoptions-syntax.json"></a>

```
{
  "[DefaultDocumentIdFormat](#cfn-kinesisfirehose-deliverystream-documentidoptions-defaultdocumentidformat)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-documentidoptions-syntax.yaml"></a>

```
  [DefaultDocumentIdFormat](#cfn-kinesisfirehose-deliverystream-documentidoptions-defaultdocumentidformat): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-documentidoptions-properties"></a>

`DefaultDocumentIdFormat`  <a name="cfn-kinesisfirehose-deliverystream-documentidoptions-defaultdocumentidformat"></a>
When the `FIREHOSE_DEFAULT` option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.  
When the `NO_DOCUMENT_ID` option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `FIREHOSE_DEFAULT | NO_DOCUMENT_ID`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream DynamicPartitioningConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration"></a>

The `DynamicPartitioningConfiguration` property type specifies the configuration of the dynamic partitioning mechanism that creates targeted data sets from the streaming data by partitioning it based on partition keys.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration-syntax.json"></a>

```
{
  "[Enabled](#cfn-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration-enabled)" : Boolean,
  "[RetryOptions](#cfn-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration-retryoptions)" : RetryOptions
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration-syntax.yaml"></a>

```
  [Enabled](#cfn-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration-enabled): Boolean
  [RetryOptions](#cfn-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration-retryoptions): 
    RetryOptions
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration-properties"></a>

`Enabled`  <a name="cfn-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration-enabled"></a>
Specifies whether dynamic partitioning is enabled for this Kinesis Data Firehose delivery stream.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RetryOptions`  <a name="cfn-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration-retryoptions"></a>
Specifies the retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.  
*Required*: No  
*Type*: [RetryOptions](aws-properties-kinesisfirehose-deliverystream-retryoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream ElasticsearchBufferingHints
<a name="aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints"></a>

The `ElasticsearchBufferingHints` property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose) buffers incoming data while delivering it to the destination. The first buffer condition that is satisfied triggers Kinesis Data Firehose to deliver the data.

ElasticsearchBufferingHints is the property type for the `BufferingHints` property of the [Amazon Kinesis Data Firehose DeliveryStream ElasticsearchDestinationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html) property type.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints-syntax.json"></a>

```
{
  "[IntervalInSeconds](#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-intervalinseconds)" : Integer,
  "[SizeInMBs](#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-sizeinmbs)" : Integer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints-syntax.yaml"></a>

```
  [IntervalInSeconds](#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-intervalinseconds): Integer
  [SizeInMBs](#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-sizeinmbs): Integer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints-properties"></a>

`IntervalInSeconds`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-intervalinseconds"></a>
The length of time, in seconds, that Kinesis Data Firehose buffers incoming data before delivering it to the destination. For valid values, see the `IntervalInSeconds` content for the [BufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html) data type in the *Amazon Kinesis Data Firehose API Reference*.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `900`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SizeInMBs`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-sizeinmbs"></a>
The size of the buffer, in MBs, that Kinesis Data Firehose uses for incoming data before delivering it to the destination. For valid values, see the `SizeInMBs` content for the [BufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html) data type in the *Amazon Kinesis Data Firehose API Reference*.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream ElasticsearchDestinationConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration"></a>

The `ElasticsearchDestinationConfiguration` property type specifies an Amazon Elasticsearch Service (Amazon ES) domain that Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data to.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-syntax.json"></a>

```
{
  "[BufferingHints](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-bufferinghints)" : ElasticsearchBufferingHints,
  "[CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-cloudwatchloggingoptions)" : CloudWatchLoggingOptions,
  "[ClusterEndpoint](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-clusterendpoint)" : String,
  "[DocumentIdOptions](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-documentidoptions)" : DocumentIdOptions,
  "[DomainARN](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-domainarn)" : String,
  "[IndexName](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexname)" : String,
  "[IndexRotationPeriod](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexrotationperiod)" : String,
  "[ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-processingconfiguration)" : ProcessingConfiguration,
  "[RetryOptions](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-retryoptions)" : ElasticsearchRetryOptions,
  "[RoleARN](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-rolearn)" : String,
  "[S3BackupMode](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3backupmode)" : String,
  "[S3Configuration](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3configuration)" : S3DestinationConfiguration,
  "[TypeName](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-typename)" : String,
  "[VpcConfiguration](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-vpcconfiguration)" : VpcConfiguration
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-syntax.yaml"></a>

```
  [BufferingHints](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-bufferinghints): 
    ElasticsearchBufferingHints
  [CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-cloudwatchloggingoptions): 
    CloudWatchLoggingOptions
  [ClusterEndpoint](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-clusterendpoint): String
  [DocumentIdOptions](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-documentidoptions): 
    DocumentIdOptions
  [DomainARN](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-domainarn): String
  [IndexName](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexname): String
  [IndexRotationPeriod](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexrotationperiod): String
  [ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-processingconfiguration): 
    ProcessingConfiguration
  [RetryOptions](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-retryoptions): 
    ElasticsearchRetryOptions
  [RoleARN](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-rolearn): String
  [S3BackupMode](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3backupmode): String
  [S3Configuration](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3configuration): 
    S3DestinationConfiguration
  [TypeName](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-typename): String
  [VpcConfiguration](#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-vpcconfiguration): 
    VpcConfiguration
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-properties"></a>

`BufferingHints`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-bufferinghints"></a>
Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.  
*Required*: No  
*Type*: [ElasticsearchBufferingHints](aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CloudWatchLoggingOptions`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-cloudwatchloggingoptions"></a>
The Amazon CloudWatch Logs logging options for the delivery stream.  
*Required*: No  
*Type*: [CloudWatchLoggingOptions](aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClusterEndpoint`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-clusterendpoint"></a>
The endpoint to use when communicating with the cluster. Specify either this `ClusterEndpoint` or the `DomainARN` field.  
*Required*: No  
*Type*: String  
*Pattern*: `https:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DocumentIdOptions`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-documentidoptions"></a>
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.  
*Required*: No  
*Type*: [DocumentIdOptions](aws-properties-kinesisfirehose-deliverystream-documentidoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DomainARN`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-domainarn"></a>
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**.  
Specify either `ClusterEndpoint` or `DomainARN`.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IndexName`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexname"></a>
The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `80`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IndexRotationPeriod`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexrotationperiod"></a>
The frequency of Elasticsearch index rotation. If you enable index rotation, Kinesis Data Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see [Index Rotation for the Amazon ES Destination](https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation) in the *Amazon Kinesis Data Firehose Developer Guide*.  
*Required*: No  
*Type*: String  
*Allowed values*: `NoRotation | OneHour | OneDay | OneWeek | OneMonth`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProcessingConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-processingconfiguration"></a>
The data processing configuration for the Kinesis Data Firehose delivery stream.  
*Required*: No  
*Type*: [ProcessingConfiguration](aws-properties-kinesisfirehose-deliverystream-processingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RetryOptions`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-retryoptions"></a>
The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.  
*Required*: No  
*Type*: [ElasticsearchRetryOptions](aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleARN`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-rolearn"></a>
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 [Controlling Access with Amazon Kinesis Data Firehose](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html).  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3BackupMode`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3backupmode"></a>
The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3). You can send Amazon S3 all documents (all data) or only the documents that Kinesis Data Firehose could not deliver to the Amazon ES destination. For more information and valid values, see the `S3BackupMode` content for the [ElasticsearchDestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchDestinationConfiguration.html) data type in the *Amazon Kinesis Data Firehose API Reference*.  
*Required*: No  
*Type*: String  
*Allowed values*: `FailedDocumentsOnly | AllDocuments`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Configuration`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3configuration"></a>
The S3 bucket where Kinesis Data Firehose backs up incoming data.  
*Required*: Yes  
*Type*: [S3DestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TypeName`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-typename"></a>
The Elasticsearch type name that Amazon ES adds to documents when indexing data.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-vpcconfiguration"></a>
The details of the VPC of the Amazon ES destination.  
*Required*: No  
*Type*: [VpcConfiguration](aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream ElasticsearchRetryOptions
<a name="aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions"></a>

The `ElasticsearchRetryOptions` property type configures the retry behavior for when Amazon Kinesis Data Firehose (Kinesis Data Firehose) can't deliver data to Amazon Elasticsearch Service (Amazon ES).

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions-syntax.json"></a>

```
{
  "[DurationInSeconds](#cfn-kinesisfirehose-deliverystream-elasticsearchretryoptions-durationinseconds)" : Integer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions-syntax.yaml"></a>

```
  [DurationInSeconds](#cfn-kinesisfirehose-deliverystream-elasticsearchretryoptions-durationinseconds): Integer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions-properties"></a>

`DurationInSeconds`  <a name="cfn-kinesisfirehose-deliverystream-elasticsearchretryoptions-durationinseconds"></a>
After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose re-attempts delivery (including the first attempt). If Kinesis Data Firehose can't deliver the data within the specified time, it writes the data to the backup S3 bucket. For valid values, see the `DurationInSeconds` content for the [ElasticsearchRetryOptions](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchRetryOptions.html) data type in the *Amazon Kinesis Data Firehose API Reference*.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `7200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream EncryptionConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration"></a>

The `EncryptionConfiguration` property type specifies the encryption settings that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses when delivering data to Amazon Simple Storage Service (Amazon S3).

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration-syntax.json"></a>

```
{
  "[KMSEncryptionConfig](#cfn-kinesisfirehose-deliverystream-encryptionconfiguration-kmsencryptionconfig)" : KMSEncryptionConfig,
  "[NoEncryptionConfig](#cfn-kinesisfirehose-deliverystream-encryptionconfiguration-noencryptionconfig)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration-syntax.yaml"></a>

```
  [KMSEncryptionConfig](#cfn-kinesisfirehose-deliverystream-encryptionconfiguration-kmsencryptionconfig): 
    KMSEncryptionConfig
  [NoEncryptionConfig](#cfn-kinesisfirehose-deliverystream-encryptionconfiguration-noencryptionconfig): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration-properties"></a>

`KMSEncryptionConfig`  <a name="cfn-kinesisfirehose-deliverystream-encryptionconfiguration-kmsencryptionconfig"></a>
The AWS Key Management Service (AWS KMS) encryption key that Amazon S3 uses to encrypt your data.  
*Required*: No  
*Type*: [KMSEncryptionConfig](aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NoEncryptionConfig`  <a name="cfn-kinesisfirehose-deliverystream-encryptionconfiguration-noencryptionconfig"></a>
Disables encryption. For valid values, see the `NoEncryptionConfig` content for the [EncryptionConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_EncryptionConfiguration.html) data type in the *Amazon Kinesis Data Firehose API Reference*.  
*Required*: No  
*Type*: String  
*Allowed values*: `NoEncryption`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream ExtendedS3DestinationConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration"></a>

The `ExtendedS3DestinationConfiguration` property type configures an Amazon S3 destination for an Amazon Kinesis Data Firehose delivery stream.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-syntax.json"></a>

```
{
  "[BucketARN](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bucketarn)" : String,
  "[BufferingHints](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bufferinghints)" : BufferingHints,
  "[CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-cloudwatchloggingoptions)" : CloudWatchLoggingOptions,
  "[CompressionFormat](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-compressionformat)" : String,
  "[CustomTimeZone](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-customtimezone)" : String,
  "[DataFormatConversionConfiguration](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-dataformatconversionconfiguration)" : DataFormatConversionConfiguration,
  "[DynamicPartitioningConfiguration](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-dynamicpartitioningconfiguration)" : DynamicPartitioningConfiguration,
  "[EncryptionConfiguration](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-encryptionconfiguration)" : EncryptionConfiguration,
  "[ErrorOutputPrefix](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-erroroutputprefix)" : String,
  "[FileExtension](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-fileextension)" : String,
  "[Prefix](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-prefix)" : String,
  "[ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-processingconfiguration)" : ProcessingConfiguration,
  "[RoleARN](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-rolearn)" : String,
  "[S3BackupConfiguration](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupconfiguration)" : S3DestinationConfiguration,
  "[S3BackupMode](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupmode)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-syntax.yaml"></a>

```
  [BucketARN](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bucketarn): String
  [BufferingHints](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bufferinghints): 
    BufferingHints
  [CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-cloudwatchloggingoptions): 
    CloudWatchLoggingOptions
  [CompressionFormat](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-compressionformat): String
  [CustomTimeZone](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-customtimezone): String
  [DataFormatConversionConfiguration](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-dataformatconversionconfiguration): 
    DataFormatConversionConfiguration
  [DynamicPartitioningConfiguration](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-dynamicpartitioningconfiguration): 
    DynamicPartitioningConfiguration
  [EncryptionConfiguration](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-encryptionconfiguration): 
    EncryptionConfiguration
  [ErrorOutputPrefix](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-erroroutputprefix): String
  [FileExtension](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-fileextension): String
  [Prefix](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-prefix): String
  [ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-processingconfiguration): 
    ProcessingConfiguration
  [RoleARN](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-rolearn): String
  [S3BackupConfiguration](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupconfiguration): 
    S3DestinationConfiguration
  [S3BackupMode](#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupmode): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-properties"></a>

`BucketARN`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bucketarn"></a>
The Amazon Resource Name (ARN) of the Amazon S3 bucket. For constraints, see [ExtendedS3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.html) in the *Amazon Kinesis Data Firehose API Reference*.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BufferingHints`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bufferinghints"></a>
The buffering option.  
*Required*: No  
*Type*: [BufferingHints](aws-properties-kinesisfirehose-deliverystream-bufferinghints.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CloudWatchLoggingOptions`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-cloudwatchloggingoptions"></a>
The Amazon CloudWatch logging options for your Firehose stream.  
*Required*: No  
*Type*: [CloudWatchLoggingOptions](aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CompressionFormat`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-compressionformat"></a>
The compression format. If no value is specified, the default is `UNCOMPRESSED`.  
*Required*: No  
*Type*: String  
*Allowed values*: `UNCOMPRESSED | GZIP | ZIP | Snappy | HADOOP_SNAPPY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomTimeZone`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-customtimezone"></a>
The time zone you prefer. UTC is the default.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DataFormatConversionConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-dataformatconversionconfiguration"></a>
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.  
*Required*: No  
*Type*: [DataFormatConversionConfiguration](aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DynamicPartitioningConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-dynamicpartitioningconfiguration"></a>
The configuration of the dynamic partitioning mechanism that creates targeted data sets from the streaming data by partitioning it based on partition keys.  
*Required*: No  
*Type*: [DynamicPartitioningConfiguration](aws-properties-kinesisfirehose-deliverystream-dynamicpartitioningconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EncryptionConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-encryptionconfiguration"></a>
The encryption configuration for the Kinesis Data Firehose delivery stream. The default value is `NoEncryption`.  
*Required*: No  
*Type*: [EncryptionConfiguration](aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ErrorOutputPrefix`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-erroroutputprefix"></a>
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see [Custom Prefixes for Amazon S3 Objects](https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html).  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FileExtension`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-fileextension"></a>
Specify a file extension. It will override the default file extension  
*Required*: No  
*Type*: String  
*Pattern*: `^$|\.[0-9a-z!\-_.*'()]+`  
*Minimum*: `0`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Prefix`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-prefix"></a>
The `YYYY/MM/DD/HH` time format prefix is automatically used for delivered Amazon S3 files. For more information, see [ExtendedS3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.html) in the *Amazon Kinesis Data Firehose API Reference*.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProcessingConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-processingconfiguration"></a>
The data processing configuration for the Kinesis Data Firehose delivery stream.  
*Required*: No  
*Type*: [ProcessingConfiguration](aws-properties-kinesisfirehose-deliverystream-processingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleARN`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-rolearn"></a>
The Amazon Resource Name (ARN) of the AWS credentials. For constraints, see [ExtendedS3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.html) in the *Amazon Kinesis Data Firehose API Reference*.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3BackupConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupconfiguration"></a>
The configuration for backup in Amazon S3.  
*Required*: No  
*Type*: [S3DestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3BackupMode`  <a name="cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupmode"></a>
The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.   
*Required*: No  
*Type*: String  
*Allowed values*: `Disabled | Enabled`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream HiveJsonSerDe
<a name="aws-properties-kinesisfirehose-deliverystream-hivejsonserde"></a>

The native Hive / HCatalog JsonSerDe. Used by 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.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-hivejsonserde-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-hivejsonserde-syntax.json"></a>

```
{
  "[TimestampFormats](#cfn-kinesisfirehose-deliverystream-hivejsonserde-timestampformats)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-hivejsonserde-syntax.yaml"></a>

```
  [TimestampFormats](#cfn-kinesisfirehose-deliverystream-hivejsonserde-timestampformats): 
    - String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-hivejsonserde-properties"></a>

`TimestampFormats`  <a name="cfn-kinesisfirehose-deliverystream-hivejsonserde-timestampformats"></a>
Indicates how you want Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see [Class DateTimeFormat](https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html). You can also use the special value `millis` to parse timestamps in epoch milliseconds. If you don't specify a format, Firehose uses `java.sql.Timestamp::valueOf` by default.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream HttpEndpointCommonAttribute
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointcommonattribute"></a>

Describes the metadata that's delivered to the specified HTTP endpoint destination. Kinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers, including Datadog, MongoDB, and New Relic.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointcommonattribute-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointcommonattribute-syntax.json"></a>

```
{
  "[AttributeName](#cfn-kinesisfirehose-deliverystream-httpendpointcommonattribute-attributename)" : String,
  "[AttributeValue](#cfn-kinesisfirehose-deliverystream-httpendpointcommonattribute-attributevalue)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointcommonattribute-syntax.yaml"></a>

```
  [AttributeName](#cfn-kinesisfirehose-deliverystream-httpendpointcommonattribute-attributename): String
  [AttributeValue](#cfn-kinesisfirehose-deliverystream-httpendpointcommonattribute-attributevalue): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointcommonattribute-properties"></a>

`AttributeName`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointcommonattribute-attributename"></a>
The name of the HTTP endpoint common attribute.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AttributeValue`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointcommonattribute-attributevalue"></a>
The value of the HTTP endpoint common attribute.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream HttpEndpointConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration"></a>

Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data. Kinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers, including Datadog, MongoDB, and New Relic.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration-syntax.json"></a>

```
{
  "[AccessKey](#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-accesskey)" : String,
  "[Name](#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-name)" : String,
  "[Url](#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-url)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration-syntax.yaml"></a>

```
  [AccessKey](#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-accesskey): String
  [Name](#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-name): String
  [Url](#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-url): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration-properties"></a>

`AccessKey`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-accesskey"></a>
The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `4096`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-name"></a>
The name of the HTTP endpoint selected as the destination.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Url`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-url"></a>
The URL of the HTTP endpoint selected as the destination.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream HttpEndpointDestinationConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration"></a>

Describes the configuration of the HTTP endpoint destination. Kinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers, including Datadog, MongoDB, and New Relic.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-syntax.json"></a>

```
{
  "[BufferingHints](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-bufferinghints)" : BufferingHints,
  "[CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-cloudwatchloggingoptions)" : CloudWatchLoggingOptions,
  "[EndpointConfiguration](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-endpointconfiguration)" : HttpEndpointConfiguration,
  "[ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-processingconfiguration)" : ProcessingConfiguration,
  "[RequestConfiguration](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-requestconfiguration)" : HttpEndpointRequestConfiguration,
  "[RetryOptions](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-retryoptions)" : RetryOptions,
  "[RoleARN](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-rolearn)" : String,
  "[S3BackupMode](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-s3backupmode)" : String,
  "[S3Configuration](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-s3configuration)" : S3DestinationConfiguration,
  "[SecretsManagerConfiguration](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-secretsmanagerconfiguration)" : SecretsManagerConfiguration
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-syntax.yaml"></a>

```
  [BufferingHints](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-bufferinghints): 
    BufferingHints
  [CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-cloudwatchloggingoptions): 
    CloudWatchLoggingOptions
  [EndpointConfiguration](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-endpointconfiguration): 
    HttpEndpointConfiguration
  [ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-processingconfiguration): 
    ProcessingConfiguration
  [RequestConfiguration](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-requestconfiguration): 
    HttpEndpointRequestConfiguration
  [RetryOptions](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-retryoptions): 
    RetryOptions
  [RoleARN](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-rolearn): String
  [S3BackupMode](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-s3backupmode): String
  [S3Configuration](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-s3configuration): 
    S3DestinationConfiguration
  [SecretsManagerConfiguration](#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-secretsmanagerconfiguration): 
    SecretsManagerConfiguration
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-properties"></a>

`BufferingHints`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-bufferinghints"></a>
The buffering options that can be used before data is delivered to the specified destination. Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if you specify a value for one of them, you must also provide a value for the other.  
*Required*: No  
*Type*: [BufferingHints](aws-properties-kinesisfirehose-deliverystream-bufferinghints.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CloudWatchLoggingOptions`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-cloudwatchloggingoptions"></a>
Describes the Amazon CloudWatch logging options for your delivery stream.  
*Required*: No  
*Type*: [CloudWatchLoggingOptions](aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EndpointConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-endpointconfiguration"></a>
The configuration of the HTTP endpoint selected as the destination.  
*Required*: Yes  
*Type*: [HttpEndpointConfiguration](aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProcessingConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-processingconfiguration"></a>
Describes the data processing configuration.  
*Required*: No  
*Type*: [ProcessingConfiguration](aws-properties-kinesisfirehose-deliverystream-processingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RequestConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-requestconfiguration"></a>
The configuration of the request sent to the HTTP endpoint specified as the destination.  
*Required*: No  
*Type*: [HttpEndpointRequestConfiguration](aws-properties-kinesisfirehose-deliverystream-httpendpointrequestconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RetryOptions`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-retryoptions"></a>
Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.  
*Required*: No  
*Type*: [RetryOptions](aws-properties-kinesisfirehose-deliverystream-retryoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleARN`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-rolearn"></a>
Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3BackupMode`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-s3backupmode"></a>
Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).  
*Required*: No  
*Type*: String  
*Allowed values*: `FailedDataOnly | AllData`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Configuration`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-s3configuration"></a>
Describes the configuration of a destination in Amazon S3.  
*Required*: Yes  
*Type*: [S3DestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecretsManagerConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-secretsmanagerconfiguration"></a>
 The configuration that defines how you access secrets for HTTP Endpoint destination.   
*Required*: No  
*Type*: [SecretsManagerConfiguration](aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream HttpEndpointRequestConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointrequestconfiguration"></a>

The configuration of the HTTP endpoint request. Kinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers, including Datadog, MongoDB, and New Relic.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-syntax.json"></a>

```
{
  "[CommonAttributes](#cfn-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-commonattributes)" : [ HttpEndpointCommonAttribute, ... ],
  "[ContentEncoding](#cfn-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-contentencoding)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-syntax.yaml"></a>

```
  [CommonAttributes](#cfn-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-commonattributes): 
    - HttpEndpointCommonAttribute
  [ContentEncoding](#cfn-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-contentencoding): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-properties"></a>

`CommonAttributes`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-commonattributes"></a>
Describes the metadata sent to the HTTP endpoint destination.  
*Required*: No  
*Type*: Array of [HttpEndpointCommonAttribute](aws-properties-kinesisfirehose-deliverystream-httpendpointcommonattribute.md)  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ContentEncoding`  <a name="cfn-kinesisfirehose-deliverystream-httpendpointrequestconfiguration-contentencoding"></a>
Kinesis Data Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.  
*Required*: No  
*Type*: String  
*Allowed values*: `NONE | GZIP`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream IcebergDestinationConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration"></a>

 Specifies the destination configure settings for Apache Iceberg Table. 

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration-syntax.json"></a>

```
{
  "[AppendOnly](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-appendonly)" : Boolean,
  "[BufferingHints](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-bufferinghints)" : BufferingHints,
  "[CatalogConfiguration](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-catalogconfiguration)" : CatalogConfiguration,
  "[CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-cloudwatchloggingoptions)" : CloudWatchLoggingOptions,
  "[DestinationTableConfigurationList](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-destinationtableconfigurationlist)" : [ DestinationTableConfiguration, ... ],
  "[ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-processingconfiguration)" : ProcessingConfiguration,
  "[RetryOptions](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-retryoptions)" : RetryOptions,
  "[RoleARN](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-rolearn)" : String,
  "[s3BackupMode](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-s3backupmode)" : String,
  "[S3Configuration](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-s3configuration)" : S3DestinationConfiguration,
  "[SchemaEvolutionConfiguration](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-schemaevolutionconfiguration)" : SchemaEvolutionConfiguration,
  "[TableCreationConfiguration](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-tablecreationconfiguration)" : TableCreationConfiguration
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration-syntax.yaml"></a>

```
  [AppendOnly](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-appendonly): Boolean
  [BufferingHints](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-bufferinghints): 
    BufferingHints
  [CatalogConfiguration](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-catalogconfiguration): 
    CatalogConfiguration
  [CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-cloudwatchloggingoptions): 
    CloudWatchLoggingOptions
  [DestinationTableConfigurationList](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-destinationtableconfigurationlist): 
    - DestinationTableConfiguration
  [ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-processingconfiguration): 
    ProcessingConfiguration
  [RetryOptions](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-retryoptions): 
    RetryOptions
  [RoleARN](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-rolearn): String
  [s3BackupMode](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-s3backupmode): String
  [S3Configuration](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-s3configuration): 
    S3DestinationConfiguration
  [SchemaEvolutionConfiguration](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-schemaevolutionconfiguration): 
    SchemaEvolutionConfiguration
  [TableCreationConfiguration](#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-tablecreationconfiguration): 
    TableCreationConfiguration
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-icebergdestinationconfiguration-properties"></a>

`AppendOnly`  <a name="cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-appendonly"></a>
 Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only applicable for Apache Iceberg Tables.  
The default value is false. If you set this value to true, Firehose automatically increases the throughput limit of a stream based on the throttling levels of the stream. If you set this parameter to true for a stream with updates and deletes, you will see out of order delivery.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BufferingHints`  <a name="cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-bufferinghints"></a>
Property description not available.  
*Required*: No  
*Type*: [BufferingHints](aws-properties-kinesisfirehose-deliverystream-bufferinghints.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CatalogConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-catalogconfiguration"></a>
 Configuration describing where the destination Apache Iceberg Tables are persisted.   
*Required*: Yes  
*Type*: [CatalogConfiguration](aws-properties-kinesisfirehose-deliverystream-catalogconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`CloudWatchLoggingOptions`  <a name="cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-cloudwatchloggingoptions"></a>
Property description not available.  
*Required*: No  
*Type*: [CloudWatchLoggingOptions](aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DestinationTableConfigurationList`  <a name="cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-destinationtableconfigurationlist"></a>
 Provides a list of `DestinationTableConfigurations` which Firehose uses to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here.  
*Required*: No  
*Type*: Array of [DestinationTableConfiguration](aws-properties-kinesisfirehose-deliverystream-destinationtableconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProcessingConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-processingconfiguration"></a>
Property description not available.  
*Required*: No  
*Type*: [ProcessingConfiguration](aws-properties-kinesisfirehose-deliverystream-processingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RetryOptions`  <a name="cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-retryoptions"></a>
Property description not available.  
*Required*: No  
*Type*: [RetryOptions](aws-properties-kinesisfirehose-deliverystream-retryoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleARN`  <a name="cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-rolearn"></a>
 The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.   
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`s3BackupMode`  <a name="cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-s3backupmode"></a>
 Describes how Firehose will backup records. Currently,S3 backup only supports `FailedDataOnly`.   
*Required*: No  
*Type*: String  
*Allowed values*: `AllData | FailedDataOnly`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Configuration`  <a name="cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-s3configuration"></a>
Property description not available.  
*Required*: Yes  
*Type*: [S3DestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SchemaEvolutionConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-schemaevolutionconfiguration"></a>
The configuration to enable automatic schema evolution.  
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: No  
*Type*: [SchemaEvolutionConfiguration](aws-properties-kinesisfirehose-deliverystream-schemaevolutionconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TableCreationConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration-tablecreationconfiguration"></a>
The configuration to enable automatic table creation.  
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: No  
*Type*: [TableCreationConfiguration](aws-properties-kinesisfirehose-deliverystream-tablecreationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream InputFormatConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-inputformatconfiguration"></a>

Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if `Enabled` is set to true.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-inputformatconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-inputformatconfiguration-syntax.json"></a>

```
{
  "[Deserializer](#cfn-kinesisfirehose-deliverystream-inputformatconfiguration-deserializer)" : Deserializer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-inputformatconfiguration-syntax.yaml"></a>

```
  [Deserializer](#cfn-kinesisfirehose-deliverystream-inputformatconfiguration-deserializer): 
    Deserializer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-inputformatconfiguration-properties"></a>

`Deserializer`  <a name="cfn-kinesisfirehose-deliverystream-inputformatconfiguration-deserializer"></a>
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.  
*Required*: No  
*Type*: [Deserializer](aws-properties-kinesisfirehose-deliverystream-deserializer.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream KinesisStreamSourceConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration"></a>

The `KinesisStreamSourceConfiguration` property type specifies the stream and role Amazon Resource Names (ARNs) for a Kinesis stream used as the source for a delivery stream.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-syntax.json"></a>

```
{
  "[KinesisStreamARN](#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-kinesisstreamarn)" : String,
  "[RoleARN](#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-rolearn)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-syntax.yaml"></a>

```
  [KinesisStreamARN](#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-kinesisstreamarn): String
  [RoleARN](#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-rolearn): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-properties"></a>

`KinesisStreamARN`  <a name="cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-kinesisstreamarn"></a>
The ARN of the source Kinesis data stream.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RoleARN`  <a name="cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-rolearn"></a>
The ARN of the role that provides access to the source Kinesis data stream.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream KMSEncryptionConfig
<a name="aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig"></a>

The `KMSEncryptionConfig` property type specifies the AWS Key Management Service (AWS KMS) encryption key that Amazon Simple Storage Service (Amazon S3) uses to encrypt data delivered by the Amazon Kinesis Data Firehose (Kinesis Data Firehose) stream.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig-syntax.json"></a>

```
{
  "[AWSKMSKeyARN](#cfn-kinesisfirehose-deliverystream-kmsencryptionconfig-awskmskeyarn)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig-syntax.yaml"></a>

```
  [AWSKMSKeyARN](#cfn-kinesisfirehose-deliverystream-kmsencryptionconfig-awskmskeyarn): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig-properties"></a>

`AWSKMSKeyARN`  <a name="cfn-kinesisfirehose-deliverystream-kmsencryptionconfig-awskmskeyarn"></a>
The Amazon Resource Name (ARN) of the AWS KMS encryption key that Amazon S3 uses to encrypt data delivered by the Kinesis Data Firehose stream. The key must belong to the same region as the destination S3 bucket.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*:kms:[a-zA-Z0-9\-]+:\d{12}:key/[a-zA-Z_0-9+=,.@\-_/]+`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream MSKSourceConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration"></a>

The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration-syntax.json"></a>

```
{
  "[AuthenticationConfiguration](#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-authenticationconfiguration)" : AuthenticationConfiguration,
  "[MSKClusterARN](#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-mskclusterarn)" : String,
  "[ReadFromTimestamp](#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-readfromtimestamp)" : String,
  "[TopicName](#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-topicname)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration-syntax.yaml"></a>

```
  [AuthenticationConfiguration](#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-authenticationconfiguration): 
    AuthenticationConfiguration
  [MSKClusterARN](#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-mskclusterarn): String
  [ReadFromTimestamp](#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-readfromtimestamp): String
  [TopicName](#cfn-kinesisfirehose-deliverystream-msksourceconfiguration-topicname): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-msksourceconfiguration-properties"></a>

`AuthenticationConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-msksourceconfiguration-authenticationconfiguration"></a>
The authentication configuration of the Amazon MSK cluster.  
*Required*: Yes  
*Type*: [AuthenticationConfiguration](aws-properties-kinesisfirehose-deliverystream-authenticationconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MSKClusterARN`  <a name="cfn-kinesisfirehose-deliverystream-msksourceconfiguration-mskclusterarn"></a>
The ARN of the Amazon MSK cluster.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ReadFromTimestamp`  <a name="cfn-kinesisfirehose-deliverystream-msksourceconfiguration-readfromtimestamp"></a>
The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.   
If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the `ReadFromTimestamp` parameter to Epoch (1970-01-01T00:00:00Z).   
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TopicName`  <a name="cfn-kinesisfirehose-deliverystream-msksourceconfiguration-topicname"></a>
The topic name within the Amazon MSK cluster.   
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-zA-Z0-9\._\-]+`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream OpenXJsonSerDe
<a name="aws-properties-kinesisfirehose-deliverystream-openxjsonserde"></a>

The OpenX SerDe. Used by 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.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-openxjsonserde-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-openxjsonserde-syntax.json"></a>

```
{
  "[CaseInsensitive](#cfn-kinesisfirehose-deliverystream-openxjsonserde-caseinsensitive)" : Boolean,
  "[ColumnToJsonKeyMappings](#cfn-kinesisfirehose-deliverystream-openxjsonserde-columntojsonkeymappings)" : {Key: Value, ...},
  "[ConvertDotsInJsonKeysToUnderscores](#cfn-kinesisfirehose-deliverystream-openxjsonserde-convertdotsinjsonkeystounderscores)" : Boolean
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-openxjsonserde-syntax.yaml"></a>

```
  [CaseInsensitive](#cfn-kinesisfirehose-deliverystream-openxjsonserde-caseinsensitive): Boolean
  [ColumnToJsonKeyMappings](#cfn-kinesisfirehose-deliverystream-openxjsonserde-columntojsonkeymappings): 
    Key: Value
  [ConvertDotsInJsonKeysToUnderscores](#cfn-kinesisfirehose-deliverystream-openxjsonserde-convertdotsinjsonkeystounderscores): Boolean
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-openxjsonserde-properties"></a>

`CaseInsensitive`  <a name="cfn-kinesisfirehose-deliverystream-openxjsonserde-caseinsensitive"></a>
When set to `true`, which is the default, Firehose converts JSON keys to lowercase before deserializing them.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ColumnToJsonKeyMappings`  <a name="cfn-kinesisfirehose-deliverystream-openxjsonserde-columntojsonkeymappings"></a>
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`.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `[a-zA-Z0-9]+`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConvertDotsInJsonKeysToUnderscores`  <a name="cfn-kinesisfirehose-deliverystream-openxjsonserde-convertdotsinjsonkeystounderscores"></a>
When set to `true`, specifies that the names of the keys include dots and that you want 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\$1b" when using this option.  
The default is `false`.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream OrcSerDe
<a name="aws-properties-kinesisfirehose-deliverystream-orcserde"></a>

A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see [Apache ORC](https://orc.apache.org/docs/).

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-orcserde-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-orcserde-syntax.json"></a>

```
{
  "[BlockSizeBytes](#cfn-kinesisfirehose-deliverystream-orcserde-blocksizebytes)" : Integer,
  "[BloomFilterColumns](#cfn-kinesisfirehose-deliverystream-orcserde-bloomfiltercolumns)" : [ String, ... ],
  "[BloomFilterFalsePositiveProbability](#cfn-kinesisfirehose-deliverystream-orcserde-bloomfilterfalsepositiveprobability)" : Number,
  "[Compression](#cfn-kinesisfirehose-deliverystream-orcserde-compression)" : String,
  "[DictionaryKeyThreshold](#cfn-kinesisfirehose-deliverystream-orcserde-dictionarykeythreshold)" : Number,
  "[EnablePadding](#cfn-kinesisfirehose-deliverystream-orcserde-enablepadding)" : Boolean,
  "[FormatVersion](#cfn-kinesisfirehose-deliverystream-orcserde-formatversion)" : String,
  "[PaddingTolerance](#cfn-kinesisfirehose-deliverystream-orcserde-paddingtolerance)" : Number,
  "[RowIndexStride](#cfn-kinesisfirehose-deliverystream-orcserde-rowindexstride)" : Integer,
  "[StripeSizeBytes](#cfn-kinesisfirehose-deliverystream-orcserde-stripesizebytes)" : Integer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-orcserde-syntax.yaml"></a>

```
  [BlockSizeBytes](#cfn-kinesisfirehose-deliverystream-orcserde-blocksizebytes): Integer
  [BloomFilterColumns](#cfn-kinesisfirehose-deliverystream-orcserde-bloomfiltercolumns): 
    - String
  [BloomFilterFalsePositiveProbability](#cfn-kinesisfirehose-deliverystream-orcserde-bloomfilterfalsepositiveprobability): Number
  [Compression](#cfn-kinesisfirehose-deliverystream-orcserde-compression): String
  [DictionaryKeyThreshold](#cfn-kinesisfirehose-deliverystream-orcserde-dictionarykeythreshold): Number
  [EnablePadding](#cfn-kinesisfirehose-deliverystream-orcserde-enablepadding): Boolean
  [FormatVersion](#cfn-kinesisfirehose-deliverystream-orcserde-formatversion): String
  [PaddingTolerance](#cfn-kinesisfirehose-deliverystream-orcserde-paddingtolerance): Number
  [RowIndexStride](#cfn-kinesisfirehose-deliverystream-orcserde-rowindexstride): Integer
  [StripeSizeBytes](#cfn-kinesisfirehose-deliverystream-orcserde-stripesizebytes): Integer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-orcserde-properties"></a>

`BlockSizeBytes`  <a name="cfn-kinesisfirehose-deliverystream-orcserde-blocksizebytes"></a>
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. Firehose uses this value for padding calculations.  
*Required*: No  
*Type*: Integer  
*Minimum*: `67108864`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BloomFilterColumns`  <a name="cfn-kinesisfirehose-deliverystream-orcserde-bloomfiltercolumns"></a>
The column names for which you want Firehose to create bloom filters. The default is `null`.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BloomFilterFalsePositiveProbability`  <a name="cfn-kinesisfirehose-deliverystream-orcserde-bloomfilterfalsepositiveprobability"></a>
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.  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Compression`  <a name="cfn-kinesisfirehose-deliverystream-orcserde-compression"></a>
The compression code to use over data blocks. The default is `SNAPPY`.  
*Required*: No  
*Type*: String  
*Allowed values*: `NONE | ZLIB | SNAPPY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DictionaryKeyThreshold`  <a name="cfn-kinesisfirehose-deliverystream-orcserde-dictionarykeythreshold"></a>
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.  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnablePadding`  <a name="cfn-kinesisfirehose-deliverystream-orcserde-enablepadding"></a>
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`.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FormatVersion`  <a name="cfn-kinesisfirehose-deliverystream-orcserde-formatversion"></a>
The version of the file to write. The possible values are `V0_11` and `V0_12`. The default is `V0_12`.  
*Required*: No  
*Type*: String  
*Allowed values*: `V0_11 | V0_12`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PaddingTolerance`  <a name="cfn-kinesisfirehose-deliverystream-orcserde-paddingtolerance"></a>
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 `EnablePadding` is `false`.  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RowIndexStride`  <a name="cfn-kinesisfirehose-deliverystream-orcserde-rowindexstride"></a>
The number of rows between index entries. The default is 10,000 and the minimum is 1,000.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StripeSizeBytes`  <a name="cfn-kinesisfirehose-deliverystream-orcserde-stripesizebytes"></a>
The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.  
*Required*: No  
*Type*: Integer  
*Minimum*: `8388608`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream OutputFormatConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-outputformatconfiguration"></a>

Specifies the serializer that you want Firehose to use to convert the format of your data before it writes it to Amazon S3. This parameter is required if `Enabled` is set to true.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-outputformatconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-outputformatconfiguration-syntax.json"></a>

```
{
  "[Serializer](#cfn-kinesisfirehose-deliverystream-outputformatconfiguration-serializer)" : Serializer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-outputformatconfiguration-syntax.yaml"></a>

```
  [Serializer](#cfn-kinesisfirehose-deliverystream-outputformatconfiguration-serializer): 
    Serializer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-outputformatconfiguration-properties"></a>

`Serializer`  <a name="cfn-kinesisfirehose-deliverystream-outputformatconfiguration-serializer"></a>
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.  
*Required*: No  
*Type*: [Serializer](aws-properties-kinesisfirehose-deliverystream-serializer.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream ParquetSerDe
<a name="aws-properties-kinesisfirehose-deliverystream-parquetserde"></a>

A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see [Apache Parquet](https://parquet.apache.org/docs/).

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-parquetserde-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-parquetserde-syntax.json"></a>

```
{
  "[BlockSizeBytes](#cfn-kinesisfirehose-deliverystream-parquetserde-blocksizebytes)" : Integer,
  "[Compression](#cfn-kinesisfirehose-deliverystream-parquetserde-compression)" : String,
  "[EnableDictionaryCompression](#cfn-kinesisfirehose-deliverystream-parquetserde-enabledictionarycompression)" : Boolean,
  "[MaxPaddingBytes](#cfn-kinesisfirehose-deliverystream-parquetserde-maxpaddingbytes)" : Integer,
  "[PageSizeBytes](#cfn-kinesisfirehose-deliverystream-parquetserde-pagesizebytes)" : Integer,
  "[WriterVersion](#cfn-kinesisfirehose-deliverystream-parquetserde-writerversion)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-parquetserde-syntax.yaml"></a>

```
  [BlockSizeBytes](#cfn-kinesisfirehose-deliverystream-parquetserde-blocksizebytes): Integer
  [Compression](#cfn-kinesisfirehose-deliverystream-parquetserde-compression): String
  [EnableDictionaryCompression](#cfn-kinesisfirehose-deliverystream-parquetserde-enabledictionarycompression): Boolean
  [MaxPaddingBytes](#cfn-kinesisfirehose-deliverystream-parquetserde-maxpaddingbytes): Integer
  [PageSizeBytes](#cfn-kinesisfirehose-deliverystream-parquetserde-pagesizebytes): Integer
  [WriterVersion](#cfn-kinesisfirehose-deliverystream-parquetserde-writerversion): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-parquetserde-properties"></a>

`BlockSizeBytes`  <a name="cfn-kinesisfirehose-deliverystream-parquetserde-blocksizebytes"></a>
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. Firehose uses this value for padding calculations.  
*Required*: No  
*Type*: Integer  
*Minimum*: `67108864`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Compression`  <a name="cfn-kinesisfirehose-deliverystream-parquetserde-compression"></a>
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 ratio is more important than speed.  
*Required*: No  
*Type*: String  
*Allowed values*: `UNCOMPRESSED | GZIP | SNAPPY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnableDictionaryCompression`  <a name="cfn-kinesisfirehose-deliverystream-parquetserde-enabledictionarycompression"></a>
Indicates whether to enable dictionary compression.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxPaddingBytes`  <a name="cfn-kinesisfirehose-deliverystream-parquetserde-maxpaddingbytes"></a>
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.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PageSizeBytes`  <a name="cfn-kinesisfirehose-deliverystream-parquetserde-pagesizebytes"></a>
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.  
*Required*: No  
*Type*: Integer  
*Minimum*: `65536`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WriterVersion`  <a name="cfn-kinesisfirehose-deliverystream-parquetserde-writerversion"></a>
Indicates the version of row format to output. The possible values are `V1` and `V2`. The default is `V1`.  
*Required*: No  
*Type*: String  
*Allowed values*: `V1 | V2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream PartitionField
<a name="aws-properties-kinesisfirehose-deliverystream-partitionfield"></a>

Represents a single field in a `PartitionSpec`. 

Amazon Data Firehose is in preview release and is subject to change.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-partitionfield-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-partitionfield-syntax.json"></a>

```
{
  "[SourceName](#cfn-kinesisfirehose-deliverystream-partitionfield-sourcename)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-partitionfield-syntax.yaml"></a>

```
  [SourceName](#cfn-kinesisfirehose-deliverystream-partitionfield-sourcename): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-partitionfield-properties"></a>

`SourceName`  <a name="cfn-kinesisfirehose-deliverystream-partitionfield-sourcename"></a>
 The column name to be configured in partition spec.   
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream PartitionSpec
<a name="aws-properties-kinesisfirehose-deliverystream-partitionspec"></a>

Represents how to produce partition data for a table. Partition data is produced by transforming columns in a table. Each column transform is represented by a named `PartitionField`. 

Here is an example of the schema in JSON. 

 `"partitionSpec": { "identity": [ {"sourceName": "column1"}, {"sourceName": "column2"}, {"sourceName": "column3"} ] }` 

Amazon Data Firehose is in preview release and is subject to change.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-partitionspec-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-partitionspec-syntax.json"></a>

```
{
  "[Identity](#cfn-kinesisfirehose-deliverystream-partitionspec-identity)" : [ PartitionField, ... ]
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-partitionspec-syntax.yaml"></a>

```
  [Identity](#cfn-kinesisfirehose-deliverystream-partitionspec-identity): 
    - PartitionField
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-partitionspec-properties"></a>

`Identity`  <a name="cfn-kinesisfirehose-deliverystream-partitionspec-identity"></a>
 List of identity [transforms](https://iceberg.apache.org/spec/#partition-transforms) that performs an identity transformation. The transform takes the source value, and does not modify it. Result type is the source type.  
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: No  
*Type*: Array of [PartitionField](aws-properties-kinesisfirehose-deliverystream-partitionfield.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream ProcessingConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-processingconfiguration"></a>

The `ProcessingConfiguration` property configures data processing for an Amazon Kinesis Data Firehose delivery stream.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-processingconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-processingconfiguration-syntax.json"></a>

```
{
  "[Enabled](#cfn-kinesisfirehose-deliverystream-processingconfiguration-enabled)" : Boolean,
  "[Processors](#cfn-kinesisfirehose-deliverystream-processingconfiguration-processors)" : [ Processor, ... ]
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-processingconfiguration-syntax.yaml"></a>

```
  [Enabled](#cfn-kinesisfirehose-deliverystream-processingconfiguration-enabled): Boolean
  [Processors](#cfn-kinesisfirehose-deliverystream-processingconfiguration-processors): 
    - Processor
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-processingconfiguration-properties"></a>

`Enabled`  <a name="cfn-kinesisfirehose-deliverystream-processingconfiguration-enabled"></a>
Indicates whether data processing is enabled (true) or disabled (false).  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Processors`  <a name="cfn-kinesisfirehose-deliverystream-processingconfiguration-processors"></a>
The data processors.  
*Required*: No  
*Type*: Array of [Processor](aws-properties-kinesisfirehose-deliverystream-processor.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream Processor
<a name="aws-properties-kinesisfirehose-deliverystream-processor"></a>

The `Processor` property specifies a data processor for an Amazon Kinesis Data Firehose delivery stream.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-processor-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-processor-syntax.json"></a>

```
{
  "[Parameters](#cfn-kinesisfirehose-deliverystream-processor-parameters)" : [ ProcessorParameter, ... ],
  "[Type](#cfn-kinesisfirehose-deliverystream-processor-type)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-processor-syntax.yaml"></a>

```
  [Parameters](#cfn-kinesisfirehose-deliverystream-processor-parameters): 
    - ProcessorParameter
  [Type](#cfn-kinesisfirehose-deliverystream-processor-type): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-processor-properties"></a>

`Parameters`  <a name="cfn-kinesisfirehose-deliverystream-processor-parameters"></a>
The processor parameters.  
*Required*: No  
*Type*: Array of [ProcessorParameter](aws-properties-kinesisfirehose-deliverystream-processorparameter.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-kinesisfirehose-deliverystream-processor-type"></a>
The type of processor. Valid values: `Lambda`.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `RecordDeAggregation | Decompression | CloudWatchLogProcessing | Lambda | MetadataExtraction | AppendDelimiterToRecord`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream ProcessorParameter
<a name="aws-properties-kinesisfirehose-deliverystream-processorparameter"></a>

The `ProcessorParameter` property specifies a processor parameter in a data processor for an Amazon Kinesis Data Firehose delivery stream.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-processorparameter-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-processorparameter-syntax.json"></a>

```
{
  "[ParameterName](#cfn-kinesisfirehose-deliverystream-processorparameter-parametername)" : String,
  "[ParameterValue](#cfn-kinesisfirehose-deliverystream-processorparameter-parametervalue)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-processorparameter-syntax.yaml"></a>

```
  [ParameterName](#cfn-kinesisfirehose-deliverystream-processorparameter-parametername): String
  [ParameterValue](#cfn-kinesisfirehose-deliverystream-processorparameter-parametervalue): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-processorparameter-properties"></a>

`ParameterName`  <a name="cfn-kinesisfirehose-deliverystream-processorparameter-parametername"></a>
The name of the parameter. Currently the following default values are supported: 3 for `NumberOfRetries` and 60 for the `BufferIntervalInSeconds`. The `BufferSizeInMBs` ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `LambdaArn | NumberOfRetries | MetadataExtractionQuery | JsonParsingEngine | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds | SubRecordType | Delimiter | CompressionFormat | DataMessageExtraction`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ParameterValue`  <a name="cfn-kinesisfirehose-deliverystream-processorparameter-parametervalue"></a>
The parameter value.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!\s*$).+`  
*Minimum*: `1`  
*Maximum*: `5120`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream RedshiftDestinationConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration"></a>

The `RedshiftDestinationConfiguration` property type specifies an Amazon Redshift cluster to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-syntax.json"></a>

```
{
  "[CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-cloudwatchloggingoptions)" : CloudWatchLoggingOptions,
  "[ClusterJDBCURL](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-clusterjdbcurl)" : String,
  "[CopyCommand](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-copycommand)" : CopyCommand,
  "[Password](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-password)" : String,
  "[ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-processingconfiguration)" : ProcessingConfiguration,
  "[RetryOptions](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-retryoptions)" : RedshiftRetryOptions,
  "[RoleARN](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-rolearn)" : String,
  "[S3BackupConfiguration](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3backupconfiguration)" : S3DestinationConfiguration,
  "[S3BackupMode](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3backupmode)" : String,
  "[S3Configuration](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3configuration)" : S3DestinationConfiguration,
  "[SecretsManagerConfiguration](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-secretsmanagerconfiguration)" : SecretsManagerConfiguration,
  "[Username](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-username)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-syntax.yaml"></a>

```
  [CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-cloudwatchloggingoptions): 
    CloudWatchLoggingOptions
  [ClusterJDBCURL](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-clusterjdbcurl): String
  [CopyCommand](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-copycommand): 
    CopyCommand
  [Password](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-password): String
  [ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-processingconfiguration): 
    ProcessingConfiguration
  [RetryOptions](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-retryoptions): 
    RedshiftRetryOptions
  [RoleARN](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-rolearn): String
  [S3BackupConfiguration](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3backupconfiguration): 
    S3DestinationConfiguration
  [S3BackupMode](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3backupmode): String
  [S3Configuration](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3configuration): 
    S3DestinationConfiguration
  [SecretsManagerConfiguration](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-secretsmanagerconfiguration): 
    SecretsManagerConfiguration
  [Username](#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-username): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-properties"></a>

`CloudWatchLoggingOptions`  <a name="cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-cloudwatchloggingoptions"></a>
The CloudWatch logging options for your Firehose stream.  
*Required*: No  
*Type*: [CloudWatchLoggingOptions](aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClusterJDBCURL`  <a name="cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-clusterjdbcurl"></a>
The connection string that Kinesis Data Firehose uses to connect to the Amazon Redshift cluster.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CopyCommand`  <a name="cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-copycommand"></a>
Configures the Amazon Redshift `COPY` command that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket.  
*Required*: Yes  
*Type*: [CopyCommand](aws-properties-kinesisfirehose-deliverystream-copycommand.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Password`  <a name="cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-password"></a>
The password for the Amazon Redshift user that you specified in the `Username` property.  
*Required*: No  
*Type*: String  
*Minimum*: `6`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProcessingConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-processingconfiguration"></a>
The data processing configuration for the Kinesis Data Firehose delivery stream.  
*Required*: No  
*Type*: [ProcessingConfiguration](aws-properties-kinesisfirehose-deliverystream-processingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RetryOptions`  <a name="cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-retryoptions"></a>
The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).  
*Required*: No  
*Type*: [RedshiftRetryOptions](aws-properties-kinesisfirehose-deliverystream-redshiftretryoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleARN`  <a name="cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-rolearn"></a>
The ARN of the AWS Identity and Access Management (IAM) role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS (if you enable data encryption). For more information, see [Grant Kinesis Data Firehose Access to an Amazon Redshift Destination](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-rs) in the *Amazon Kinesis Data Firehose Developer Guide*.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3BackupConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3backupconfiguration"></a>
The configuration for backup in Amazon S3.  
*Required*: No  
*Type*: [S3DestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3BackupMode`  <a name="cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3backupmode"></a>
The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.   
*Required*: No  
*Type*: String  
*Allowed values*: `Disabled | Enabled`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Configuration`  <a name="cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3configuration"></a>
The S3 bucket where Kinesis Data Firehose first delivers data. After the data is in the bucket, Kinesis Data Firehose uses the `COPY` command to load the data into the Amazon Redshift cluster. For the Amazon S3 bucket's compression format, don't specify `SNAPPY` or `ZIP` because the Amazon Redshift `COPY` command doesn't support them.  
*Required*: Yes  
*Type*: [S3DestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecretsManagerConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-secretsmanagerconfiguration"></a>
 The configuration that defines how you access secrets for Amazon Redshift.   
*Required*: No  
*Type*: [SecretsManagerConfiguration](aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Username`  <a name="cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-username"></a>
The Amazon Redshift user that has permission to access the Amazon Redshift cluster. This user must have `INSERT` privileges for copying data from the Amazon S3 bucket to the cluster.   
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream RedshiftRetryOptions
<a name="aws-properties-kinesisfirehose-deliverystream-redshiftretryoptions"></a>

Configures retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-redshiftretryoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-redshiftretryoptions-syntax.json"></a>

```
{
  "[DurationInSeconds](#cfn-kinesisfirehose-deliverystream-redshiftretryoptions-durationinseconds)" : Integer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-redshiftretryoptions-syntax.yaml"></a>

```
  [DurationInSeconds](#cfn-kinesisfirehose-deliverystream-redshiftretryoptions-durationinseconds): Integer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-redshiftretryoptions-properties"></a>

`DurationInSeconds`  <a name="cfn-kinesisfirehose-deliverystream-redshiftretryoptions-durationinseconds"></a>
The length of time during which Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Firehose does not retry if the value of `DurationInSeconds` is 0 (zero) or if the first delivery attempt takes longer than the current value.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `7200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream RetryOptions
<a name="aws-properties-kinesisfirehose-deliverystream-retryoptions"></a>

Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination. Kinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers, including Datadog, MongoDB, and New Relic.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-retryoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-retryoptions-syntax.json"></a>

```
{
  "[DurationInSeconds](#cfn-kinesisfirehose-deliverystream-retryoptions-durationinseconds)" : Integer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-retryoptions-syntax.yaml"></a>

```
  [DurationInSeconds](#cfn-kinesisfirehose-deliverystream-retryoptions-durationinseconds): Integer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-retryoptions-properties"></a>

`DurationInSeconds`  <a name="cfn-kinesisfirehose-deliverystream-retryoptions-durationinseconds"></a>
The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to the custom destination via HTTPS endpoint fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from the specified destination after each attempt.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `7200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream S3DestinationConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration"></a>

The `S3DestinationConfiguration` property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data. 

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration-syntax.json"></a>

```
{
  "[BucketARN](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bucketarn)" : String,
  "[BufferingHints](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bufferinghints)" : BufferingHints,
  "[CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-cloudwatchloggingoptions)" : CloudWatchLoggingOptions,
  "[CompressionFormat](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-compressionformat)" : String,
  "[EncryptionConfiguration](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-encryptionconfiguration)" : EncryptionConfiguration,
  "[ErrorOutputPrefix](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-erroroutputprefix)" : String,
  "[Prefix](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-prefix)" : String,
  "[RoleARN](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-rolearn)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration-syntax.yaml"></a>

```
  [BucketARN](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bucketarn): String
  [BufferingHints](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bufferinghints): 
    BufferingHints
  [CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-cloudwatchloggingoptions): 
    CloudWatchLoggingOptions
  [CompressionFormat](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-compressionformat): String
  [EncryptionConfiguration](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-encryptionconfiguration): 
    EncryptionConfiguration
  [ErrorOutputPrefix](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-erroroutputprefix): String
  [Prefix](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-prefix): String
  [RoleARN](#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-rolearn): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration-properties"></a>

`BucketARN`  <a name="cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bucketarn"></a>
The Amazon Resource Name (ARN) of the Amazon S3 bucket to send data to.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BufferingHints`  <a name="cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bufferinghints"></a>
Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon S3 bucket.  
*Required*: No  
*Type*: [BufferingHints](aws-properties-kinesisfirehose-deliverystream-bufferinghints.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CloudWatchLoggingOptions`  <a name="cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-cloudwatchloggingoptions"></a>
The CloudWatch logging options for your Firehose stream.  
*Required*: No  
*Type*: [CloudWatchLoggingOptions](aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CompressionFormat`  <a name="cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-compressionformat"></a>
The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket. For valid values, see the `CompressionFormat` content for the [S3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_S3DestinationConfiguration.html) data type in the *Amazon Kinesis Data Firehose API Reference*.   
*Required*: No  
*Type*: String  
*Allowed values*: `UNCOMPRESSED | GZIP | ZIP | Snappy | HADOOP_SNAPPY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EncryptionConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-encryptionconfiguration"></a>
Configures Amazon Simple Storage Service (Amazon S3) server-side encryption. Kinesis Data Firehose uses AWS Key Management Service (AWS KMS) to encrypt the data that it delivers to your Amazon S3 bucket.  
*Required*: No  
*Type*: [EncryptionConfiguration](aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ErrorOutputPrefix`  <a name="cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-erroroutputprefix"></a>
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see [Custom Prefixes for Amazon S3 Objects](https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html).  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Prefix`  <a name="cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-prefix"></a>
A prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3 bucket. The prefix helps you identify the files that Kinesis Data Firehose delivered.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleARN`  <a name="cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-rolearn"></a>
The ARN of an AWS Identity and Access Management (IAM) role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS (if you enable data encryption). For more information, see [Grant Kinesis Data Firehose Access to an Amazon S3 Destination](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) in the *Amazon Kinesis Data Firehose Developer Guide*.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream SchemaConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-schemaconfiguration"></a>

Specifies the schema to which you want Firehose to configure your data before it writes it to Amazon S3. This parameter is required if `Enabled` is set to true.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-schemaconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-schemaconfiguration-syntax.json"></a>

```
{
  "[CatalogId](#cfn-kinesisfirehose-deliverystream-schemaconfiguration-catalogid)" : String,
  "[DatabaseName](#cfn-kinesisfirehose-deliverystream-schemaconfiguration-databasename)" : String,
  "[Region](#cfn-kinesisfirehose-deliverystream-schemaconfiguration-region)" : String,
  "[RoleARN](#cfn-kinesisfirehose-deliverystream-schemaconfiguration-rolearn)" : String,
  "[TableName](#cfn-kinesisfirehose-deliverystream-schemaconfiguration-tablename)" : String,
  "[VersionId](#cfn-kinesisfirehose-deliverystream-schemaconfiguration-versionid)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-schemaconfiguration-syntax.yaml"></a>

```
  [CatalogId](#cfn-kinesisfirehose-deliverystream-schemaconfiguration-catalogid): String
  [DatabaseName](#cfn-kinesisfirehose-deliverystream-schemaconfiguration-databasename): String
  [Region](#cfn-kinesisfirehose-deliverystream-schemaconfiguration-region): String
  [RoleARN](#cfn-kinesisfirehose-deliverystream-schemaconfiguration-rolearn): String
  [TableName](#cfn-kinesisfirehose-deliverystream-schemaconfiguration-tablename): String
  [VersionId](#cfn-kinesisfirehose-deliverystream-schemaconfiguration-versionid): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-schemaconfiguration-properties"></a>

`CatalogId`  <a name="cfn-kinesisfirehose-deliverystream-schemaconfiguration-catalogid"></a>
The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.  
*Required*: No  
*Type*: String  
*Pattern*: `^\S+$`  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatabaseName`  <a name="cfn-kinesisfirehose-deliverystream-schemaconfiguration-databasename"></a>
Specifies the name of the AWS Glue database that contains the schema for the output data.  
If the `SchemaConfiguration` request parameter is used as part of invoking the `CreateDeliveryStream` API, then the `DatabaseName` property is required and its value must be specified.
*Required*: No  
*Type*: String  
*Pattern*: `^\S+$`  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Region`  <a name="cfn-kinesisfirehose-deliverystream-schemaconfiguration-region"></a>
If you don't specify an AWS Region, the default is the current Region.  
*Required*: No  
*Type*: String  
*Pattern*: `^\S+$`  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleARN`  <a name="cfn-kinesisfirehose-deliverystream-schemaconfiguration-rolearn"></a>
The role that Firehose can use to access AWS Glue. This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.  
If the `SchemaConfiguration` request parameter is used as part of invoking the `CreateDeliveryStream` API, then the `RoleARN` property is required and its value must be specified.
*Required*: No  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TableName`  <a name="cfn-kinesisfirehose-deliverystream-schemaconfiguration-tablename"></a>
Specifies the AWS Glue table that contains the column information that constitutes your data schema.  
If the `SchemaConfiguration` request parameter is used as part of invoking the `CreateDeliveryStream` API, then the `TableName` property is required and its value must be specified.
*Required*: No  
*Type*: String  
*Pattern*: `^\S+$`  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VersionId`  <a name="cfn-kinesisfirehose-deliverystream-schemaconfiguration-versionid"></a>
Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to `LATEST`, Firehose uses the most recent version. This means that any updates to the table are automatically picked up.  
*Required*: No  
*Type*: String  
*Pattern*: `^\S+$`  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream SchemaEvolutionConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-schemaevolutionconfiguration"></a>

The configuration to enable schema evolution.

Amazon Data Firehose is in preview release and is subject to change.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-schemaevolutionconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-schemaevolutionconfiguration-syntax.json"></a>

```
{
  "[Enabled](#cfn-kinesisfirehose-deliverystream-schemaevolutionconfiguration-enabled)" : Boolean
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-schemaevolutionconfiguration-syntax.yaml"></a>

```
  [Enabled](#cfn-kinesisfirehose-deliverystream-schemaevolutionconfiguration-enabled): Boolean
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-schemaevolutionconfiguration-properties"></a>

`Enabled`  <a name="cfn-kinesisfirehose-deliverystream-schemaevolutionconfiguration-enabled"></a>
 Specify whether you want to enable schema evolution.   
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream SecretsManagerConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration"></a>

The structure that defines how Firehose accesses the secret.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration-syntax.json"></a>

```
{
  "[Enabled](#cfn-kinesisfirehose-deliverystream-secretsmanagerconfiguration-enabled)" : Boolean,
  "[RoleARN](#cfn-kinesisfirehose-deliverystream-secretsmanagerconfiguration-rolearn)" : String,
  "[SecretARN](#cfn-kinesisfirehose-deliverystream-secretsmanagerconfiguration-secretarn)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration-syntax.yaml"></a>

```
  [Enabled](#cfn-kinesisfirehose-deliverystream-secretsmanagerconfiguration-enabled): Boolean
  [RoleARN](#cfn-kinesisfirehose-deliverystream-secretsmanagerconfiguration-rolearn): String
  [SecretARN](#cfn-kinesisfirehose-deliverystream-secretsmanagerconfiguration-secretarn): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration-properties"></a>

`Enabled`  <a name="cfn-kinesisfirehose-deliverystream-secretsmanagerconfiguration-enabled"></a>
Specifies whether you want to use the secrets manager feature. When set as `True` the secrets manager configuration overwrites the existing secrets in the destination configuration. When it's set to `False` Firehose falls back to the credentials in the destination configuration.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RoleARN`  <a name="cfn-kinesisfirehose-deliverystream-secretsmanagerconfiguration-rolearn"></a>
 Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk.   
*Required*: No  
*Type*: String  
*Pattern*: `arn:.*:iam::\d{12}:role/[a-zA-Z_0-9+=,.@\-_/]+`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SecretARN`  <a name="cfn-kinesisfirehose-deliverystream-secretsmanagerconfiguration-secretarn"></a>
The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream and the role. The secret ARN can reside in a different account than the Firehose stream and role as Firehose supports cross-account secret access. This parameter is required when **Enabled** is set to `True`.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:.*:secretsmanager:[a-zA-Z0-9\-]+:\d{12}:secret:[a-zA-Z0-9\-/_+=.@]+`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream Serializer
<a name="aws-properties-kinesisfirehose-deliverystream-serializer"></a>

The serializer that you want Firehose to use to convert data to the target format before writing it to Amazon S3. Firehose supports two types of serializers: the ORC SerDe and the Parquet SerDe.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-serializer-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-serializer-syntax.json"></a>

```
{
  "[OrcSerDe](#cfn-kinesisfirehose-deliverystream-serializer-orcserde)" : OrcSerDe,
  "[ParquetSerDe](#cfn-kinesisfirehose-deliverystream-serializer-parquetserde)" : ParquetSerDe
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-serializer-syntax.yaml"></a>

```
  [OrcSerDe](#cfn-kinesisfirehose-deliverystream-serializer-orcserde): 
    OrcSerDe
  [ParquetSerDe](#cfn-kinesisfirehose-deliverystream-serializer-parquetserde): 
    ParquetSerDe
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-serializer-properties"></a>

`OrcSerDe`  <a name="cfn-kinesisfirehose-deliverystream-serializer-orcserde"></a>
A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see [Apache ORC](https://orc.apache.org/docs/).  
*Required*: No  
*Type*: [OrcSerDe](aws-properties-kinesisfirehose-deliverystream-orcserde.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ParquetSerDe`  <a name="cfn-kinesisfirehose-deliverystream-serializer-parquetserde"></a>
A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see [Apache Parquet](https://parquet.apache.org/docs/contribution-guidelines/).  
*Required*: No  
*Type*: [ParquetSerDe](aws-properties-kinesisfirehose-deliverystream-parquetserde.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream SnowflakeBufferingHints
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakebufferinghints"></a>

 Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values. 

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakebufferinghints-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakebufferinghints-syntax.json"></a>

```
{
  "[IntervalInSeconds](#cfn-kinesisfirehose-deliverystream-snowflakebufferinghints-intervalinseconds)" : Integer,
  "[SizeInMBs](#cfn-kinesisfirehose-deliverystream-snowflakebufferinghints-sizeinmbs)" : Integer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakebufferinghints-syntax.yaml"></a>

```
  [IntervalInSeconds](#cfn-kinesisfirehose-deliverystream-snowflakebufferinghints-intervalinseconds): Integer
  [SizeInMBs](#cfn-kinesisfirehose-deliverystream-snowflakebufferinghints-sizeinmbs): Integer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakebufferinghints-properties"></a>

`IntervalInSeconds`  <a name="cfn-kinesisfirehose-deliverystream-snowflakebufferinghints-intervalinseconds"></a>
 Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 0.   
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `900`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SizeInMBs`  <a name="cfn-kinesisfirehose-deliverystream-snowflakebufferinghints-sizeinmbs"></a>
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 128.   
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream SnowflakeDestinationConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration"></a>

Configure Snowflake destination

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-syntax.json"></a>

```
{
  "[AccountUrl](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-accounturl)" : String,
  "[BufferingHints](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-bufferinghints)" : SnowflakeBufferingHints,
  "[CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-cloudwatchloggingoptions)" : CloudWatchLoggingOptions,
  "[ContentColumnName](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-contentcolumnname)" : String,
  "[Database](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-database)" : String,
  "[DataLoadingOption](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-dataloadingoption)" : String,
  "[KeyPassphrase](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-keypassphrase)" : String,
  "[MetaDataColumnName](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-metadatacolumnname)" : String,
  "[PrivateKey](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-privatekey)" : String,
  "[ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-processingconfiguration)" : ProcessingConfiguration,
  "[RetryOptions](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-retryoptions)" : SnowflakeRetryOptions,
  "[RoleARN](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-rolearn)" : String,
  "[S3BackupMode](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-s3backupmode)" : String,
  "[S3Configuration](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-s3configuration)" : S3DestinationConfiguration,
  "[Schema](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-schema)" : String,
  "[SecretsManagerConfiguration](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-secretsmanagerconfiguration)" : SecretsManagerConfiguration,
  "[SnowflakeRoleConfiguration](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-snowflakeroleconfiguration)" : SnowflakeRoleConfiguration,
  "[SnowflakeVpcConfiguration](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-snowflakevpcconfiguration)" : SnowflakeVpcConfiguration,
  "[Table](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-table)" : String,
  "[User](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-user)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-syntax.yaml"></a>

```
  [AccountUrl](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-accounturl): String
  [BufferingHints](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-bufferinghints): 
    SnowflakeBufferingHints
  [CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-cloudwatchloggingoptions): 
    CloudWatchLoggingOptions
  [ContentColumnName](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-contentcolumnname): String
  [Database](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-database): String
  [DataLoadingOption](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-dataloadingoption): String
  [KeyPassphrase](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-keypassphrase): String
  [MetaDataColumnName](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-metadatacolumnname): String
  [PrivateKey](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-privatekey): String
  [ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-processingconfiguration): 
    ProcessingConfiguration
  [RetryOptions](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-retryoptions): 
    SnowflakeRetryOptions
  [RoleARN](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-rolearn): String
  [S3BackupMode](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-s3backupmode): String
  [S3Configuration](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-s3configuration): 
    S3DestinationConfiguration
  [Schema](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-schema): String
  [SecretsManagerConfiguration](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-secretsmanagerconfiguration): 
    SecretsManagerConfiguration
  [SnowflakeRoleConfiguration](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-snowflakeroleconfiguration): 
    SnowflakeRoleConfiguration
  [SnowflakeVpcConfiguration](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-snowflakevpcconfiguration): 
    SnowflakeVpcConfiguration
  [Table](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-table): String
  [User](#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-user): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-properties"></a>

`AccountUrl`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-accounturl"></a>
URL for accessing your Snowflake account. This URL must include your [account identifier](https://docs.snowflake.com/en/user-guide/admin-account-identifier). Note that the protocol (https://) and port number are optional.  
*Required*: Yes  
*Type*: String  
*Pattern*: `.+?\.snowflakecomputing\.com`  
*Minimum*: `24`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BufferingHints`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-bufferinghints"></a>
 Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.   
*Required*: No  
*Type*: [SnowflakeBufferingHints](aws-properties-kinesisfirehose-deliverystream-snowflakebufferinghints.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CloudWatchLoggingOptions`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-cloudwatchloggingoptions"></a>
Property description not available.  
*Required*: No  
*Type*: [CloudWatchLoggingOptions](aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ContentColumnName`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-contentcolumnname"></a>
The name of the record content column.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Database`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-database"></a>
All data in Snowflake is maintained in databases.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DataLoadingOption`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-dataloadingoption"></a>
Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.  
*Required*: No  
*Type*: String  
*Allowed values*: `JSON_MAPPING | VARIANT_CONTENT_MAPPING | VARIANT_CONTENT_AND_METADATA_MAPPING`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KeyPassphrase`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-keypassphrase"></a>
Passphrase to decrypt the private key when the key is encrypted. For information, see [Using Key Pair Authentication & Key Rotation](https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation).  
*Required*: No  
*Type*: String  
*Minimum*: `7`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MetaDataColumnName`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-metadatacolumnname"></a>
Specify a column name in the table, where the metadata information has to be loaded. When you enable this field, you will see the following column in the snowflake table, which differs based on the source type.  
For Direct PUT as source   
 `{ "firehoseDeliveryStreamName" : "streamname", "IngestionTime" : "timestamp" }`   
For Kinesis Data Stream as source   
 ` "kinesisStreamName" : "streamname", "kinesisShardId" : "Id", "kinesisPartitionKey" : "key", "kinesisSequenceNumber" : "1234", "subsequenceNumber" : "2334", "IngestionTime" : "timestamp" }`   
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PrivateKey`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-privatekey"></a>
The private key used to encrypt your Snowflake client. For information, see [Using Key Pair Authentication & Key Rotation](https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation).  
*Required*: No  
*Type*: String  
*Pattern*: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$`  
*Minimum*: `256`  
*Maximum*: `4096`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProcessingConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-processingconfiguration"></a>
Property description not available.  
*Required*: No  
*Type*: [ProcessingConfiguration](aws-properties-kinesisfirehose-deliverystream-processingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RetryOptions`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-retryoptions"></a>
The time period where Firehose will retry sending data to the chosen HTTP endpoint.  
*Required*: No  
*Type*: [SnowflakeRetryOptions](aws-properties-kinesisfirehose-deliverystream-snowflakeretryoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleARN`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-rolearn"></a>
The Amazon Resource Name (ARN) of the Snowflake role  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3BackupMode`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-s3backupmode"></a>
Choose an S3 backup mode  
*Required*: No  
*Type*: String  
*Allowed values*: `FailedDataOnly | AllData`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Configuration`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-s3configuration"></a>
Property description not available.  
*Required*: Yes  
*Type*: [S3DestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Schema`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-schema"></a>
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecretsManagerConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-secretsmanagerconfiguration"></a>
 The configuration that defines how you access secrets for Snowflake.   
*Required*: No  
*Type*: [SecretsManagerConfiguration](aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnowflakeRoleConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-snowflakeroleconfiguration"></a>
Optionally configure a Snowflake role. Otherwise the default user role will be used.  
*Required*: No  
*Type*: [SnowflakeRoleConfiguration](aws-properties-kinesisfirehose-deliverystream-snowflakeroleconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnowflakeVpcConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-snowflakevpcconfiguration"></a>
The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see [Amazon PrivateLink & Snowflake](https://docs.snowflake.com/en/user-guide/admin-security-privatelink)  
*Required*: No  
*Type*: [SnowflakeVpcConfiguration](aws-properties-kinesisfirehose-deliverystream-snowflakevpcconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Table`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-table"></a>
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`User`  <a name="cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-user"></a>
User login name for the Snowflake account.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream SnowflakeRetryOptions
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakeretryoptions"></a>

Specify how long Firehose retries sending data to the New Relic HTTP endpoint. After sending data, Firehose first waits for an acknowledgment from the HTTP endpoint. If an error occurs or the acknowledgment doesn’t arrive within the acknowledgment timeout period, Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket. Every time that Firehose sends data to the HTTP endpoint (either the initial attempt or a retry), it restarts the acknowledgement timeout counter and waits for an acknowledgement from the HTTP endpoint. Even if the retry duration expires, Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Firehose determines whether there's time left in the retry counter. If there is time left, it retries again and repeats the logic until it receives an acknowledgment or determines that the retry time has expired. If you don't want Firehose to retry sending data, set this value to 0.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakeretryoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakeretryoptions-syntax.json"></a>

```
{
  "[DurationInSeconds](#cfn-kinesisfirehose-deliverystream-snowflakeretryoptions-durationinseconds)" : Integer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakeretryoptions-syntax.yaml"></a>

```
  [DurationInSeconds](#cfn-kinesisfirehose-deliverystream-snowflakeretryoptions-durationinseconds): Integer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakeretryoptions-properties"></a>

`DurationInSeconds`  <a name="cfn-kinesisfirehose-deliverystream-snowflakeretryoptions-durationinseconds"></a>
the time period where Firehose will retry sending data to the chosen HTTP endpoint.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `7200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream SnowflakeRoleConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakeroleconfiguration"></a>

Optionally configure a Snowflake role. Otherwise the default user role will be used.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakeroleconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakeroleconfiguration-syntax.json"></a>

```
{
  "[Enabled](#cfn-kinesisfirehose-deliverystream-snowflakeroleconfiguration-enabled)" : Boolean,
  "[SnowflakeRole](#cfn-kinesisfirehose-deliverystream-snowflakeroleconfiguration-snowflakerole)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakeroleconfiguration-syntax.yaml"></a>

```
  [Enabled](#cfn-kinesisfirehose-deliverystream-snowflakeroleconfiguration-enabled): Boolean
  [SnowflakeRole](#cfn-kinesisfirehose-deliverystream-snowflakeroleconfiguration-snowflakerole): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakeroleconfiguration-properties"></a>

`Enabled`  <a name="cfn-kinesisfirehose-deliverystream-snowflakeroleconfiguration-enabled"></a>
Enable Snowflake role  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnowflakeRole`  <a name="cfn-kinesisfirehose-deliverystream-snowflakeroleconfiguration-snowflakerole"></a>
The Snowflake role you wish to configure  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream SnowflakeVpcConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakevpcconfiguration"></a>

Configure a Snowflake VPC

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakevpcconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakevpcconfiguration-syntax.json"></a>

```
{
  "[PrivateLinkVpceId](#cfn-kinesisfirehose-deliverystream-snowflakevpcconfiguration-privatelinkvpceid)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakevpcconfiguration-syntax.yaml"></a>

```
  [PrivateLinkVpceId](#cfn-kinesisfirehose-deliverystream-snowflakevpcconfiguration-privatelinkvpceid): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-snowflakevpcconfiguration-properties"></a>

`PrivateLinkVpceId`  <a name="cfn-kinesisfirehose-deliverystream-snowflakevpcconfiguration-privatelinkvpceid"></a>
The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see [Amazon PrivateLink & Snowflake](https://docs.snowflake.com/en/user-guide/admin-security-privatelink)  
*Required*: Yes  
*Type*: String  
*Pattern*: `([a-zA-Z0-9\-\_]+\.){2,3}vpce\.[a-zA-Z0-9\-]*\.vpce-svc\-[a-zA-Z0-9\-]{17}$`  
*Minimum*: `47`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::KinesisFirehose::DeliveryStream SplunkBufferingHints
<a name="aws-properties-kinesisfirehose-deliverystream-splunkbufferinghints"></a>

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

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-splunkbufferinghints-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-splunkbufferinghints-syntax.json"></a>

```
{
  "[IntervalInSeconds](#cfn-kinesisfirehose-deliverystream-splunkbufferinghints-intervalinseconds)" : Integer,
  "[SizeInMBs](#cfn-kinesisfirehose-deliverystream-splunkbufferinghints-sizeinmbs)" : Integer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-splunkbufferinghints-syntax.yaml"></a>

```
  [IntervalInSeconds](#cfn-kinesisfirehose-deliverystream-splunkbufferinghints-intervalinseconds): Integer
  [SizeInMBs](#cfn-kinesisfirehose-deliverystream-splunkbufferinghints-sizeinmbs): Integer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-splunkbufferinghints-properties"></a>

`IntervalInSeconds`  <a name="cfn-kinesisfirehose-deliverystream-splunkbufferinghints-intervalinseconds"></a>
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 60 (1 minute).  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `60`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SizeInMBs`  <a name="cfn-kinesisfirehose-deliverystream-splunkbufferinghints-sizeinmbs"></a>
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.   
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream SplunkDestinationConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration"></a>

The `SplunkDestinationConfiguration` property type specifies the configuration of a destination in Splunk for a Kinesis Data Firehose delivery stream.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration-syntax.json"></a>

```
{
  "[BufferingHints](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-bufferinghints)" : SplunkBufferingHints,
  "[CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-cloudwatchloggingoptions)" : CloudWatchLoggingOptions,
  "[HECAcknowledgmentTimeoutInSeconds](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecacknowledgmenttimeoutinseconds)" : Integer,
  "[HECEndpoint](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpoint)" : String,
  "[HECEndpointType](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpointtype)" : String,
  "[HECToken](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hectoken)" : String,
  "[ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-processingconfiguration)" : ProcessingConfiguration,
  "[RetryOptions](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-retryoptions)" : SplunkRetryOptions,
  "[S3BackupMode](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3backupmode)" : String,
  "[S3Configuration](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3configuration)" : S3DestinationConfiguration,
  "[SecretsManagerConfiguration](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-secretsmanagerconfiguration)" : SecretsManagerConfiguration
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration-syntax.yaml"></a>

```
  [BufferingHints](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-bufferinghints): 
    SplunkBufferingHints
  [CloudWatchLoggingOptions](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-cloudwatchloggingoptions): 
    CloudWatchLoggingOptions
  [HECAcknowledgmentTimeoutInSeconds](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecacknowledgmenttimeoutinseconds): Integer
  [HECEndpoint](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpoint): String
  [HECEndpointType](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpointtype): String
  [HECToken](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hectoken): String
  [ProcessingConfiguration](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-processingconfiguration): 
    ProcessingConfiguration
  [RetryOptions](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-retryoptions): 
    SplunkRetryOptions
  [S3BackupMode](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3backupmode): String
  [S3Configuration](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3configuration): 
    S3DestinationConfiguration
  [SecretsManagerConfiguration](#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-secretsmanagerconfiguration): 
    SecretsManagerConfiguration
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration-properties"></a>

`BufferingHints`  <a name="cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-bufferinghints"></a>
The buffering options. If no value is specified, the default values for Splunk are used.  
*Required*: No  
*Type*: [SplunkBufferingHints](aws-properties-kinesisfirehose-deliverystream-splunkbufferinghints.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CloudWatchLoggingOptions`  <a name="cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-cloudwatchloggingoptions"></a>
The Amazon CloudWatch logging options for your Firehose stream.  
*Required*: No  
*Type*: [CloudWatchLoggingOptions](aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HECAcknowledgmentTimeoutInSeconds`  <a name="cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecacknowledgmenttimeoutinseconds"></a>
The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.  
*Required*: No  
*Type*: Integer  
*Minimum*: `180`  
*Maximum*: `600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HECEndpoint`  <a name="cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpoint"></a>
The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HECEndpointType`  <a name="cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpointtype"></a>
This type can be either `Raw` or `Event`.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `Raw | Event`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HECToken`  <a name="cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hectoken"></a>
This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProcessingConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-processingconfiguration"></a>
The data processing configuration.  
*Required*: No  
*Type*: [ProcessingConfiguration](aws-properties-kinesisfirehose-deliverystream-processingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RetryOptions`  <a name="cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-retryoptions"></a>
The retry behavior in case Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.  
*Required*: No  
*Type*: [SplunkRetryOptions](aws-properties-kinesisfirehose-deliverystream-splunkretryoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3BackupMode`  <a name="cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3backupmode"></a>
Defines how documents should be delivered to Amazon S3. When set to `FailedEventsOnly`, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to `AllEvents`, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is `FailedEventsOnly`.  
You can update this backup mode from `FailedEventsOnly` to `AllEvents`. You can't update it from `AllEvents` to `FailedEventsOnly`.  
*Required*: No  
*Type*: String  
*Allowed values*: `FailedEventsOnly | AllEvents`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Configuration`  <a name="cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3configuration"></a>
The configuration for the backup Amazon S3 location.  
*Required*: Yes  
*Type*: [S3DestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecretsManagerConfiguration`  <a name="cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-secretsmanagerconfiguration"></a>
 The configuration that defines how you access secrets for Splunk.   
*Required*: No  
*Type*: [SecretsManagerConfiguration](aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration--seealso"></a>
+ [SplunkDestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SplunkDestinationConfiguration.html) in the *Amazon Kinesis Data Firehose API Reference *.

# AWS::KinesisFirehose::DeliveryStream SplunkRetryOptions
<a name="aws-properties-kinesisfirehose-deliverystream-splunkretryoptions"></a>

The `SplunkRetryOptions` property type specifies retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk or if it doesn't receive an acknowledgment from Splunk.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-splunkretryoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-splunkretryoptions-syntax.json"></a>

```
{
  "[DurationInSeconds](#cfn-kinesisfirehose-deliverystream-splunkretryoptions-durationinseconds)" : Integer
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-splunkretryoptions-syntax.yaml"></a>

```
  [DurationInSeconds](#cfn-kinesisfirehose-deliverystream-splunkretryoptions-durationinseconds): Integer
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-splunkretryoptions-properties"></a>

`DurationInSeconds`  <a name="cfn-kinesisfirehose-deliverystream-splunkretryoptions-durationinseconds"></a>
The total amount of time that 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 Firehose waits for acknowledgment from Splunk after each attempt.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `7200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-kinesisfirehose-deliverystream-splunkretryoptions--seealso"></a>
+ [SplunkRetryOptions](https://docs.aws.amazon.com/firehose/latest/APIReference/API_SplunkRetryOptions.html) in the *Amazon Kinesis Data Firehose API Reference*.

# AWS::KinesisFirehose::DeliveryStream TableCreationConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-tablecreationconfiguration"></a>

The configuration to enable automatic table creation.

Amazon Data Firehose is in preview release and is subject to change.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-tablecreationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-tablecreationconfiguration-syntax.json"></a>

```
{
  "[Enabled](#cfn-kinesisfirehose-deliverystream-tablecreationconfiguration-enabled)" : Boolean
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-tablecreationconfiguration-syntax.yaml"></a>

```
  [Enabled](#cfn-kinesisfirehose-deliverystream-tablecreationconfiguration-enabled): Boolean
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-tablecreationconfiguration-properties"></a>

`Enabled`  <a name="cfn-kinesisfirehose-deliverystream-tablecreationconfiguration-enabled"></a>
 Specify whether you want to enable automatic table creation.   
Amazon Data Firehose is in preview release and is subject to change.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream Tag
<a name="aws-properties-kinesisfirehose-deliverystream-tag"></a>

Metadata that you can assign to a Firehose stream, consisting of a key-value pair.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-tag-syntax.json"></a>

```
{
  "[Key](#cfn-kinesisfirehose-deliverystream-tag-key)" : String,
  "[Value](#cfn-kinesisfirehose-deliverystream-tag-value)" : String
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-tag-syntax.yaml"></a>

```
  [Key](#cfn-kinesisfirehose-deliverystream-tag-key): String
  [Value](#cfn-kinesisfirehose-deliverystream-tag-value): String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-tag-properties"></a>

`Key`  <a name="cfn-kinesisfirehose-deliverystream-tag-key"></a>
A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, \$1 . / = \$1 - % @  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:\/=+\-@%]*$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-kinesisfirehose-deliverystream-tag-value"></a>
An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, \$1 . / = \$1 - % @  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}\p{Z}\p{N}_.:\/=+\-@%]*$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::KinesisFirehose::DeliveryStream VpcConfiguration
<a name="aws-properties-kinesisfirehose-deliverystream-vpcconfiguration"></a>

The details of the VPC of the Amazon ES destination.

## Syntax
<a name="aws-properties-kinesisfirehose-deliverystream-vpcconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-kinesisfirehose-deliverystream-vpcconfiguration-syntax.json"></a>

```
{
  "[RoleARN](#cfn-kinesisfirehose-deliverystream-vpcconfiguration-rolearn)" : String,
  "[SecurityGroupIds](#cfn-kinesisfirehose-deliverystream-vpcconfiguration-securitygroupids)" : [ String, ... ],
  "[SubnetIds](#cfn-kinesisfirehose-deliverystream-vpcconfiguration-subnetids)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-kinesisfirehose-deliverystream-vpcconfiguration-syntax.yaml"></a>

```
  [RoleARN](#cfn-kinesisfirehose-deliverystream-vpcconfiguration-rolearn): String
  [SecurityGroupIds](#cfn-kinesisfirehose-deliverystream-vpcconfiguration-securitygroupids): 
    - String
  [SubnetIds](#cfn-kinesisfirehose-deliverystream-vpcconfiguration-subnetids): 
    - String
```

## Properties
<a name="aws-properties-kinesisfirehose-deliverystream-vpcconfiguration-properties"></a>

`RoleARN`  <a name="cfn-kinesisfirehose-deliverystream-vpcconfiguration-rolearn"></a>
The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:  
+  `ec2:DescribeVpcs` 
+  `ec2:DescribeVpcAttribute` 
+  `ec2:DescribeSubnets` 
+  `ec2:DescribeSecurityGroups` 
+  `ec2:DescribeNetworkInterfaces` 
+  `ec2:CreateNetworkInterface` 
+  `ec2:CreateNetworkInterfacePermission` 
+  `ec2:DeleteNetworkInterface` 
If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:.*`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SecurityGroupIds`  <a name="cfn-kinesisfirehose-deliverystream-vpcconfiguration-securitygroupids"></a>
The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 1`  
*Maximum*: `1024 | 5`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SubnetIds`  <a name="cfn-kinesisfirehose-deliverystream-vpcconfiguration-subnetids"></a>
The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.  
The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 1`  
*Maximum*: `1024 | 16`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)