interface CfnDeliveryStreamProps

Language	Type name
.NET	`Amazon.CDK.AWS.KinesisFirehose.CfnDeliveryStreamProps`
Java	`software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStreamProps`
Python	`aws_cdk.aws_kinesisfirehose.CfnDeliveryStreamProps`
TypeScript	`@aws-cdk/aws-kinesisfirehose` » `CfnDeliveryStreamProps`

Properties for defining a CfnDeliveryStream.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as kinesisfirehose from '@aws-cdk/aws-kinesisfirehose';
const cfnDeliveryStreamProps: kinesisfirehose.CfnDeliveryStreamProps = {
  amazonOpenSearchServerlessDestinationConfiguration: {
    indexName: 'indexName',
    roleArn: 'roleArn',
    s3Configuration: {
      bucketArn: 'bucketArn',
      roleArn: 'roleArn',

      // the properties below are optional
      bufferingHints: {
        intervalInSeconds: 123,
        sizeInMBs: 123,
      },
      cloudWatchLoggingOptions: {
        enabled: false,
        logGroupName: 'logGroupName',
        logStreamName: 'logStreamName',
      },
      compressionFormat: 'compressionFormat',
      encryptionConfiguration: {
        kmsEncryptionConfig: {
          awskmsKeyArn: 'awskmsKeyArn',
        },
        noEncryptionConfig: 'noEncryptionConfig',
      },
      errorOutputPrefix: 'errorOutputPrefix',
      prefix: 'prefix',
    },

    // the properties below are optional
    bufferingHints: {
      intervalInSeconds: 123,
      sizeInMBs: 123,
    },
    cloudWatchLoggingOptions: {
      enabled: false,
      logGroupName: 'logGroupName',
      logStreamName: 'logStreamName',
    },
    collectionEndpoint: 'collectionEndpoint',
    processingConfiguration: {
      enabled: false,
      processors: [{
        type: 'type',

        // the properties below are optional
        parameters: [{
          parameterName: 'parameterName',
          parameterValue: 'parameterValue',
        }],
      }],
    },
    retryOptions: {
      durationInSeconds: 123,
    },
    s3BackupMode: 's3BackupMode',
    vpcConfiguration: {
      roleArn: 'roleArn',
      securityGroupIds: ['securityGroupIds'],
      subnetIds: ['subnetIds'],
    },
  },
  amazonopensearchserviceDestinationConfiguration: {
    indexName: 'indexName',
    roleArn: 'roleArn',
    s3Configuration: {
      bucketArn: 'bucketArn',
      roleArn: 'roleArn',

      // the properties below are optional
      bufferingHints: {
        intervalInSeconds: 123,
        sizeInMBs: 123,
      },
      cloudWatchLoggingOptions: {
        enabled: false,
        logGroupName: 'logGroupName',
        logStreamName: 'logStreamName',
      },
      compressionFormat: 'compressionFormat',
      encryptionConfiguration: {
        kmsEncryptionConfig: {
          awskmsKeyArn: 'awskmsKeyArn',
        },
        noEncryptionConfig: 'noEncryptionConfig',
      },
      errorOutputPrefix: 'errorOutputPrefix',
      prefix: 'prefix',
    },

    // the properties below are optional
    bufferingHints: {
      intervalInSeconds: 123,
      sizeInMBs: 123,
    },
    cloudWatchLoggingOptions: {
      enabled: false,
      logGroupName: 'logGroupName',
      logStreamName: 'logStreamName',
    },
    clusterEndpoint: 'clusterEndpoint',
    documentIdOptions: {
      defaultDocumentIdFormat: 'defaultDocumentIdFormat',
    },
    domainArn: 'domainArn',
    indexRotationPeriod: 'indexRotationPeriod',
    processingConfiguration: {
      enabled: false,
      processors: [{
        type: 'type',

        // the properties below are optional
        parameters: [{
          parameterName: 'parameterName',
          parameterValue: 'parameterValue',
        }],
      }],
    },
    retryOptions: {
      durationInSeconds: 123,
    },
    s3BackupMode: 's3BackupMode',
    typeName: 'typeName',
    vpcConfiguration: {
      roleArn: 'roleArn',
      securityGroupIds: ['securityGroupIds'],
      subnetIds: ['subnetIds'],
    },
  },
  deliveryStreamEncryptionConfigurationInput: {
    keyType: 'keyType',

    // the properties below are optional
    keyArn: 'keyArn',
  },
  deliveryStreamName: 'deliveryStreamName',
  deliveryStreamType: 'deliveryStreamType',
  elasticsearchDestinationConfiguration: {
    indexName: 'indexName',
    roleArn: 'roleArn',
    s3Configuration: {
      bucketArn: 'bucketArn',
      roleArn: 'roleArn',

      // the properties below are optional
      bufferingHints: {
        intervalInSeconds: 123,
        sizeInMBs: 123,
      },
      cloudWatchLoggingOptions: {
        enabled: false,
        logGroupName: 'logGroupName',
        logStreamName: 'logStreamName',
      },
      compressionFormat: 'compressionFormat',
      encryptionConfiguration: {
        kmsEncryptionConfig: {
          awskmsKeyArn: 'awskmsKeyArn',
        },
        noEncryptionConfig: 'noEncryptionConfig',
      },
      errorOutputPrefix: 'errorOutputPrefix',
      prefix: 'prefix',
    },

    // the properties below are optional
    bufferingHints: {
      intervalInSeconds: 123,
      sizeInMBs: 123,
    },
    cloudWatchLoggingOptions: {
      enabled: false,
      logGroupName: 'logGroupName',
      logStreamName: 'logStreamName',
    },
    clusterEndpoint: 'clusterEndpoint',
    documentIdOptions: {
      defaultDocumentIdFormat: 'defaultDocumentIdFormat',
    },
    domainArn: 'domainArn',
    indexRotationPeriod: 'indexRotationPeriod',
    processingConfiguration: {
      enabled: false,
      processors: [{
        type: 'type',

        // the properties below are optional
        parameters: [{
          parameterName: 'parameterName',
          parameterValue: 'parameterValue',
        }],
      }],
    },
    retryOptions: {
      durationInSeconds: 123,
    },
    s3BackupMode: 's3BackupMode',
    typeName: 'typeName',
    vpcConfiguration: {
      roleArn: 'roleArn',
      securityGroupIds: ['securityGroupIds'],
      subnetIds: ['subnetIds'],
    },
  },
  extendedS3DestinationConfiguration: {
    bucketArn: 'bucketArn',
    roleArn: 'roleArn',

    // the properties below are optional
    bufferingHints: {
      intervalInSeconds: 123,
      sizeInMBs: 123,
    },
    cloudWatchLoggingOptions: {
      enabled: false,
      logGroupName: 'logGroupName',
      logStreamName: 'logStreamName',
    },
    compressionFormat: 'compressionFormat',
    dataFormatConversionConfiguration: {
      enabled: false,
      inputFormatConfiguration: {
        deserializer: {
          hiveJsonSerDe: {
            timestampFormats: ['timestampFormats'],
          },
          openXJsonSerDe: {
            caseInsensitive: false,
            columnToJsonKeyMappings: {
              columnToJsonKeyMappingsKey: 'columnToJsonKeyMappings',
            },
            convertDotsInJsonKeysToUnderscores: false,
          },
        },
      },
      outputFormatConfiguration: {
        serializer: {
          orcSerDe: {
            blockSizeBytes: 123,
            bloomFilterColumns: ['bloomFilterColumns'],
            bloomFilterFalsePositiveProbability: 123,
            compression: 'compression',
            dictionaryKeyThreshold: 123,
            enablePadding: false,
            formatVersion: 'formatVersion',
            paddingTolerance: 123,
            rowIndexStride: 123,
            stripeSizeBytes: 123,
          },
          parquetSerDe: {
            blockSizeBytes: 123,
            compression: 'compression',
            enableDictionaryCompression: false,
            maxPaddingBytes: 123,
            pageSizeBytes: 123,
            writerVersion: 'writerVersion',
          },
        },
      },
      schemaConfiguration: {
        catalogId: 'catalogId',
        databaseName: 'databaseName',
        region: 'region',
        roleArn: 'roleArn',
        tableName: 'tableName',
        versionId: 'versionId',
      },
    },
    dynamicPartitioningConfiguration: {
      enabled: false,
      retryOptions: {
        durationInSeconds: 123,
      },
    },
    encryptionConfiguration: {
      kmsEncryptionConfig: {
        awskmsKeyArn: 'awskmsKeyArn',
      },
      noEncryptionConfig: 'noEncryptionConfig',
    },
    errorOutputPrefix: 'errorOutputPrefix',
    prefix: 'prefix',
    processingConfiguration: {
      enabled: false,
      processors: [{
        type: 'type',

        // the properties below are optional
        parameters: [{
          parameterName: 'parameterName',
          parameterValue: 'parameterValue',
        }],
      }],
    },
    s3BackupConfiguration: {
      bucketArn: 'bucketArn',
      roleArn: 'roleArn',

      // the properties below are optional
      bufferingHints: {
        intervalInSeconds: 123,
        sizeInMBs: 123,
      },
      cloudWatchLoggingOptions: {
        enabled: false,
        logGroupName: 'logGroupName',
        logStreamName: 'logStreamName',
      },
      compressionFormat: 'compressionFormat',
      encryptionConfiguration: {
        kmsEncryptionConfig: {
          awskmsKeyArn: 'awskmsKeyArn',
        },
        noEncryptionConfig: 'noEncryptionConfig',
      },
      errorOutputPrefix: 'errorOutputPrefix',
      prefix: 'prefix',
    },
    s3BackupMode: 's3BackupMode',
  },
  httpEndpointDestinationConfiguration: {
    endpointConfiguration: {
      url: 'url',

      // the properties below are optional
      accessKey: 'accessKey',
      name: 'name',
    },
    s3Configuration: {
      bucketArn: 'bucketArn',
      roleArn: 'roleArn',

      // the properties below are optional
      bufferingHints: {
        intervalInSeconds: 123,
        sizeInMBs: 123,
      },
      cloudWatchLoggingOptions: {
        enabled: false,
        logGroupName: 'logGroupName',
        logStreamName: 'logStreamName',
      },
      compressionFormat: 'compressionFormat',
      encryptionConfiguration: {
        kmsEncryptionConfig: {
          awskmsKeyArn: 'awskmsKeyArn',
        },
        noEncryptionConfig: 'noEncryptionConfig',
      },
      errorOutputPrefix: 'errorOutputPrefix',
      prefix: 'prefix',
    },

    // the properties below are optional
    bufferingHints: {
      intervalInSeconds: 123,
      sizeInMBs: 123,
    },
    cloudWatchLoggingOptions: {
      enabled: false,
      logGroupName: 'logGroupName',
      logStreamName: 'logStreamName',
    },
    processingConfiguration: {
      enabled: false,
      processors: [{
        type: 'type',

        // the properties below are optional
        parameters: [{
          parameterName: 'parameterName',
          parameterValue: 'parameterValue',
        }],
      }],
    },
    requestConfiguration: {
      commonAttributes: [{
        attributeName: 'attributeName',
        attributeValue: 'attributeValue',
      }],
      contentEncoding: 'contentEncoding',
    },
    retryOptions: {
      durationInSeconds: 123,
    },
    roleArn: 'roleArn',
    s3BackupMode: 's3BackupMode',
  },
  kinesisStreamSourceConfiguration: {
    kinesisStreamArn: 'kinesisStreamArn',
    roleArn: 'roleArn',
  },
  redshiftDestinationConfiguration: {
    clusterJdbcurl: 'clusterJdbcurl',
    copyCommand: {
      dataTableName: 'dataTableName',

      // the properties below are optional
      copyOptions: 'copyOptions',
      dataTableColumns: 'dataTableColumns',
    },
    password: 'password',
    roleArn: 'roleArn',
    s3Configuration: {
      bucketArn: 'bucketArn',
      roleArn: 'roleArn',

      // the properties below are optional
      bufferingHints: {
        intervalInSeconds: 123,
        sizeInMBs: 123,
      },
      cloudWatchLoggingOptions: {
        enabled: false,
        logGroupName: 'logGroupName',
        logStreamName: 'logStreamName',
      },
      compressionFormat: 'compressionFormat',
      encryptionConfiguration: {
        kmsEncryptionConfig: {
          awskmsKeyArn: 'awskmsKeyArn',
        },
        noEncryptionConfig: 'noEncryptionConfig',
      },
      errorOutputPrefix: 'errorOutputPrefix',
      prefix: 'prefix',
    },
    username: 'username',

    // the properties below are optional
    cloudWatchLoggingOptions: {
      enabled: false,
      logGroupName: 'logGroupName',
      logStreamName: 'logStreamName',
    },
    processingConfiguration: {
      enabled: false,
      processors: [{
        type: 'type',

        // the properties below are optional
        parameters: [{
          parameterName: 'parameterName',
          parameterValue: 'parameterValue',
        }],
      }],
    },
    retryOptions: {
      durationInSeconds: 123,
    },
    s3BackupConfiguration: {
      bucketArn: 'bucketArn',
      roleArn: 'roleArn',

      // the properties below are optional
      bufferingHints: {
        intervalInSeconds: 123,
        sizeInMBs: 123,
      },
      cloudWatchLoggingOptions: {
        enabled: false,
        logGroupName: 'logGroupName',
        logStreamName: 'logStreamName',
      },
      compressionFormat: 'compressionFormat',
      encryptionConfiguration: {
        kmsEncryptionConfig: {
          awskmsKeyArn: 'awskmsKeyArn',
        },
        noEncryptionConfig: 'noEncryptionConfig',
      },
      errorOutputPrefix: 'errorOutputPrefix',
      prefix: 'prefix',
    },
    s3BackupMode: 's3BackupMode',
  },
  s3DestinationConfiguration: {
    bucketArn: 'bucketArn',
    roleArn: 'roleArn',

    // the properties below are optional
    bufferingHints: {
      intervalInSeconds: 123,
      sizeInMBs: 123,
    },
    cloudWatchLoggingOptions: {
      enabled: false,
      logGroupName: 'logGroupName',
      logStreamName: 'logStreamName',
    },
    compressionFormat: 'compressionFormat',
    encryptionConfiguration: {
      kmsEncryptionConfig: {
        awskmsKeyArn: 'awskmsKeyArn',
      },
      noEncryptionConfig: 'noEncryptionConfig',
    },
    errorOutputPrefix: 'errorOutputPrefix',
    prefix: 'prefix',
  },
  splunkDestinationConfiguration: {
    hecEndpoint: 'hecEndpoint',
    hecEndpointType: 'hecEndpointType',
    hecToken: 'hecToken',
    s3Configuration: {
      bucketArn: 'bucketArn',
      roleArn: 'roleArn',

      // the properties below are optional
      bufferingHints: {
        intervalInSeconds: 123,
        sizeInMBs: 123,
      },
      cloudWatchLoggingOptions: {
        enabled: false,
        logGroupName: 'logGroupName',
        logStreamName: 'logStreamName',
      },
      compressionFormat: 'compressionFormat',
      encryptionConfiguration: {
        kmsEncryptionConfig: {
          awskmsKeyArn: 'awskmsKeyArn',
        },
        noEncryptionConfig: 'noEncryptionConfig',
      },
      errorOutputPrefix: 'errorOutputPrefix',
      prefix: 'prefix',
    },

    // the properties below are optional
    cloudWatchLoggingOptions: {
      enabled: false,
      logGroupName: 'logGroupName',
      logStreamName: 'logStreamName',
    },
    hecAcknowledgmentTimeoutInSeconds: 123,
    processingConfiguration: {
      enabled: false,
      processors: [{
        type: 'type',

        // the properties below are optional
        parameters: [{
          parameterName: 'parameterName',
          parameterValue: 'parameterValue',
        }],
      }],
    },
    retryOptions: {
      durationInSeconds: 123,
    },
    s3BackupMode: 's3BackupMode',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
amazonOpenSearchServerlessDestinationConfiguration?	`AmazonOpenSearchServerlessDestinationConfigurationProperty` `\|` `IResolvable`	`AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration`.
amazonopensearchserviceDestinationConfiguration?	`IResolvable` `\|` `AmazonopensearchserviceDestinationConfigurationProperty`	The destination in Amazon OpenSearch Service.
deliveryStreamEncryptionConfigurationInput?	`IResolvable` `\|` `DeliveryStreamEncryptionConfigurationInputProperty`	Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
deliveryStreamName?	`string`	The name of the delivery stream.
deliveryStreamType?	`string`	The delivery stream type. This can be one of the following values:.
elasticsearchDestinationConfiguration?	`IResolvable` `\|` `ElasticsearchDestinationConfigurationProperty`	An Amazon ES destination for the delivery stream.
extendedS3DestinationConfiguration?	`ExtendedS3DestinationConfigurationProperty` `\|` `IResolvable`	An Amazon S3 destination for the delivery stream.
httpEndpointDestinationConfiguration?	`IResolvable` `\|` `HttpEndpointDestinationConfigurationProperty`	Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
kinesisStreamSourceConfiguration?	`IResolvable` `\|` `KinesisStreamSourceConfigurationProperty`	When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.
redshiftDestinationConfiguration?	`IResolvable` `\|` `RedshiftDestinationConfigurationProperty`	An Amazon Redshift destination for the delivery stream.
s3DestinationConfiguration?	`IResolvable` `\|` `S3DestinationConfigurationProperty`	The `S3DestinationConfiguration` property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
splunkDestinationConfiguration?	`IResolvable` `\|` `SplunkDestinationConfigurationProperty`	The configuration of a destination in Splunk for the delivery stream.
tags?	`CfnTag[]`	A set of tags to assign to the delivery stream.

amazonOpenSearchServerlessDestinationConfiguration?

Type: AmazonOpenSearchServerlessDestinationConfigurationProperty | IResolvable (optional)

AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration.

amazonopensearchserviceDestinationConfiguration?

Type: IResolvable | AmazonopensearchserviceDestinationConfigurationProperty (optional)

The destination in Amazon OpenSearch Service.

You can specify only one destination.

deliveryStreamEncryptionConfigurationInput?

Type: IResolvable | DeliveryStreamEncryptionConfigurationInputProperty (optional)

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

deliveryStreamName?

Type: string (optional)

The name of the delivery stream.

deliveryStreamType?

Type: string (optional)

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

DirectPut : Provider applications access the delivery stream directly.
KinesisStreamAsSource : The delivery stream uses a Kinesis data stream as a source.

elasticsearchDestinationConfiguration?

Type: IResolvable | ElasticsearchDestinationConfigurationProperty (optional)

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 .

extendedS3DestinationConfiguration?

Type: ExtendedS3DestinationConfigurationProperty | IResolvable (optional)

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 .

httpEndpointDestinationConfiguration?

Type: IResolvable | HttpEndpointDestinationConfigurationProperty (optional)

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.

You can specify only one destination.

kinesisStreamSourceConfiguration?

Type: IResolvable | KinesisStreamSourceConfigurationProperty (optional)

When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.

redshiftDestinationConfiguration?

Type: IResolvable | RedshiftDestinationConfigurationProperty (optional)

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 .

s3DestinationConfiguration?

Type: IResolvable | S3DestinationConfigurationProperty (optional)

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 .

splunkDestinationConfiguration?

Type: IResolvable | SplunkDestinationConfigurationProperty (optional)

The configuration of a destination in Splunk for the delivery stream.

tags?

Type: CfnTag[] (optional)

A set of tags to assign to the delivery 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 delivery stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

You can specify up to 50 tags when creating a delivery stream.