This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-kinesisfirehose

The CDK Construct Library for AWS Kinesis Firehose

This module is part of the AWS Cloud Development Kit project.

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.KinesisFirehose" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.KinesisFirehose --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.KinesisFirehose" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:kinesisfirehose:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="kinesisfirehose" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>kinesisfirehose</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:kinesisfirehose:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='kinesisfirehose', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-kinesisfirehose@0.25.3

package.json:

{
  "@aws-cdk/aws-kinesisfirehose": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-kinesisfirehose@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-kinesisfirehose@0.25.3

package.json:

{
  "@aws-cdk/aws-kinesisfirehose": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-kinesisfirehose@0.25.3

CfnDeliveryStream

class @aws-cdk/aws-kinesisfirehose.CfnDeliveryStream(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream;
const { CfnDeliveryStream } = require('@aws-cdk/aws-kinesisfirehose');
import { CfnDeliveryStream } from '@aws-cdk/aws-kinesisfirehose';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
deliveryStreamArn
Type:string (readonly)
deliveryStreamName
Type:string (readonly)
propertyOverrides
Type:CfnDeliveryStreamProps (readonly)
class BufferingHintsProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.BufferingHintsProperty;
// CfnDeliveryStream.BufferingHintsProperty is an interface
import { CfnDeliveryStream.BufferingHintsProperty } from '@aws-cdk/aws-kinesisfirehose';
intervalInSeconds

CfnDeliveryStream.BufferingHintsProperty.IntervalInSeconds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-bufferinghints.html#cfn-kinesisfirehose-deliverystream-bufferinghints-intervalinseconds

Type:number or @aws-cdk/cdk.Token
sizeInMBs

CfnDeliveryStream.BufferingHintsProperty.SizeInMBs

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-bufferinghints.html#cfn-kinesisfirehose-deliverystream-bufferinghints-sizeinmbs

Type:number or @aws-cdk/cdk.Token
class CloudWatchLoggingOptionsProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.CloudWatchLoggingOptionsProperty;
// CfnDeliveryStream.CloudWatchLoggingOptionsProperty is an interface
import { CfnDeliveryStream.CloudWatchLoggingOptionsProperty } from '@aws-cdk/aws-kinesisfirehose';
enabled

CfnDeliveryStream.CloudWatchLoggingOptionsProperty.Enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-enabled

Type:boolean or @aws-cdk/cdk.Token (optional)
logGroupName

CfnDeliveryStream.CloudWatchLoggingOptionsProperty.LogGroupName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-loggroupname

Type:string (optional)
logStreamName

CfnDeliveryStream.CloudWatchLoggingOptionsProperty.LogStreamName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-logstreamname

Type:string (optional)
class CopyCommandProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.CopyCommandProperty;
// CfnDeliveryStream.CopyCommandProperty is an interface
import { CfnDeliveryStream.CopyCommandProperty } from '@aws-cdk/aws-kinesisfirehose';
dataTableName

CfnDeliveryStream.CopyCommandProperty.DataTableName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-datatablename

Type:string
copyOptions

CfnDeliveryStream.CopyCommandProperty.CopyOptions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-copyoptions

Type:string (optional)
dataTableColumns

CfnDeliveryStream.CopyCommandProperty.DataTableColumns

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-datatablecolumns

Type:string (optional)
class ElasticsearchBufferingHintsProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.ElasticsearchBufferingHintsProperty;
// CfnDeliveryStream.ElasticsearchBufferingHintsProperty is an interface
import { CfnDeliveryStream.ElasticsearchBufferingHintsProperty } from '@aws-cdk/aws-kinesisfirehose';
intervalInSeconds

CfnDeliveryStream.ElasticsearchBufferingHintsProperty.IntervalInSeconds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-intervalinseconds

Type:number or @aws-cdk/cdk.Token
sizeInMBs

CfnDeliveryStream.ElasticsearchBufferingHintsProperty.SizeInMBs

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-sizeinmbs

Type:number or @aws-cdk/cdk.Token
class ElasticsearchDestinationConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty;
// CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty is an interface
import { CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty } from '@aws-cdk/aws-kinesisfirehose';
bufferingHints

CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.BufferingHints

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-bufferinghints

Type:@aws-cdk/cdk.Token or ElasticsearchBufferingHintsProperty
domainArn

CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.DomainARN

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-domainarn

Type:string
indexName

CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.IndexName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexname

Type:string
indexRotationPeriod

CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.IndexRotationPeriod

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexrotationperiod

Type:string
retryOptions

CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.RetryOptions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-retryoptions

Type:@aws-cdk/cdk.Token or ElasticsearchRetryOptionsProperty
roleArn

CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.RoleARN

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-rolearn

Type:string
s3BackupMode

CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.S3BackupMode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3backupmode

Type:string
s3Configuration

CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.S3Configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3configuration

Type:@aws-cdk/cdk.Token or S3DestinationConfigurationProperty
typeName

CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.TypeName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-typename

Type:string
cloudWatchLoggingOptions

CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.CloudWatchLoggingOptions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-cloudwatchloggingoptions

Type:@aws-cdk/cdk.Token or CloudWatchLoggingOptionsProperty (optional)
processingConfiguration

CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.ProcessingConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-processingconfiguration

Type:@aws-cdk/cdk.Token or ProcessingConfigurationProperty (optional)
class ElasticsearchRetryOptionsProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.ElasticsearchRetryOptionsProperty;
// CfnDeliveryStream.ElasticsearchRetryOptionsProperty is an interface
import { CfnDeliveryStream.ElasticsearchRetryOptionsProperty } from '@aws-cdk/aws-kinesisfirehose';
durationInSeconds

CfnDeliveryStream.ElasticsearchRetryOptionsProperty.DurationInSeconds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions.html#cfn-kinesisfirehose-deliverystream-elasticsearchretryoptions-durationinseconds

Type:number or @aws-cdk/cdk.Token
class EncryptionConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.EncryptionConfigurationProperty;
// CfnDeliveryStream.EncryptionConfigurationProperty is an interface
import { CfnDeliveryStream.EncryptionConfigurationProperty } from '@aws-cdk/aws-kinesisfirehose';
kmsEncryptionConfig

CfnDeliveryStream.EncryptionConfigurationProperty.KMSEncryptionConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration.html#cfn-kinesisfirehose-deliverystream-encryptionconfiguration-kmsencryptionconfig

Type:@aws-cdk/cdk.Token or KMSEncryptionConfigProperty (optional)
noEncryptionConfig

CfnDeliveryStream.EncryptionConfigurationProperty.NoEncryptionConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration.html#cfn-kinesisfirehose-deliverystream-encryptionconfiguration-noencryptionconfig

Type:string (optional)
class ExtendedS3DestinationConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty;
// CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty is an interface
import { CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty } from '@aws-cdk/aws-kinesisfirehose';
bucketArn

CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty.BucketARN

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bucketarn

Type:string
bufferingHints

CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty.BufferingHints

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bufferinghints

Type:@aws-cdk/cdk.Token or BufferingHintsProperty
compressionFormat

CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty.CompressionFormat

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-compressionformat

Type:string
prefix

CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty.Prefix

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-prefix

Type:string
roleArn

CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty.RoleARN

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-rolearn

Type:string
cloudWatchLoggingOptions

CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty.CloudWatchLoggingOptions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-cloudwatchloggingoptions

Type:@aws-cdk/cdk.Token or CloudWatchLoggingOptionsProperty (optional)
encryptionConfiguration

CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty.EncryptionConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-encryptionconfiguration

Type:@aws-cdk/cdk.Token or EncryptionConfigurationProperty (optional)
processingConfiguration

CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty.ProcessingConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-processingconfiguration

Type:@aws-cdk/cdk.Token or ProcessingConfigurationProperty (optional)
s3BackupConfiguration

CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty.S3BackupConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupconfiguration

Type:@aws-cdk/cdk.Token or S3DestinationConfigurationProperty (optional)
s3BackupMode

CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty.S3BackupMode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupmode

Type:string (optional)
class KMSEncryptionConfigProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.KMSEncryptionConfigProperty;
// CfnDeliveryStream.KMSEncryptionConfigProperty is an interface
import { CfnDeliveryStream.KMSEncryptionConfigProperty } from '@aws-cdk/aws-kinesisfirehose';
awskmsKeyArn

CfnDeliveryStream.KMSEncryptionConfigProperty.AWSKMSKeyARN

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig.html#cfn-kinesisfirehose-deliverystream-kmsencryptionconfig-awskmskeyarn

Type:string
class KinesisStreamSourceConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.KinesisStreamSourceConfigurationProperty;
// CfnDeliveryStream.KinesisStreamSourceConfigurationProperty is an interface
import { CfnDeliveryStream.KinesisStreamSourceConfigurationProperty } from '@aws-cdk/aws-kinesisfirehose';
kinesisStreamArn

CfnDeliveryStream.KinesisStreamSourceConfigurationProperty.KinesisStreamARN

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-kinesisstreamarn

Type:string
roleArn

CfnDeliveryStream.KinesisStreamSourceConfigurationProperty.RoleARN

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-rolearn

Type:string
class ProcessingConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.ProcessingConfigurationProperty;
// CfnDeliveryStream.ProcessingConfigurationProperty is an interface
import { CfnDeliveryStream.ProcessingConfigurationProperty } from '@aws-cdk/aws-kinesisfirehose';
enabled

CfnDeliveryStream.ProcessingConfigurationProperty.Enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html#cfn-kinesisfirehose-deliverystream-processingconfiguration-enabled

Type:boolean or @aws-cdk/cdk.Token (optional)
processors

CfnDeliveryStream.ProcessingConfigurationProperty.Processors

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html#cfn-kinesisfirehose-deliverystream-processingconfiguration-processors

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ProcessorProperty)[] (optional)
class ProcessorParameterProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.ProcessorParameterProperty;
// CfnDeliveryStream.ProcessorParameterProperty is an interface
import { CfnDeliveryStream.ProcessorParameterProperty } from '@aws-cdk/aws-kinesisfirehose';
parameterName

CfnDeliveryStream.ProcessorParameterProperty.ParameterName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processorparameter.html#cfn-kinesisfirehose-deliverystream-processorparameter-parametername

Type:string
parameterValue

CfnDeliveryStream.ProcessorParameterProperty.ParameterValue

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processorparameter.html#cfn-kinesisfirehose-deliverystream-processorparameter-parametervalue

Type:string
class ProcessorProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.ProcessorProperty;
// CfnDeliveryStream.ProcessorProperty is an interface
import { CfnDeliveryStream.ProcessorProperty } from '@aws-cdk/aws-kinesisfirehose';
parameters

CfnDeliveryStream.ProcessorProperty.Parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html#cfn-kinesisfirehose-deliverystream-processor-parameters

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ProcessorParameterProperty)[]
type

CfnDeliveryStream.ProcessorProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html#cfn-kinesisfirehose-deliverystream-processor-type

Type:string
class RedshiftDestinationConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.RedshiftDestinationConfigurationProperty;
// CfnDeliveryStream.RedshiftDestinationConfigurationProperty is an interface
import { CfnDeliveryStream.RedshiftDestinationConfigurationProperty } from '@aws-cdk/aws-kinesisfirehose';
clusterJdbcurl

CfnDeliveryStream.RedshiftDestinationConfigurationProperty.ClusterJDBCURL

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-clusterjdbcurl

Type:string
copyCommand

CfnDeliveryStream.RedshiftDestinationConfigurationProperty.CopyCommand

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-copycommand

Type:@aws-cdk/cdk.Token or CopyCommandProperty
password

CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Password

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-password

Type:string
roleArn

CfnDeliveryStream.RedshiftDestinationConfigurationProperty.RoleARN

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-rolearn

Type:string
s3Configuration

CfnDeliveryStream.RedshiftDestinationConfigurationProperty.S3Configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3configuration

Type:@aws-cdk/cdk.Token or S3DestinationConfigurationProperty
username

CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Username

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-username

Type:string
cloudWatchLoggingOptions

CfnDeliveryStream.RedshiftDestinationConfigurationProperty.CloudWatchLoggingOptions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-cloudwatchloggingoptions

Type:@aws-cdk/cdk.Token or CloudWatchLoggingOptionsProperty (optional)
processingConfiguration

CfnDeliveryStream.RedshiftDestinationConfigurationProperty.ProcessingConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-processingconfiguration

Type:@aws-cdk/cdk.Token or ProcessingConfigurationProperty (optional)
class S3DestinationConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.S3DestinationConfigurationProperty;
// CfnDeliveryStream.S3DestinationConfigurationProperty is an interface
import { CfnDeliveryStream.S3DestinationConfigurationProperty } from '@aws-cdk/aws-kinesisfirehose';
bucketArn

CfnDeliveryStream.S3DestinationConfigurationProperty.BucketARN

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bucketarn

Type:string
bufferingHints

CfnDeliveryStream.S3DestinationConfigurationProperty.BufferingHints

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bufferinghints

Type:@aws-cdk/cdk.Token or BufferingHintsProperty
compressionFormat

CfnDeliveryStream.S3DestinationConfigurationProperty.CompressionFormat

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-compressionformat

Type:string
roleArn

CfnDeliveryStream.S3DestinationConfigurationProperty.RoleARN

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-rolearn

Type:string
cloudWatchLoggingOptions

CfnDeliveryStream.S3DestinationConfigurationProperty.CloudWatchLoggingOptions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-cloudwatchloggingoptions

Type:@aws-cdk/cdk.Token or CloudWatchLoggingOptionsProperty (optional)
encryptionConfiguration

CfnDeliveryStream.S3DestinationConfigurationProperty.EncryptionConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-encryptionconfiguration

Type:@aws-cdk/cdk.Token or EncryptionConfigurationProperty (optional)
prefix

CfnDeliveryStream.S3DestinationConfigurationProperty.Prefix

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-prefix

Type:string (optional)
class SplunkDestinationConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.SplunkDestinationConfigurationProperty;
// CfnDeliveryStream.SplunkDestinationConfigurationProperty is an interface
import { CfnDeliveryStream.SplunkDestinationConfigurationProperty } from '@aws-cdk/aws-kinesisfirehose';
hecEndpoint

CfnDeliveryStream.SplunkDestinationConfigurationProperty.HECEndpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpoint

Type:string
hecEndpointType

CfnDeliveryStream.SplunkDestinationConfigurationProperty.HECEndpointType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpointtype

Type:string
hecToken

CfnDeliveryStream.SplunkDestinationConfigurationProperty.HECToken

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hectoken

Type:string
s3Configuration

CfnDeliveryStream.SplunkDestinationConfigurationProperty.S3Configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3configuration

Type:@aws-cdk/cdk.Token or S3DestinationConfigurationProperty
cloudWatchLoggingOptions

CfnDeliveryStream.SplunkDestinationConfigurationProperty.CloudWatchLoggingOptions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-cloudwatchloggingoptions

Type:@aws-cdk/cdk.Token or CloudWatchLoggingOptionsProperty (optional)
hecAcknowledgmentTimeoutInSeconds

CfnDeliveryStream.SplunkDestinationConfigurationProperty.HECAcknowledgmentTimeoutInSeconds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecacknowledgmenttimeoutinseconds

Type:number or @aws-cdk/cdk.Token (optional)
processingConfiguration

CfnDeliveryStream.SplunkDestinationConfigurationProperty.ProcessingConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-processingconfiguration

Type:@aws-cdk/cdk.Token or ProcessingConfigurationProperty (optional)
retryOptions

CfnDeliveryStream.SplunkDestinationConfigurationProperty.RetryOptions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-retryoptions

Type:@aws-cdk/cdk.Token or SplunkRetryOptionsProperty (optional)
s3BackupMode

CfnDeliveryStream.SplunkDestinationConfigurationProperty.S3BackupMode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3backupmode

Type:string (optional)
class SplunkRetryOptionsProperty

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.SplunkRetryOptionsProperty;
// CfnDeliveryStream.SplunkRetryOptionsProperty is an interface
import { CfnDeliveryStream.SplunkRetryOptionsProperty } from '@aws-cdk/aws-kinesisfirehose';
durationInSeconds

CfnDeliveryStream.SplunkRetryOptionsProperty.DurationInSeconds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkretryoptions.html#cfn-kinesisfirehose-deliverystream-splunkretryoptions-durationinseconds

Type:number or @aws-cdk/cdk.Token
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

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).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

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

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

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.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

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

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

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

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

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).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDeliveryStreamProps (interface)

