1.204.0

class CfnDeliveryStream (construct)

LanguageType name
.NETAmazon.CDK.AWS.KinesisFirehose.CfnDeliveryStream
Javasoftware.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream
Pythonaws_cdk.aws_kinesisfirehose.CfnDeliveryStream
TypeScript @aws-cdk/aws-kinesisfirehose » CfnDeliveryStream

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::KinesisFirehose::DeliveryStream.

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 in the Amazon Kinesis Data Firehose Developer Guide .

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 cfnDeliveryStream = new kinesisfirehose.CfnDeliveryStream(this, 'MyCfnDeliveryStream', /* all optional props */ {
  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',
  }],
});

Initializer

new CfnDeliveryStream(scope: Construct, id: string, props?: CfnDeliveryStreamProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnDeliveryStreamProps — - resource properties.

Create a new AWS::KinesisFirehose::DeliveryStream.

Construct Props

NameTypeDescription
amazonOpenSearchServerlessDestinationConfiguration?AmazonOpenSearchServerlessDestinationConfigurationProperty | IResolvableAWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration.
amazonopensearchserviceDestinationConfiguration?IResolvable | AmazonopensearchserviceDestinationConfigurationPropertyThe destination in Amazon OpenSearch Service.
deliveryStreamEncryptionConfigurationInput?IResolvable | DeliveryStreamEncryptionConfigurationInputPropertySpecifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
deliveryStreamName?stringThe name of the delivery stream.
deliveryStreamType?stringThe delivery stream type. This can be one of the following values:.
elasticsearchDestinationConfiguration?IResolvable | ElasticsearchDestinationConfigurationPropertyAn Amazon ES destination for the delivery stream.
extendedS3DestinationConfiguration?ExtendedS3DestinationConfigurationProperty | IResolvableAn Amazon S3 destination for the delivery stream.
httpEndpointDestinationConfiguration?IResolvable | HttpEndpointDestinationConfigurationPropertyEnables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
kinesisStreamSourceConfiguration?IResolvable | KinesisStreamSourceConfigurationPropertyWhen 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 | RedshiftDestinationConfigurationPropertyAn Amazon Redshift destination for the delivery stream.
s3DestinationConfiguration?IResolvable | S3DestinationConfigurationPropertyThe 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 | SplunkDestinationConfigurationPropertyThe 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.

Properties

NameTypeDescription
attrArnstringThe Amazon Resource Name (ARN) of the delivery stream, such as arn:aws:firehose:us-east-2:123456789012:deliverystream/delivery-stream-name .
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeConstructNodeThe construct tree node associated with this construct.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
tagsTagManagerA set of tags to assign to the delivery stream.
amazonOpenSearchServerlessDestinationConfiguration?AmazonOpenSearchServerlessDestinationConfigurationProperty | IResolvableAWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration.
amazonopensearchserviceDestinationConfiguration?IResolvable | AmazonopensearchserviceDestinationConfigurationPropertyThe destination in Amazon OpenSearch Service.
deliveryStreamEncryptionConfigurationInput?IResolvable | DeliveryStreamEncryptionConfigurationInputPropertySpecifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
deliveryStreamName?stringThe name of the delivery stream.
deliveryStreamType?stringThe delivery stream type. This can be one of the following values:.
elasticsearchDestinationConfiguration?IResolvable | ElasticsearchDestinationConfigurationPropertyAn Amazon ES destination for the delivery stream.
extendedS3DestinationConfiguration?ExtendedS3DestinationConfigurationProperty | IResolvableAn Amazon S3 destination for the delivery stream.
httpEndpointDestinationConfiguration?IResolvable | HttpEndpointDestinationConfigurationPropertyEnables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
kinesisStreamSourceConfiguration?IResolvable | KinesisStreamSourceConfigurationPropertyWhen 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 | RedshiftDestinationConfigurationPropertyAn Amazon Redshift destination for the delivery stream.
s3DestinationConfiguration?IResolvable | S3DestinationConfigurationPropertyThe 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 | SplunkDestinationConfigurationPropertyThe configuration of a destination in Splunk for the delivery stream.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrArn

Type: string

The Amazon Resource Name (ARN) of the delivery stream, such as arn:aws:firehose:us-east-2:123456789012:deliverystream/delivery-stream-name .

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Type: TagManager

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.

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.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

  • attributeName string — The name of the attribute.

Returns

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }
← PreviousNext →