@aws-cdk_aws-kinesisfirehose-destinations-alpha.CommonDestinationProps

interface CommonDestinationProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.KinesisFirehose.Destinations.Alpha.CommonDestinationProps
Gogithub.com/aws/aws-cdk-go/awscdkkinesisfirehosedestinationsalpha/v2#CommonDestinationProps
Javasoftware.amazon.awscdk.services.kinesisfirehose.destinations.alpha.CommonDestinationProps
Pythonaws_cdk.aws_kinesisfirehose_destinations_alpha.CommonDestinationProps
TypeScript (source)@aws-cdk/aws-kinesisfirehose-destinations-alpha ยป CommonDestinationProps

Generic properties for defining a delivery stream destination.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as kinesisfirehose_alpha from '@aws-cdk/aws-kinesisfirehose-alpha';
import * as kinesisfirehose_destinations_alpha from '@aws-cdk/aws-kinesisfirehose-destinations-alpha';
import * as cdk from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_kms as kms } from 'aws-cdk-lib';
import { aws_logs as logs } from 'aws-cdk-lib';
import { aws_s3 as s3 } from 'aws-cdk-lib';

declare const bucket: s3.Bucket;
declare const compression: kinesisfirehose_destinations_alpha.Compression;
declare const dataProcessor: kinesisfirehose_alpha.IDataProcessor;
declare const key: kms.Key;
declare const logGroup: logs.LogGroup;
declare const role: iam.Role;
declare const size: cdk.Size;
const commonDestinationProps: kinesisfirehose_destinations_alpha.CommonDestinationProps = {
  logging: false,
  logGroup: logGroup,
  processor: dataProcessor,
  role: role,
  s3Backup: {
    bucket: bucket,
    bufferingInterval: cdk.Duration.minutes(30),
    bufferingSize: size,
    compression: compression,
    dataOutputPrefix: 'dataOutputPrefix',
    encryptionKey: key,
    errorOutputPrefix: 'errorOutputPrefix',
    logging: false,
    logGroup: logGroup,
    mode: kinesisfirehose_destinations_alpha.BackupMode.ALL,
  },
};

Properties

NameTypeDescription
logGroup?๐Ÿ”นILogGroupThe CloudWatch log group where log streams will be created to hold error logs.
logging?๐Ÿ”นbooleanIf true, log errors when data transformation or data delivery fails.
processor?๐Ÿ”นIDataProcessorThe data transformation that should be performed on the data before writing to the destination.
role?๐Ÿ”นIRoleThe IAM role associated with this destination.
s3Backup?๐Ÿ”นDestinationS3BackupPropsThe configuration for backing up source records to S3.

logGroup?๐Ÿ”น

Type: ILogGroup (optional, default: if logging is set to true, a log group will be created for you.)

The CloudWatch log group where log streams will be created to hold error logs.


logging?๐Ÿ”น

Type: boolean (optional, default: true - errors are logged.)

If true, log errors when data transformation or data delivery fails.

If logGroup is provided, this will be implicitly set to true.


processor?๐Ÿ”น

Type: IDataProcessor (optional, default: no data transformation will occur.)

The data transformation that should be performed on the data before writing to the destination.


role?๐Ÿ”น

Type: IRole (optional, default: a role will be created with default permissions.)

The IAM role associated with this destination.

Assumed by Kinesis Data Firehose to invoke processors and write to destinations


s3Backup?๐Ÿ”น

Type: DestinationS3BackupProps (optional, default: source records will not be backed up to S3.)

The configuration for backing up source records to S3.