class @aws-cdk/aws-kinesisfirehose.CfnDeliveryStreamProps

Language-specific names:

using Amazon.CDK.AWS.KinesisFirehose;
import software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStreamProps;
// CfnDeliveryStreamProps is an interface
import { CfnDeliveryStreamProps } from '@aws-cdk/aws-kinesisfirehose';
deliveryStreamName

AWS::KinesisFirehose::DeliveryStream.DeliveryStreamName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamname

Type:string (optional)
deliveryStreamType

AWS::KinesisFirehose::DeliveryStream.DeliveryStreamType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamtype

Type:string (optional)
elasticsearchDestinationConfiguration

AWS::KinesisFirehose::DeliveryStream.ElasticsearchDestinationConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration

Type:ElasticsearchDestinationConfigurationProperty or @aws-cdk/cdk.Token (optional)
extendedS3DestinationConfiguration

AWS::KinesisFirehose::DeliveryStream.ExtendedS3DestinationConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration

Type:@aws-cdk/cdk.Token or ExtendedS3DestinationConfigurationProperty (optional)
kinesisStreamSourceConfiguration

AWS::KinesisFirehose::DeliveryStream.KinesisStreamSourceConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration

Type:@aws-cdk/cdk.Token or KinesisStreamSourceConfigurationProperty (optional)
redshiftDestinationConfiguration

AWS::KinesisFirehose::DeliveryStream.RedshiftDestinationConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration

Type:@aws-cdk/cdk.Token or RedshiftDestinationConfigurationProperty (optional)
s3DestinationConfiguration

AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration

Type:@aws-cdk/cdk.Token or S3DestinationConfigurationProperty (optional)
splunkDestinationConfiguration

AWS::KinesisFirehose::DeliveryStream.SplunkDestinationConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration

Type:@aws-cdk/cdk.Token or SplunkDestinationConfigurationProperty (optional)